Get ID Check session
curl --request GET \
  --url https://api.sandbox.verisoul.ai/liveness/session \
  --header 'x-api-key: <api-key>'
{
  "request_id": "aad5cc61-1766-4546-a8a7-1790554b24ec",
  "session_id": "000ff417-cfe3-4d32-8323-59cb05b854cb"
}
The ‘id=true’ query parameter is required to include ID verification in the session.

Authorizations

​
x-api-key
string
header
required

API key authentication

Query Parameters

​
id
boolean
required

Flag to indicate that this session will include ID verification

​
referring_session_id
string<uuid>

ID of a referring session, if applicable

​
simulate
string

See Simulate ID Check for more information

Response

200 - application/json

Session created successfully

​
request_id
string<uuid>
required

Unique identifier for the request

​
session_id
string<uuid>
required

Unique identifier for the session