Skip to main content
POST
/
auth
/
prepare-verification
curl --request POST \
  --url https://{deploymentHost}/auth/prepare-verification \
  --header 'Content-Type: application/json' \
  --cookie __session= \
  --data '
{
  "signin_attempt_id": "123456789",
  "method": "email"
}
'
{
  "status": 200,
  "message": "",
  "data": {
    "signin_attempts": [
      {
        "id": "123456789",
        "method": "email_otp",
        "current_step": "verify_email_otp",
        "completed": false,
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signins": [],
    "signup_attempts": [],
    "active_signin": null
  },
  "session": {
    "signin_attempts": [
      {
        "id": "123456789",
        "method": "email_otp",
        "current_step": "verify_email_otp",
        "completed": false,
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signins": [],
    "signup_attempts": [],
    "active_signin": null
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Body

application/json
​
method
enum<string>
required

Verification method to use

Available options:
email,
sms
​
signin_attempt_id
string

ID of the signin attempt to verify

​
signup_attempt_id
string

ID of the signup attempt to verify

Response

Verification code sent successfully

​
status
integer
required

HTTP status code

​
message
string
required

Response message (empty for success)

​
data
any
required

Response data (can be any type)

​
session
object
required
​
errors
object[]
required

Array of error objects (empty for success)