Skip to main content
POST
Create a verification session

Authorizations

Authorization
string
header
required

API key authentication. Use format "Bearer sk_live_..." or "Bearer sk_test_..."

Body

application/json
clientReferenceId
string
required

Your internal reference ID for this session

Example:

"user-123"

modules
object[]
required

Legacy module configuration (deprecated, use flow instead)

metadata
object

Custom metadata (max 50KB)

Example:
initialPhrase
string

Opening message from the avatar

finalPhrase
string

Closing message from the avatar

providedData
object

Pre-filled user data

avatarId
string

Specific avatar to use

langs
string[]

Available languages for the session

Example:
defaultLang
string

Default language

Example:

"en"

zone
enum<string>

Geographic zone

Available options:
es,
eu
flow
object[]

Flat array of nodes that defines the verification flow. Each node carries its own outcome (START node) or outcomes (verification nodes) that reference other node ids by string, so there is no separate edges array. See the FSNode schema for per-type shapes.

Response

Session created successfully

session
object
required
clientSecret
object
required