Skip to main content
POST
Initiate a user's verification

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

What a client sends to start a user's verification.

mobile
string
required

The user's phone; we start their verification session from it

Pattern: ^(?:\+91)?[6-9]\d{9}$
return_url
string
required

Where the user is sent afterwards. Must match the client's registered allowlist

reference_id
string | null

The client's own id for the entity, echoed back on reads

Maximum string length: 128

Response

The provisioned user_id and the verification's initial status.

The verification session we started.

Redirect the user to verify.privue.ai/, then poll with this id.

user_id
string
required

Our id for this verification; use it as the key on every read

reference_id
string | null
required

Your correlation id, echoed back; null if you sent none

status
enum<string>
required

Lifecycle status; created for a fresh verification

Available options:
created,
in-progress,
completed,
cancelled,
expired