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.
Authorization
bearerAuth API key authentication - use your Zernio API key as a Bearer token
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
{ "id": "string", "status": "pending", "channel": "sms", "to": "string", "expiresAt": "2019-08-24T14:15:22Z", "attempts": 0, "maxAttempts": 0, "sendCount": 0, "lastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "resend": true}Request a higher sender ID daily limit
Asks support to raise the workspace's daily sender-ID message cap. There is no self-serve raise: the request (desired cap + use case) is reviewed manually, usually within a business day.
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.