Skip to main content
Send a one-time password (OTP) to the provided email address. You must call this endpoint and receive the OTP before calling Sign Up.

Request

POST /auth/signup/request-otp
string
required
The email address to send the OTP to.
string
The user’s display name. You can provide this here or during the signup step.

Response

string
A human-readable status message describing the result.
boolean
Indicates whether the OTP was successfully delivered to the email address.
string
The raw OTP value, returned only in non-production environments for testing. Empty string in production.
string
ISO 8601 timestamp indicating when the OTP expires. Empty string if unavailable.

Example

This endpoint is rate limited. If you call it too frequently, you receive a 429 response with a retryAfterSeconds field telling you how long to wait before trying again.

Error codes