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 when the session was submitted
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
Object containing person’s name components extracted from the document. Optional, only available if configured for you integration by Veriff
Person’s title extracted from the document, e.g., “MR”, “MS”. null when no title data present on the document
Person’s middle name extracted from the document, from a dedicated field on the document or document barcode results. null when the first name has no suffix according to barcode data. The field is not sent when the document has no dedicated field or barcode
Person’s first name extracted from the document and stripped from all components like middleName or firstNameSuffix
Person’s first name suffix. null when the first name has no suffix according to barcode data. The field is not sent when the document has no barcode
Legacy field, may return incorrect results, should be ignored
INE identification number. Optional, present only for Mexican registry checks
IFE identification number
Occupation data extracted from the document. Present only if data is available on the document.
Employer's name extracted from the document. Present only if data is available on the document.
Foreigner status field extracted from the document. Present only if data is available on the document.
Additional name extracted from the document. Present only if data is available on the document.
Person’s title extracted from the document. Present only if data is available on the document.
Person’s electoral number extracted from the document. Optional, currently only for Mexican registry checks.
Person’s eye color data extracted from the document. Present only if data is available on the document.
Person´s hair color data extracted from the document. Present only if data is available on the document.
Person’s height data extracted from the document. Present only if data is available on the document.
Person’s weight data extracted from the document. Present only if data is available on 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
Person’s INE (Mexican voter’s registry) identifier number. Optional, present only for Mexican registry checks and if the data is available on the document
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 could not be completed.
Object with data about document integrity. Available only if the fraud validation has 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.
Contains data that has been found about the extracted address. Available only when PoA Address Validation feature has been enabled for your PoA integration.
Contains extracted address components
Full address as a string, containing extracted and found data
Any human settlement, including cities, towns, villages, hamlets, localities, etc.
An apartment, unit, office, lot, or other secondary unit designator
A first-level administrative division
Street name
Sovereign nations and their dependent territories (ISO 3166)
Postal codes used for mail sorting
External (street-facing) building number
Indicates if the address is of a residential or business premise, or it is a PO box. One of residential , business , poBox. null if the address validation feature was has not been enabled, or if no data was sent.
Contains country validation result data
Indicates if the validation was able to verify the country
Indicates the result of country validation or if it was skipped. One of success, failure or skipped.
Contains all address matching validation results. Available only when PoA Address Matching feature has been enabled for your PoA integration
Array of exactly 2 address objects - first from initData, second from PoA document. The example displays one array.
Original full address string as provided/extracted
Google Maps API parsed address components
Parsed city name
Parsed partment/unit number
Parsed state/province
Parsed street name (premise)
Parsed country name
Parsed postal/ZIP code
Parsed house/building number
Indicates whether addresses match based on threshold
Configured matching percentage threshold
Indicates matching percentage
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
Contains the results from the database verification step. Optional, currently available only for Mexican INE and CURP database verification solutions.
Object containing validation check results
Shows how different end-user data types that were sent as initData or extracted from the document match the data in the registry. Optional, available only when end-user data matching validation is enabled for the integration. MATCH means that the input data matches registry data; NO_MATCH means the input data does not match registry data; NO_INPUT means no data was provided for the field; NO_DATA means the registry did not contain any info for this field.
Indicates how the person's gender as input in initData or extracted from document matches the data in the registry.
Indicates how the person's date of birth as input in initData or extracted from document matches the data in database.
Indicates how the person's full name as input in initData or extracted from document matches the data in database.
Contains validation check results
Confirms that the INE credential exists and data matches
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
Verifies active voting rights
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
Processing validation result
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
Optional, only available when the input data matching validation was enabled for the integration (matchData object is part of payload).
Always success, irrespective of matchData results.
Detailed information from the Mexican electoral registry
CIC (Código de Identificación de la Credencial) aka credential identification code
Voter key (Clave de Elector) assigned to the credential holder
Federal electoral district number
The issue/emission number of the credential (1-9 indicating how many times the credential has been reissued)
Year the current credential was issued
Expiration date of the credential (format: DD de MMMM de YYYY in Spanish)
OCR (Optical Character Recognition) code from the credential
Year the person was registered in the electoral system
Object containing validation check results
Shows how different end-user data types that were sent as initData or extracted from the document match the data in the registry. Optional, available only when end-user data matching validation is enabled for the integration. MATCH means that the input data matches registry data; NO_MATCH means the input data does not match registry data; NO_INPUT means no data was provided for the field; NO_DATA means the registry did not contain any info for this field.
Indicates how the person's gender as input in initData or extracted from document matches the data in the registry.
Indicates how the person's date of birth as input in initData or extracted from document matches the data in database.
Indicates how the person's full name as input in initData or extracted from document matches the data in database.
Indicates processing validation result
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
CURP validity validation result
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
Risk factors validation result
Indicates if the request was properly processed, one of success, failure (there was an error when processing the request) or not_applicable (processing check was not configured)
Additional information about the validation result. Not sent if result: success.
Indicates if the end-user's data from initData or document extraction could be matched agains the data in registry.
Always success, irrespective of matchData results.
Object containing detailed information retrieved from the Mexican government registry. Fields below are optional and might not be present if the data is null from the provider.
The validated curp number
Person's paternal surname from the registry
Person's maternal surname from the registry
Person's given name(s) from the registry
Person's gender from the registry
Date of birth from the registry
Nationality code
Type of supporting document used for CURP registration
Entity where the person was registered
Entity where the person was registeredState indicator where the person was registered
Municipality indicator where the person was registered
Page number from birth certificate (if applicable)
Tome number from birth certificate (if applicable)
Book number from birth certificate (if applicable)
Minutes number from civil registry
CRIP identifier (if applicable)
Secondary registration entity
Year of registration
Foreign registration number
Letter folio from registration
State of birth code
Entity that issued the CURP
Current status of the CURP
Certificate information
Indicates the result of the reference image and selfie matching. Optional, available only if Selfie2Selfie Biometric Verification has been enabled for your integration.
Main container for Cadastro Único Database Verification results. Optional, available only if the Cadastro Único Database Verification has been enabled for your integration.
Contains validation rule results
Indicates if registry processing was successful
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Validates input data format (CPF number and date of birth)
Validates input data format (CPF number and date of birth)
Explanations for failure (null or empty if result value is successful)
Checks if user is NOT receiving BCP benefit (failure means IS receiving)
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Checks if user is NOT receiving Bolsa Família (failure means IS receiving)
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Checks if user is NOT receiving fishermen insurance (failure means IS receiving)
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Checks if user is NOT in general registry (failure means IS registered)
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Checks if user is NOT receiving emergency aid (failure means IS receiving)
Validation outcome (success or failure)
Explanations for failure (null or empty if result value is successful)
Contains detailed benefit information from government registries
Continuous Cash Benefit details
Brazilian state code where benefit is registered
Unique benefit identification number
Indicates whether user was found in BCP registry
Social Identification Number of beneficiary
Reference period for data, represented as YYYYMM
Competence month for payment, represented as YYYYMM
Monetary value of benefit installment
City where beneficiary resides
Indicates if benefit was court-ordered
Bolsa Família program details
Quadro Social e Administrativo indicator, indicating if the beneficiary is registered as a partner or administrator of a business
Indicates whether benefit is currently active
Date of last benefit payment, represented as DD/MM/YYYY
Flags data inconsistencies in record
Date user first received benefit
Value of last installment paid
Payment history summary for last year
Details of last payment method
Indicates whether user ever received this benefit
Current enrollment status
Had formal employment in last 5 years
Artisanal fishermen insurance details
Shows whether user found in Seguro Defeso registry
CPF number of the beneficiary
NIS number of the beneficiary
Full name of the beneficiary
State of the beneficiary
IBGE municipality code
Municipality name
Reference month for benefit, represented as DD/MM/YYYY
Amount received for installment
RGP fishing registration number
Indicates if the person received both benefits in same period
Emergency aid details
State where aid was registered
Monetary value of aid installment
Remarks about benefit status
Specific installment number
City where beneficiary resides
Category of beneficiary
Whether user found in Emergency Aid registry
Month funds became available, represented as MM/YYYY
Municipality code
Additional verified data container. Optional, available only if the ProBet Database Verification has been enabled for your integration.
ProBet validation results container
Validation rule results
Validation outcome (success, failure)
Explanations for failure (null or empty if result value is successful)
User data format validation
Validation outcome
Explanations for failure (null or empty if result value is successful)
PIA registry check (negative logic)
Validation outcome
Explanations for failure (null or empty if result value is successful)
ProBet registry check (negative logic)
Validation outcome
Explanations for failure (null or empty if result value is successful)
Detailed registry data
Politically exposed person (PEP) information
Full name of PEP
Public office or role held
Government body or organization
Role start date
Role end date
PEP validity date
Artist/public figure information
Brazilian Tax ID
Legal name
Stage or public name
Profession or role
Betting administration registry information
Indicates whether found in PIA registry
Company tax identification number
Legal company name
Business category
Digital influencer information
Social media name
Primary social media URL
Influence category
The final computed result based on all the data above
Indicates whether the end-user is allowed to bet
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 |
|---|---|
Dec 16, 2025 | New objects added to - - - Data type of |
Nov 27, 2025 |
|
Nov 19, 2025 | INE Database Verification and CURP Database verification info added to |
Nov 14, 2025 | Proof of Address info updated: |
Oct 3, 2025 | The ISO 8601 format and example of |
Oct 2, 2025 | New prarameters
|
Sep 11, 2025 | New optional object added: |
Aug 19, 2025 | Typo fixed in parameter name: |
Aug 6, 2025 | Response headers added |
Jul 23, 2025 | New category name added to |
Jul 22, 2025 | New fields added to: - - |
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 publishedSelfie2Selfie Biometric Verification |