Send verification code via email or SMS for authentication. Used during signin attempts and profile verification.
curl --request POST \
--url https://{deploymentHost}/auth/prepare-verification \
--header 'Content-Type: application/json' \
--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": []
}
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Verification code sent successfully
The response is of type object
.
curl --request POST \
--url https://{deploymentHost}/auth/prepare-verification \
--header 'Content-Type: application/json' \
--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": []
}