Creates a verification session with the data specified in the request body
The contents of the request body depends on whether you are using the SDK or the API to capture and send the end-user data, and on what product you are using. Minimum request body is empty verification object.
Once you create the verification session, in return you receive a unique session id and a unique sessionToken that are related to the verification session initiated for the specific end-user.
The response also returns the session URL value (required in the SDK integrations). You can find this in the verification.url parameter.
You can find the sample implementation for Javascript at https://github.com/Veriff/js-integration-demo[↗]
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")
Your Integration's ID. Required when the flexible API keys solution is used
Session initialization data
Verification object
The callback URL to where the end-user is redirected after the verification session is completed. Default is visible in the Veriff Customer Portal > Settings. Changing the value in this request body will overwrite the default callback URL, but it will not change the callback URL that is visible in the Customer Portal.
Data about the person being verified
Person's first name
Person's last name
Person's national identification number
Person's phone number
Person's gender
Person's date of birth
Person's email address
Person's marital status. Allowed values: single, married, divorced, widowed
Person's deceased status. Allowed values: true, false
Data about the document of the person being verified
Document number, [a-zA-Z0-9] characters only
Document issuing country
Document type
Document type for the ID card, [a-zA-z] characters only. Only required for Colombia identity verification. One of: CE, CE or TI
Date of the document's first issue
Data about the address of the person being verified
Full address (mandatory only for UK DIATF M1B profile flow)
Data about the proof of address document of the person being verified
Accepted types for proof of address document. This parameter should be sent only when using the proof of address solution
Name of the accepted proof of address document type
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.
Array of objects listing the type of consent given. Optional, should be only included for features that require consent
Indicates the feature for which the consent is given
If true, indicates that the consent has been given. true is mandatory to start the INE Biometric Database Verification. If false or missing, the session is not created.
Created session
API request status
Verification object
UUID v4 which identifies the verification session
URL of the verification session. The end-user is redirected here to go through the flow. It is a combination of the baseUrl and the sessionToken
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 base url the sessionToken can be used for
Verification session status
Session-specific token of the verification
Bad request
Unauthorized
Too many requests
Internal server error
Article Versioning
Date | Description |
|---|---|
Apr 30, 2025 | 1. New parameters added to request's 2. New header |
Apr 22, 2025 |
|
Mar 12, 2025 | Documentation published |