Skip to main content
POST
identity.verification.create-configured

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
workflow
string
required

Your label for this item.

Pattern: ^[a-z][a-z0-9_-]{0,63}$
contact
string
required

Email address or mobile number including country code.

Maximum string length: 254
name
string

Name of the person completing verification.

Required string length: 1 - 100
Pattern: ^[0-9A-Za-z\s.]+$
notify
boolean
default:true

Send the verification invitation; false is refused until private links are available.

expiryDays
integer
default:10

Invitation lifetime in days.

Required range: 1 <= x <= 90
presetValues
object

Prefill only fields allowed by the installed workflow.

stampRequests
object[]

Explicit stamps; maximum combined value 200000 rupees.

Required array length: 1 - 20 elements
collectionAmountInr
integer

Explicit collection amount; refused until settlement ownership is decided.

Required range: 1 <= x <= 200000
reversePayment
boolean
default:false

Request reverse bank payment; refused until settlement ownership is decided.

Response

The result

status
string
required

The verification invitation was accepted, not completed.

Allowed value: "accepted"
ref
string

Reference to what this call created. Pass it as ref to identity.verification.get, identity.verification.retry, identity.verification.media.get, identity.verification.purge.