To see a response payload, the session related to the sessionId needs to have one of 9000-code statuses. If the request itself was successful (you see "200" code) but there is no decision yet, the response status is success, but verification is null.
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Session id signed with the shared secret key
Session id
Decision of the session
API request success
Verification request decision object. null if decision is not available yet
UUID v4 which identifies the verification session
UUID v4 of the attempt which received a status (as shown in verification.status field)
Timestamp of the session generation
Timestamp of the decision.
Verification response code, one of 9001, 9102, 9103, 9104, 9121
The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null if not provided
The UUID that you created for your end-user, that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null if not provided.
Status of the verification session
Reason of failed verification
Reason code of failed verification
Person's first name
Person's last name
National identification number
Person's gender
Always returns null
Person's date of birth
Person's year of birth
Person's place of birth
Person's nationality, as ISO country code
Address data from the document as array of strings
Address as single string
Object with parsed fullAddress. Optional, depending on integration
Any human settlement, including cities, towns, villages, hamlets, localities, etc.
Boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV"
Sovereign nations and their dependent territories, anything with an ISO-3166 code
Informal subdivision of a country without any political status
Numbered/lettered entrance
Name of the venue or the building
External (street-facing) building number
Named islands e.g., "Maui"
Expressions indicating a floor number e.g., "3rd Floor", "Ground Floor", etc.
Phrases like "in", "near", etc. used after a category phrase to help with parsing queries like "restaurants in Brooklyn"
Name of the street(s)
Post office box: typically found in non-physical (mail-only) addresses
Postal codes used for mail sorting
Numbered/lettered staircase
A first-level administrative division. For example, Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well (convention used in OSM, GeoPlanet, etc.)
Usually a second-level administrative division or county
Usually an unofficial neighbourhood name like "Harlem", "South Bronx", or "Crown Heights"
An apartment, unit, office, lot, or other secondary unit designator
Currently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean e.g. “Jamaica, West Indies”
Full name of the person. Optional, available only for Indian Aadhaar cards registry based verification
Legacy field, may return incorrect results, should be ignored
INE identification number. When this is returned, the ifeIdentifier is not present
IFE identification number. When this is returned, the ineIdentifier is not present
Occupation data from the document
Employer's name from the document
Foreigner status field from the document
Additional name from the document
Document number, [a-zA-Z0-9] characters only
Document type
Document country, as ISO country code
Data extracted from the document's remarks field
Document issuing state, as ISO 3166 alpha-2 or alpha-3 code. null when the state data isnot present on the document
Date from when the document is valid
Date until when the document is valid
Contains additional data about the particular document type. Optional, depending on integration.
Indicates if the document contains a contactless chip (NFC)
Indicates the first issue date of the identity document template
Indicates the last issue date of the identity document template
Indicates the version of the US National Institute of Standards and Technology guidelines
Indicates if the document is a digital template identity document
Indicates if the driving permit is different from the standard driver's licence (e.g. it is a learner's license, temporary driver's license, permit to drive boats)
Indicates if the document is issued to a military personnel/staff or personnel's family
Indicates if the document is a temporary identity document
Indicates if it is a document that is issued exclusively to asylum seekers or refugees
Indicates if the document is under the standards of International Civil Aviation Organization
Indicates if the identity card is not a national ID card (e.g., it is a social security card, tax ID, electoral ID)
Indicates the legal status of the identity document in the country of issuance. One of primary, secondary, tertiary, indicating to what extent the document is accepted as legal proof of identity
Indicates if the document has properties that can increase the chance of document tampering
Place where document was issued. Optional, depending on integration
Date of document first issue. Optional, depending on integration
Document issue number. Optional, depending on integration
Document issuing authority. Optional, depending on integration
Biometric document data has been successfully decoded. Optional, depending on integration
Type of the residence permit type from the document. Optional, depending on integration
Indicates that the portrait image is visible in the session and its quality is sufficient to perform verification. Optional, depending on the integration
Indicates that the signature is present on the document and readable to perform the verification. Optional, depending on the integration
Data which has been optionally verified for session
Indicates whether the driver's license has the appropriate category.Optional, depending on integration
Date when the driving license category was obtained. Optional, depending on integration
Driving license category expiry date.Optional, depending on integration
Number of the driver's license.Optional, depending on integration
An integer representing the estimated age. Optional, depending on integration
A float representing the estimated gender. Values closer to 0.0 indicate 'male', values closer to 1.0 indicate 'female'. Optional, depending on integration
Process number (e.g., "Trámite №") from the document
Brazilian individual taxpayer registry (CPF) validation check object. Optional, depending on integration
Status of the entry in the registry. One of CPF is validated, CPF is suspended, CPF holder is deceased, CPF is pending regularization, CPF is cancelled (was a duplicate), Cancelled craft (meaning that it was cancelled due to reasons other than being a duplicate))
Brazilian individual taxpayer registry (CPF) number of the person
Person's name in the CPF
Person's date of birth in the CPF
Person's date of death in the CPF
INE Biometric Database Verification check object. Optional, available only when the INE Biometric Validation check has been enabled for the integration
Indicates if the person's selfie image is a match with their image in the registry. This decision is made based on the value returned in faceMatchPercentage (see below). null if the check could not be completed
Indicates the level of similarity the system thinks the matched images have, in the range of 0-100. Values ≥85 indicate a match; values <85 indicate that images do not match. null if the check could not be completed
Indicates the response received from the service provider. One of success or failure; or null if the check could not be completed
Object containing data from a Proof of Address solution extractions and checks.Optional, available only if Proof of Address solution has been emabled for the integration.
Indicates if the name on the Proof of Address document matches the name fromthe initial request data. null if the check could not be completed.
Indicates the level of similarity the matched names have, in the rangeof 0.00-100.00. null if the check could not be completed.
Indicates the type of the proof of address document. null if the check couldnot be completed.
Object with data about document integrity. Available only if the fraud validationhas been enabled for your PoA integration
Indicates the risk level. null if the check was not executed or failed.
Short description indicating the reason behind the risk level.null if the check was not executed or failed.
Human readable explanation of the data in the reason field.null if the check was not executed or failed.
Array strings listing the factors that influenced the risk assessment.Empty if the check was not executed or failed.
Data that has been optionally verified for the US Database Verification session, depending on the integration. Empty if no additional data was verified. Optional, depending on integration
Name of the registry
Indicates the match level of person's first name data
Indicates the match level of person's last name data
Indicates the match level of person's date of birth data
Indicates the match level of person's address data
Indicates the match level of person's address data, specifically the city
Indicates the match level of person's address data, specifically the state
Indicates the match level of person's address data, specifically the zip code (post code)
Indicates the match level of person's identity number or SNN number data
A float in the range of 0.0–1.0. Numerical value representing the overall risk associated with the session. Lower score indicates more confidence in that the session is genuine. Note: in the Veriff Customer Portal, the range is shown as 1–100.
Name of the risk label
Category of the risk label
Array of verification IDs that are referenced to the particular risk label
Object containing data about the biometric authentication. Optional, available only when using the Biometric Authentication solution
Refers to the verification session ID which face matched
Refers to the verification session vendorData which the face matched
Refers to the verification session endUserId which the face matched
Lists the results of different checks that were made to verify the end-user. Data is shown as key-value pairs. The key represents the check name and the value represents the check result
Always returns empty array
Technical data object
IP of the device from which the verification was made
Bad request
Unauthorized
Session not found
Internal server error
Article Versioning
Date | Description |
|---|---|
May 21, 2025 | Updated the note about response payload when there is no decision yet |
May 19, 2025 |
|
May 2, 2025 |
|
Aprl 7, 2025 |
Description of |
Mar 12, 2025 | Documentation published |