Verify authentication code from email or SMS. Completes the verification step for signin or signup attempts.
curl --request POST \
--url https://{deploymentHost}/auth/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"signin_attempt_id": "123456789",
"code": "123456"
}'
{
"status": 200,
"message": "",
"data": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"completed": true,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [
{
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"session": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"completed": true,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [
{
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Verification completed successfully
The response is of type object
.
curl --request POST \
--url https://{deploymentHost}/auth/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"signin_attempt_id": "123456789",
"code": "123456"
}'
{
"status": 200,
"message": "",
"data": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"completed": true,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [
{
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"session": {
"signin_attempts": [
{
"id": "123456789",
"method": "email_otp",
"completed": true,
"created_at": "2024-01-01T12:00:00Z"
}
],
"signins": [
{
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "987654321",
"user_id": "456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}