Send a sign-in code over WhatsApp
Sends a 6-digit code, valid for 5 minutes, to the WhatsApp number registered for two-factor sign-in. Requesting again sends a new code; only the newest one is accepted.
Header Parameters
A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
challenge from POST /auth/login.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/auth/otp/send" \ -H "Content-Type: application/json" \ -d '{ "challenge": "string" }'{
"delivered_to": "string",
"expires_in_seconds": 300
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}