Intro to the SDK

See platform-specific SDK documentation in the SDK Guides section

Opt for the Software Development Kits (SDKs) when you prefer using Veriff's front-end solution and built-in verification flow, and have no plans to independently collect end-user media.

This article aims to give a quick intro into using Veriff services via Software Development Kits (SDKs).


Quick overview of the steps

  1. Pick and add the relevant Veriff SDK to your project (see the relevant SDK guide for more info)

  2. Create an integration

  3. Set up webhooks

  4. Create a verification session to get the session URL

    1. Using the POST /sessions[↗] API call

    2. Using the JavaScript SDK

  5. Pass the session URL to the SDK

  6. Direct the end-user to the verification flow, where they submit their data and media

  7. End-user's data and media is passed to Veriff

  8. Veriff verifies the end-user

  9. Veriff returns the decision via the decision webhook


SDK session lifecycle diagram

SDK flow diagram: customer creates a session, gets a session URL, and directs the end-user to it. End-user verifies; Veriff sends a decision

The diagram above illustrates a verification process flow between three entities: end-user, customer, and Veriff.

Step

End-User

Customer

Veriff

1

Creates session by sending POST request to "/sessions"

Returns session URL in verification.url parameter

2a

Native SDK users: Starts verification session using Veriff mobile SDK with provided verification URL

2b

Web SDK users: Is directed to the verification URL to begin verification

3

Completes verification flow on device

4a

Native SDK users: Taken back to customer's application

4b

Web SDK users: Redirected to destination set by customer (e.g., verification.callback)

5

Receives decision

Sends decision to customer via webhook

The diagram uses dashed vertical lines to represent the timeline for each entity and horizontal arrows to show the direction of communication between them. A horizontal green bar represents the end-user completing the verification flow, and another green bar indicates "Session is verified" at the conclusion.


Article Versioning

Date

Description

Mar 31, 2025

SDK session lifecycle diagram updated

Diagram description added

Mar 12, 2025

Documentation published