Skip to content

Register a new user​

POST
/cognito/signup

Create a new account via AWS Cognito. The account is confirmed immediately and a verification link is mailed to the address; the email stays unverified until that link is followed (see GET /cognito/verify-email), and several write endpoints refuse an unverified account. Gated by the features.user_registration flag — when the flag is off the endpoint answers 403. Rate limited to 10 requests per minute per IP. When the risk engine flags the caller (repeated sign-ups from one IP), a reCAPTCHA token must be sent as captchaToken.

Request Body​

application/json
JSON
{
"email": "user@example.com",
"password": "SecureP@ssw0rd!",
"name": "John Doe",
"captchaToken": "string",
"ambassadorInviteToken": "string"
}

Responses​

Account created; verification email sent.

application/json
JSON
{
"message": "string",
"userSub": "string",
"userConfirmed": true
}

Playground​

Server
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress