POST /v1/auth/phone/otp/start

POST/v1/auth/phone/otp/start

Header parameters

x-request-idstring

Optional caller-provided request identifier

x-correlation-idstring

Optional caller-provided correlation identifier

Request body

requiredapplication/json

Start a phone SMS OTP challenge

phonestringrequired

purposestringrequired

Responses

200Phone OTP challenge started

challenge_idstringrequired

debug_codestring | null

expires_atstring<date-time>required

resend_afterstring<date-time>required

400Request validation failed

codestringrequired

correlation_idstring | null

detailstringrequired

errorsProblemErrorDetail[]required

Show properties

Array of ProblemErrorDetail

fieldstring | null

reasonstringrequired

next_actionsstring[] | null

request_idstring | null

statusinteger<int32>required

min 100 · max 599

titlestringrequired

typestringrequired

429Phone OTP start is rate limited

codestringrequired

correlation_idstring | null

detailstringrequired

errorsProblemErrorDetail[]required

Show properties

Array of ProblemErrorDetail

fieldstring | null

reasonstringrequired

next_actionsstring[] | null

request_idstring | null

statusinteger<int32>required

min 100 · max 599

titlestringrequired

typestringrequired

500Internal server error

codestringrequired

correlation_idstring | null

detailstringrequired

errorsProblemErrorDetail[]required

Show properties

Array of ProblemErrorDetail

fieldstring | null

reasonstringrequired

next_actionsstring[] | null

request_idstring | null

statusinteger<int32>required

min 100 · max 599

titlestringrequired

typestringrequired

Request

curl -X POST "/v1/auth/phone/otp/start" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "string",
  "purpose": "string"
}'

const response = await fetch("/v1/auth/phone/otp/start", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "phone": "string",
  "purpose": "string"
})
});

import requests

response = requests.post(
    "/v1/auth/phone/otp/start",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "phone": "string",
  "purpose": "string"
},
)

Response

{
  "challenge_id": "string",
  "debug_code": "string",
  "expires_at": "2024-01-01T00:00:00Z",
  "resend_after": "2024-01-01T00:00:00Z"
}

{
  "code": "string",
  "correlation_id": "string",
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "next_actions": [
    "string"
  ],
  "request_id": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "correlation_id": "string",
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "next_actions": [
    "string"
  ],
  "request_id": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "correlation_id": "string",
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ],
  "next_actions": [
    "string"
  ],
  "request_id": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}