Sign in
OpenAPI 3.1.02026-08-195681822.2 MB

5d3a131531d9

Verify

Get a verification

Current state of a verification. status is effective (a pending code past its expiry reads as expired). Verification records are deleted 24 hours after creation, after which this returns 404.

get/v1/verify/verifications/{verificationId}

Path parameters

verificationIdstring required

Response

The verification.

idstring
status'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed'
channel'sms'
tostring
expiresAtstring date-time
attemptsinteger
maxAttemptsinteger
sendCountinteger

Accepted deliveries (initial send + resends); each bills one verification fee.

lastSentAtstring date-time nullable
createdAtstring date-time
resendboolean

Present on create responses: true when an active verification was resent instead of created.