Document Verification

Download OpenAPI specification:Download

Manage the verification sessions that are used to securely verify the identity of your customers using documents like their driver's license or passport.

Create verification session

Creates a new verification session that will provide a secure context to the verification process. It returns a start token that will be used when initiating the verification process from the client side. This should be called from the backend. See the Quick start guide for details.

SecurityHTTP: verify_access_token
Request
Request Body schema: application/json
required
callback_url
string

The url that the user will be redirected to once the verification process completes. It will contain the session ID used to obtain the verification result

state
string

An opaque string that is used to maintain state between the request and the callback, so it should be unique per request. It will be added as a URL parameter (named state) to the callback URL. The URL parameter should be validated by your server to protect against cross-site request forgery (CSRF) attacks

time_to_live
string
Deprecated
Default: "90d"

The time after which this session will be deleted (including all images and verification data). Once deleted, it will no longer be visible in the Admin Portal and the verification result won't be available via API. It should be formatted as a duration, e.g "30d", "60d", "90d". Defaults to "90d", which is 90 days.

object

Sets the behavior for the session for testing purposes only. For example, you can simulate a flow that results in a specific recommendation without performing an actual verification.

auto_start
boolean
Deprecated

Deprecated. See 'start'

object

Automatically start the session upon creation. If you intend to send this session to a frontend component (app, sdk, etc), leave this parameter empty - the session will be started by the frontend. However if you want to operate this session via your backend server, this parameter should be filled in.

Responses
200

Session created

400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

post/api/v1/verification
Request samples
application/json
{
  • "callback_url": "string",
  • "state": "string",
  • "time_to_live": "90d",
  • "mock_behavior": null,
  • "auto_start": true,
  • "start": {
    }
}
Response samples
application/json
{
  • "start_token": "string",
  • "session_id": "string",
  • "expiration": "string",
  • "missing_images": [
    ]
}

Get verification result

Retrieves the results of the verification session, which contains detailed information about the submitted documents (including PII). This should be called from the backend.

SecurityHTTP: verify_access_token
Request
path Parameters
sid
required
any

Session ID returned upon session creation or in the callback URL upon completing the verification

query Parameters
detailed
boolean
Deprecated

This parameter allows existing customers to select between response objects. You should explicitly send false to return the DeprecatedSessionResult response structure or send true to return the new CompleteSessionResult/IncompleteSessionResult response structure. Please note this parameter will be removed once DeprecatedSessionResult is fully deprecated.

Responses
200
400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

404

Session not found

get/api/v1/verification/{sid}/result
Request samples
Response samples
application/json
{
  • "session_id": "string",
  • "status": "complete",
  • "recommendation": "DENY",
  • "person": {
    },
  • "document": {
    },
  • "additional_info": {
    },
  • "checks": {
    }
}

Delete verification session

Deletes a verification session. This deletes the personal user data collected during the verification process

SecurityHTTP: verify_access_token
Request
path Parameters
sid
required
any

Session ID returned upon session creation or in the callback URL upon completing the verification

Responses
200

Session deleted

400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

404

Session not found

delete/api/v1/verification/{sid}
Request samples

Get all images for session

Retrieves all the images that were submitted for the session. The response contains only the image metadata, which includes the image ID that can be used to fetch the actual image.

SecurityHTTP: verify_access_token
Request
path Parameters
sid
required
any

Session ID returned upon session creation or in the callback URL upon completing the verification

Responses
200

List of all images (metadata)

400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

get/api/v1/verification/{sid}/images
Request samples
Response samples
application/json
{
  • "session_images": [
    ]
}

Add image to session

Submits the images needed for the verification check: document's front and back, and a selfie. Must be sent from the backend. The response includes feedback on the image that was submitted. Once acceptable images are submitted, the verification will start to be processed and the verification result can be obtained via polling.

SecurityHTTP: verify_access_token
Request
path Parameters
sid
required
any

Session ID returned upon creating the verification session

Request Body schema: application/json
required
required
object

The image to add

object

The device information

Responses
200

Contains feedback on the added image.

400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

404

Session not found

409

All required images were successfully submitted

post/api/v1/verification/{sid}/images
Request samples
application/json
{
  • "image": {
    },
  • "device_info": {
    }
}
Response samples
application/json
{
  • "feedback": "ok",
  • "complete": "false",
  • "missing_images": [
    ]
}

Get image by ID

Retrieve the actual image from the session (and not only the image metadata). The image is specified by the image ID returned upon fetching all the session images.

SecurityHTTP: verify_access_token
Request
path Parameters
id
required
string

Image ID returned by the request to get all images

sid
required
any

Session ID returned upon session creation or in the callback URL upon completing the verification

Responses
200

Actual image

400

Request is malformed or missing required fields

401

Access token is malformed, missing data, or expired

404

Image not found

get/api/v1/verification/{sid}/images/{id}
Request samples