v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams Service

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. Errors (e.g. too many failed attempts) are returned via the standard error envelope.

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

post/streams/otp/verify

Request body

recipient_phonestring required

The phone number that received the OTP, in international format.

codestring required

The OTP code the recipient submitted.

Example request

{
  "recipient_phone": "447700900123",
  "code": "4821"
}

Response

The verification result.

verificationboolean

true if the submitted code matches the active OTP; otherwise false.

Example response

{
  "verification": true
}