Send a verification code
Generate a one-time code, deliver it to the recipient, and store only its hash. Check the user-typed code with POST /v1/verify/verifications/{verificationId}/check.
Re-POSTing for the same (channel, to) while a verification is active RESENDS a fresh code on the existing verification (200 with resend: true) instead of creating a new one; resends are limited to one per 60 seconds (429 with retryAfterSeconds inside the cooldown). The stored brandName/codeLength/ttlMinutes win on a resend.
Codes deliver by SMS from a phone number on your account (from optional when you own exactly one SMS-enabled number) and the message uses a fixed template. Each accepted send bills one verification fee plus the standard message rate.
Request body
Response
Active verification found: a fresh code was resent (resend: true).
Changes
Changed in 3 of the 56 revisions of this API.7
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○