Secure Auth
GET
/api/secureAuth
How to use it: Send a GET request to
/api/secureAuth with the request body, query parameters, or multipart fields shown below. Authentication depends on the owning service. Keep credentials server-side and verify required permissions before production use.Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under
data with status and message.Common error states:
400 invalid request body, query, ObjectId, pagination, file format, or missing required field.401 missing, invalid, expired, or insufficient API key/token.403 key is valid but cannot access this community/channel/user/resource, where supported by the service.404 target resource, route, or community-scoped record was not found.409 duplicate or conflicting state for create/update operations, where applicable.500 unexpected Returning.AI service error.Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/api/secureAuth?accessLevel=0&action=login&userId=%3CUsername%3E&email=%3CEmail%3E&firstname=%3CFirst%20Name%3E&lastname=%3CLast%20Name%3E&displayname=%3CDisplay%20Name%3E' \
--header 'apiKey: API_KEY_HERE' \
--header 'hostname: cname.yourdomain.com'Response Response Example
200 - Success Example
{
"error": false,
"loginUrl": "https://cname.yourdomain.com/v2/app/loginApi/[API_KEY]/2?token= [token]&host=[cname.yourdomain.com]",
"sessionId": "xxxxxxxxxxxxxxxxx"
}Modified at 2026-05-18 17:03:37