Create verification session

Request

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.

Security

verify_access_token

Bodyapplication/jsonrequired

callback_urlstring

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

statestring

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

mock_behaviorobject

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.

Example:null

startobject

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.

customer_informationobject

Additional customer information for this session. This information should not contain any PII data.

time_to_livestringdeprecated

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.

Default:"90d"

Example:"90d"

auto_startbooleandeprecated

Deprecated. See 'start'

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/verify/api/v1/verification \
  -H 'Authorization: Bearer <YOUR_jwt_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "callback_url": "string",
    "state": "string",
    "time_to_live": "90d",
    "mock_behavior": null,
    "auto_start": true,
    "start": {
      "consent": {
        "granted": true,
        "document_id": "string"
      }
    },
    "customer_information": {
      "organization_name": "string",
      "organization_id": "string",
      "external_user_id": "string",
      "cost_center": "string"
    }
  }'

Responses

Session created

Bodyapplication/json

start_tokenstring

A single-use token that is used in the request to initiate the verification process. It will bind the session to the device. In case of an auto-start session, this token won't be returned

session_idstringrequired

ID of the new verification session, which can be used to check the status and the result

expirationstringrequired

The expiration date of this session

missing_imagesArray of stringsrequired

The additional image types that need to be added

Items Enum:"document_front""document_back""selfie"

Response

{
  "start_token": "string",
  "session_id": "string",
  "expiration": "string",
  "missing_images": [
    "document_front"
  ]
}