Returning.AIDevelopers
v1

API reference / Legacy / Authentication

.md

Register user with password

This page documents POST /auth/register.

Last updated 26 Sep 2026API v1

Method
POST
Path
https://api.returning.ai/auth/register
Retries
Repeating register will not mount the route.

Authentication#

Header
Authorization: Bearer <API_KEY>

This is not a community API-key route. A valid integration key does not register a password account here.

Behaviour#

That register route is not mounted on https://api.returning.ai.

Do not use it to provision broker members. Use Create New User.

Request#

Headers#

Authorization#stringREQUIRED
API key.

RuleBearer <API_KEY>

Content-Type#stringREQUIRED
Request body format.

Ruleapplication/json

Body#

email#stringREQUIRED
Email address for the new user.

RuleEmail format

Eg"user@example.com"

password#stringREQUIRED
Password for the new account.

RulePassword

Eg"StrongPassword123!"

name#stringOPTIONAL
Optional display name for the user.

Eg"Test User"

Watch for

  • Password register is Legacy Authentication, not broker ingestion.
  • Login on the same host also 404s (Cannot POST /api/secureAuth/login when called as /v1/auth/login).
More examples and details

There is no success example. POST /auth/register returns 404.

curl --request POST \
  --url https://api.returning.ai/auth/register \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com",
    "password": "StrongPassword123!",
    "name": "Test User"
  }'

Response#

No success response on this gateway. Readback for created members is POST /v1/users/info.

status#string

Eg"success"

data#object
{
  "status": "success"
}

Errors#

Fix the request02

400Fix the request
The request body is missing required fields or contains invalid email/password values.
401Fix the request
Authentication context is invalid or the endpoint is not enabled for the current application.

Fix the data01

409Fix the data
A user with the same email already exists.

Retry with backoff01

500Retry with backoff
Unexpected server error.
{
  "status": "fail",
  "message": "Invalid request. Check required parameters, body fields, file format, pagination values, and ObjectId values."
}

Next step#

Create New UserPOST/v1/usersProvision the member with the community API key.