Skip to main content
POST
identity.verification.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
workflowId
string

Id of the verification flow to run. Omit it to use this account's default flow (an ID document check, a selfie liveness check and a face match).

Pattern: ^[0-9a-fA-F-]{16,64}$
endUserId
string

Your own stable id for the person being verified (your user id, never anything you would not store). Sessions with the same id count as the same person, so repeat verifications do not raise duplicate warnings. While a verification with this id is still unfinished, creating another returns that same verification and its link.

Required string length: 1 - 256
language
string

Interface language for the end user, for example "en" or "es".

Response

The result

verificationUrl
string<uri>
required

Hosted verification link. Send your end user here; it is a private link for this one verification.

status
string
required

Starting state of the verification, for example not_started. Read identity.verification.get (with the ref) until it ends: approved, declined, in_review or expired.

sessionNumber
integer

Sequential number of the verification in your account, for your own records.

Required range: -9007199254740991 <= x <= 9007199254740991
ref
string

Reference to what this call created. Pass it as ref to identity.verification.get, identity.verification.update, identity.verification.correct, identity.verification.delete or identity.verification.report.