Verify user email
Verify user email
- Method
- POST
- Path
https://api.returning.ai / auth/ verify-email
Authentication#
- Header
Authorization: Bearer <API_KEY>
Behaviour#
- What it is for
Verify user email. Use this as part of password-based account authentication rather than broker system ingestion.
- How to use it
Send a POST request to
/auth/verify-emailwith the request body, query parameters, or multipart fields shown below. Authentication endpoint. It does not use the broker integration API key in the same way as/v1/...endpoints.- Successful response
HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under
datawithstatusandmessage.- Common error states
400invalid request body, query, ObjectId, pagination, file format, or missing required field.401missing, invalid, expired, or insufficient API key/token.403key is valid but cannot access this community/channel/user/resource, where supported by the service.404target resource, route, or community-scoped record was not found.409duplicate or conflicting state for create/update operations, where applicable.500unexpected Returning.AI service error.
Request#
Headers#
Body#
curl --request POST \
--url https://api.returning.ai/auth/verify-email \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"email": "samoqa@koletter.com",
"code": "441225",
"host": "ic.genesiv.com"
}'
Response#
{
"meta": {
"success": true,
"message": "Email has been verified successfully",
"devMessage": "Email has been verified successfully"
},
"body": {
"accessToken": "<JWT>",
"refreshToken": "<JWT>"
}
}
Errors#
Fix the request02
400Fix the request
Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values.
401Fix the request
Verification token is missing, invalid, or expired.
Fix the data01
404Fix the data
User or verification record was not found.
Retry with backoff01
500Retry with backoff
Unexpected Returning.AI service error.
{
"status": "fail",
"message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}