Skip to main content
GET
Retrieve a session's result

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The vs_… session id.

Response

The session

object
enum<string>
Available options:
verification_session
id
string
status
enum<string>
Available options:
created,
complete,
failed,
expired
decision
enum<string> | null

Verified = status "complete" AND decision "real".

Available options:
real,
spoof,
null
checks
object | null

Per-product outcome. Null until complete, and null on injection-blocked sessions.

risk
object
media
object

Whether the captured selfie is retrievable via the /media sub-resource.

products
string[]
reference_id
string | null
metadata
object | null
attempts
integer

Capture attempts used (max 3).

failure_code
string | null

e.g. ATTEMPTS_EXHAUSTED on failed sessions.

sdk
object
created_at
string<date-time>
expires_at
string<date-time>
captured_at
string<date-time> | null
completed_at
string<date-time> | null