See {{variable.API-documentation-link}} for detailed info about Veriff APIs

Opt for using the Application Programming Interface (API) solution if you want to collect the {{glossary.end-user}}'s data and/or media yourself via your own solution, and then use Veriff's API endpoints to pass us relevant data for verification.

Note that collecting end-user's data beforehand or during the flow is optional, as Veriff can extract this data from the media sent to us.

Quick overview of the steps

Create an integration
Set up webhooks
Create a verification session to get the {{glossary.session ID}}
1. Veriff strongly recommends you send the vendorData/endUserId (see below)
Using the session ID, pass end-user's media via {{variable.POST-sessns-media-link}}
Patch the session to submitted using {{variable.PATCH-sessions-link}}
Wait for Veriff to verify the end-user
Veriff returns the decision via a webhook

{{snippet.vendorData-callout}}

{{snippet.endUserId-callout}}

API session lifecycle diagram

When verifying via API:

Customer decides wether to collect end-user’s data and media before or after creating the session
Session ID aka verification.id is the unique identifier of the session that needs to be included in all the API calls that are done for that session

Flowchart illustrating the flow of data between the end-user, customer, and Veriff during a verification process.

The diagram above illustrates an end-to-end integration verification process between three entities: end-user, customer, and Veriff.

Step	End-User	Customer	Veriff
1	Starts verification process and provides document and selfie images	Collects images of end-user's document and selfie (if relevant)
2		Creates session by sending POST request to "/sessions"
3			Returns session ID in `verification.id` parameter
4a		Uploads media via POST to "sessions/{sessionId}/media"
4b		Updates session status to "submitted" via PATCH to "/sessions/{sessionId}"
5			Session is verified (internal process)
6a		Receives decision	Sends decision to customer via webhook
6b		Optionally uses GET request to "/sessions/{sessionId}/decision" to query more detailed data	Provides detailed verification data when requested

The diagram uses dashed vertical lines to represent the timeline for each entity and horizontal arrows to show the direction of communication between them. Green horizontal bars represent the end-user providing documents/selfie in step 1 and Veriff verifying the session in step 5.

Article versioning

Date

Mar 31, 2025

Session flow diagram updated

Alt text updated

Mar 12, 2025

Documentation published