Skip to main content
POST
otp.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by otp.send.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
code
string
required

The code supplied by the recipient; never returned or logged.

Required string length: 1 - 32

Response

The result

verified
boolean
required

Whether the challenge accepted this code.

reason
enum<string>

Neutral reason when the code was not accepted.

Available options:
mismatch,
expired,
attempts_exhausted,
already_verified