Session

Get ID Check session

Get a new session for ID Check verification. This is the first step in the ID Check workflow.

get/liveness/session

Request

Base URL
https://api.sandbox.verisoul.ai
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/verisoul/apis/verisoul-api/docs/liveness/session/get.ts
A function with typed inputs. Its response is checked against the schema.

idboolean required

Flag to indicate that this session will include ID verification

referring_session_idstring uuid

ID of a referring session, if applicable

simulatestring

See Simulate ID Check for more information

Session created successfully

account_idsstring[]

List of account IDs associated with this session

request_idstring

The ID of the request

project_idstring

The ID of the project

session_idstring

The ID of the session

start_timestring date-time

Timestamp when the session started

true_country_codestring

The true country code of the session

device_idstring

Device identifier from the session

No recorded changes to this operation across all 1 revision of this API.