OTP Auth Request

Send a one-time password (OTP) to a recipient. TextPeak generates the code, delivers it using the stream's configured OTP template and channel, and returns a request_uuid you reference when verifying.

  • Fails with 402 if the account balance is depleted, or 429 if the recipient's OTP request cap is reached.
  • Use retry: true to resend to the same recipient.

Authentication: stream token 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

Recipient phone number in international format, digits only.

string

Optional. The event/template to send the OTP with. Provide it only to override the default OTP template configured for this channel.

template_variables
object

Optional. Values for any additional placeholders in the template beyond the built-in [code] placeholder. Keys are the placeholder names.

boolean

Set to true to resend the OTP to the same recipient.

Response

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