Skip to content
Open the portal
Developer docs

Request Otp

POST
/v1/auth/otp/request
curl --request POST \
--url https://example.com/v1/auth/otp/request \
--header 'Content-Type: application/json' \
--data '{ "email": "example", "intent": "signup" }'

Send a six-digit code. The response is identical whether or not the email has an account.

Media typeapplication/json
OtpRequestIn
object
email
required
Email
string
intent
Intent
string
default: login
Allowed values: signup login invite

Successful Response

Media typeapplication/json
Response Request Otp V1 Auth Otp Request Post
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}