Skip to main content
POST
Create a new verification session

Authorizations

Authorization
string
header
required

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

Body

application/json
redirect_url
string

Optional URL to redirect the user to after the verification session is completed. Must use https:// (http:// is only accepted for localhost in development).

Maximum string length: 2048
share_fields
object

Optional map of requested share fields keyed by claim key. Each entry must include required (boolean) and reason (non-empty string, max 200).

webhook_endpoint_id

Optional webhook endpoint ID or endpoint ID list to target for this session. When omitted, events fan out to every enabled subscribed endpoint.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

Successful operation. Returns the newly created verification session.

data
object
required
Example:
error
null
required