Skip to main content

​
The Verification Request Object

Verification requests represent OTP or magic link verifications sent to users for identity confirmation.

​
Attributes

​
id
string
required
Unique identifier for the verification requestExample: vreq_123
​
app_id
string
required
Application ID
​
app_user_id
string
required
ID of the user who initiated the verification
​
to_app_user_id
string
required
ID of the target user being verified
​
status
string
required
Verification status. Can be pending, verified, failed, cancelled, or expiredExample: pending
​
channel
string
required
Delivery channel. Can be email or smsExample: email
​
reason
string
required
Purpose of the verificationExample: login
​
identifier
string
required
Contact identifier (email address or phone number)Example: user@example.com
​
timeout
integer
Timeout duration in secondsExample: 300
​
recipient
object
Information about the recipient user
​
created_at
string
required
ISO 8601 timestamp when the verification was created
​
updated_at
string
required
ISO 8601 timestamp when the verification was last updated

​
Example Verification Request Object

{
  "id": "vreq_123",
  "app_id": "app_123",
  "app_user_id": "usr_456",
  "to_app_user_id": "usr_789",
  "status": "pending",
  "channel": "email",
  "reason": "login",
  "identifier": "user@example.com",
  "timeout": 300,
  "recipient": {
    "id": "usr_789",
    "name": "John Doe",
    "email": "user@example.com",
    "phone": "+1234567890"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}