Skip to main content
POST
Create a verification session

Authorizations

Authorization
string
header
required

Your secret key (sk_live_…), server-side only. Also accepted as an x-api-key header.

Body

application/json
products
enum<string>[]

Which checks to run on the capture. Defaults to both. Liveness only = 1 credit, deepfake only = 2, both = 3.

Available options:
face_liveness,
deepfake
thresholds
object

Per-product threshold override, e.g. {"face_liveness": 0.6}. Values in [0,1]. Defaults to your org settings.

ttl_seconds
integer
default:900

How long the session stays usable. Clamped to 60–3600.

Required range: 60 <= x <= 3600
reference_id
string

Your own user/transaction id, echoed back on reads.

Maximum string length: 256
metadata
object

Arbitrary JSON, at most 4096 bytes, echoed back on reads.

Response

Session created

object
enum<string>
Available options:
verification_session
id
string

vs_… id. Keep server-side to fetch the result later.

status
enum<string>
Available options:
created
client_token
string

sst_… token for the SDK. Returned exactly once — only its hash is stored.

nonce
string

Bound into the submit payload; also available to the SDK via session_info.

products
string[]
reference_id
string | null
expires_at
string<date-time>
created_at
string<date-time>