Skip to main content
POST

Authorizations

Authorization
string
header
required

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

Body

application/json
customer_reference
string
required

Your own reference for the person you verify. Blaaiz returns it on the session and on the webhook.

Maximum string length: 100
idempotency_key
string
required

Your key for this create. A repeat of the same key returns the stored session instead of a new one. The key is unique to your business and is never released.

Maximum string length: 100
requirements
enum<string>[]
required

What the session must prove. Order does not matter, and a value may appear once. Supported sets: [DOCUMENTS, SELFIE, FACE_MATCH], [DOCUMENTS], [DOCUMENTS, SELFIE, FACE_MATCH, PROOF_OF_ADDRESS], [DOCUMENTS, PROOF_OF_ADDRESS], and [PROOF_OF_ADDRESS]. FACE_MATCH needs DOCUMENTS and SELFIE in the same set. Any other combination fails with 422, and the message names the supported sets.

Required array length: 1 - 4 elements
Available options:
DOCUMENTS,
SELFIE,
FACE_MATCH,
PROOF_OF_ADDRESS
fulfilment_mode
enum<string>

Who collects the input. Omit it to take the default for the requirement set: SUMSUB_HOSTED for [DOCUMENTS, SELFIE, FACE_MATCH], HEADLESS for [DOCUMENTS], and SUMSUB_HOSTED for every set that includes PROOF_OF_ADDRESS. BLAAIZ_HOSTED is available for [DOCUMENTS, SELFIE, FACE_MATCH] and for every set that includes PROOF_OF_ADDRESS. HEADLESS is available for [DOCUMENTS, PROOF_OF_ADDRESS] and [PROOF_OF_ADDRESS], but never for a set that includes SELFIE.

Available options:
SUMSUB_HOSTED,
BLAAIZ_HOSTED,
HEADLESS
applicant
object

Details you already hold about the person. Every field is optional.

Response

Verification session created successfully.

message
string
required
data
object
required