OTP Verify Request

Verify the code a recipient submitted against the active OTP for their phone number. Returns verification: true on a match, otherwise false.

A wrong code is a normal false result with HTTP 200 — not an error. A correct code is accepted once: verifying clears it.

Voice OTP. While the call is still in progress the response is verification: false with in_progress: true; verify again after the call.

Errors. 400 no active code for this recipient · 429 too many wrong codes (wait for the cool-down). Errors use the standard error envelope.

Authentication: OTP token (the stream token of an OTP stream) in the Authorization header (see Authentication in the API Overview).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The phone number the code was sent to, in international format.

string
required

The code your user entered, as a string (keep leading zeros).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json