Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Verify

Check a verification code

Verify the code the user typed. Wrong, expired, and exhausted codes answer 200 with valid: false and the settled status — only an unknown id is a 404. A correct code consumes the verification (single-use, status: approved) and fires the verification.approved webhook; the 5th wrong attempt settles it as max_attempts_reached and fires verification.failed.

post/v1/verify/verifications/{verificationId}/check

Path parameters

verificationIdstring required

Request body

codestring required

Response

Check result: the verification plus valid.

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.

validboolean