Verify

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 from a number on your account (from optional when you own exactly one number on the channel), always with a fixed template:

  • sms: from an SMS-enabled number. Each accepted send bills one verification fee plus the standard message rate.
  • whatsapp: from a connected WhatsApp number, as a Meta AUTHENTICATION template with a copy-code button. The first WhatsApp verification on a WhatsApp Business Account creates the zernio_verify_code template there and answers 422 template_pending until Meta approves it (usually minutes; retry after retryAfterSeconds). Meta fixes the message text, so brandName is not shown and the code's validity is not stated in the message (ttlMinutes is still enforced). Each accepted send bills one verification fee; Meta bills its authentication rate to your WhatsApp Business Account.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/verify/verifications

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/verify/verifications
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

tostring required

E.164 phone number. WhatsApp only delivers to a phone number, never to a username.

fromstring

The number on your account to send from: an SMS-enabled number for sms, a connected WhatsApp number for whatsapp. Defaults to your only number on that channel.

channel'sms' | 'whatsapp' required
brandNamestring

Your app or business name, rendered in the SMS message. Defaults to your account name. Not shown on WhatsApp, where Meta fixes the message and shows your WhatsApp display name. Letters, numbers, and basic punctuation only.

codeLengthinteger
ttlMinutesinteger

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.