Skip to main content
POST
Create and dispatch a PIN

Authorizations

Authorization
string
header
required

An API key from the OneXtel portal, Developers → API Keys, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Protects a send/resend against duplicate dispatch on retry. Replaying the same key + body within 24h returns the original response verbatim; the same key with a different body is rejected (idempotency_key_reuse); a concurrent request with the same key still in flight is rejected (idempotency_in_progress).

Body

application/json
destination
string
required

Destination, exactly as the active provider expects it — never reformatted.

Required string length: 1 - 64
Example:

"+919876543210"

templateId
string
required

The template to send under.

Minimum string length: 1
Example:

"tpl_abc123"

channels
enum<string>[]

Channels to dispatch on. Omit to use the template's default channel.

Minimum array length: 1
Available options:
sms,
whatsapp,
email
Example:
referenceId
string

Optional caller-supplied correlation id, searchable in Verifications.

Required string length: 1 - 200
Example:

"order_1234"

templateParams
object

Per-send override for a WhatsApp template's non-OTP placeholders, by position. Omitted positions fall back to the template's stored default.

Example:

Response

At least one channel accepted the message.

pinId
string
Example:

"pin_x9k2m1qz"

status
enum<string>
Available options:
PENDING,
VERIFIED,
EXPIRED,
BLOCKED
Example:

"PENDING"

expiresAt
string<date-time>
Example:

"2026-08-04T10:22:03.221Z"

attemptsRemaining
integer
Example:

3

channels
object[]