Get ID Check Session

Get ID Check session

cURL

curl --request GET \
  --url https://api.sandbox.verisoul.ai/liveness/session \
  --header 'x-api-key: <api-key>'

200

{
  "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

account_id · string

Your identifier for the user's account. If provided, the session is linked to the account automatically when it completes, enabling multi-accounting detection and account-level features (lists, rules) on the verify response. Must be a non-empty string. See Account ID for more information.

referring_session_id · string<uuid>

ID of a referring session, if applicable

simulate · string

See Simulate ID Check for more information

simulate_decision · enum<string>

Sandbox only. With simulate=success, the decision returned by the verify endpoint and the completion webhook. One of Real, Suspicious, Fake. If you pass only this, risk_score defaults to 0.1 (Real), 0.5 (Suspicious) or 0.9 (Fake). See Simulate ID Check for more information

Available options: Real, Suspicious, Fake

simulate_risk_score · number

Sandbox only. With simulate=success, the risk_score returned by the verify endpoint and the completion webhook. A number from 0 to 1. Passed through as given; it is not checked against simulate_decision

Required range: 0 <= x <= 1

simulate_risk_flags · string

Sandbox only. With simulate=success, the risk_flags returned by the verify endpoint and the completion webhook. A comma-separated list of up to 20 lowercase snake_case flag names, for example vpn_detected,repeat_face. If you pass simulate_decision or simulate_risk_score without this, risk_flags is empty

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