Stytch · Example Payload

Stytch Consumer Otps Sms Send Example

Send a one-time passcode (OTP) to a user's phone number. If you'd like to create a user and send them a passcode with one request, use our [log in or create](https://stytch.com/docs/api/log-in-or-create-user-by-sms) endpoint.

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Stytch Consumer Otps Sms Send Example is an example object payload from Stytch, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titleendpointdescriptionrequestresponse

Example Payload

{
  "title": "Send",
  "endpoint": "POST /v1/otps/sms/send",
  "description": "Send a one-time passcode (OTP) to a user's phone number. If you'd like to create a user and send them a passcode with one request, use our [log in or create](https://stytch.com/docs/api/log-in-or-create-user-by-sms) endpoint.",
  "request": {
    "method": "POST",
    "path": "/v1/otps/sms/send",
    "headers": {
      "Authorization": "Basic <base64(project_id:secret)>",
      "Content-Type": "application/json"
    },
    "body": {
      "phone_number": "<phone_number>",
      "expiration_minutes": 3600,
      "user_id": "<user_id>",
      "session_token": "<session_token>",
      "session_jwt": "<session_jwt>"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "request_id": "example-value",
      "user_id": "example-value",
      "phone_id": "example-value",
      "status_code": 200
    }
  }
}