Skip to main content
POST
Open a session for the web SDK

Autorisations

Authorization
string
header
requis

vn_live_… or vn_test_…, from the console.

Corps

application/json
reference
string

Your identifier for this user or flow; echoed back, never interpreted.

Maximum string length: 200
document_type
enum<string>

Ask for this document only; omitted, the person chooses.

Options disponibles:
cni,
passport
ttl_seconds
integer
défaut:900
Plage requise: 60 <= x <= 3600

Réponse

Session with its single-use client token

id
string
requis
mode
enum<string>
requis
Options disponibles:
live,
test
status
enum<string>
requis
Options disponibles:
pending,
completed,
expired
reference
string | null
requis
document_type
enum<string> | null
requis

The one document asked for; null lets the person choose.

Options disponibles:
cni,
passport
verification_id
string | null
requis
expires_at
string<date-time>
requis
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
created_at
string<date-time>
requis
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
client_token
string

Give this to the browser. Shown once.

url
string

Hosted capture page for this session (https://verify.verifner.com/#…). Send it to the person to verify instead of embedding the SDK; the token is in the fragment. Single use, expires with the session.