Unicat API Reference

Up - API Reference - Home

/api/signup_request

Request a new account.

Note: creating a new account is a two-step process; this is the first step that initiates the action, the second step completes it, see /api/signup.

Request

POST /api/signup_request

{
    "username": "<your-username-here>",
    "password": "<your-password-here>",
    "email": "<your-email-here>",
}

username a new username (will be checked for availability). A username is case-sensitive.
password a new password (will be checked for strongness).
email a valid email address where the verification code will be sent. An email address is not case-sensitive.

Success response

{
    "success": true,
    "result": {
        "validation_code": "<validation-code>",
    },
    "data": {}
}

Also, an email is sent to the given email address. This email contains a 6-character verification code. This one-time code is valid for 15 minutes. Both validation and verification codes must be submitted in step 2.

result

validation_code is one of the codes that must be submitted in the completion step - the other code is sent via email.

Error response

400 Bad request - missing or invalid parameters (only the first is reported)
1001 Validation error - unavailable username, weak password - see Validation information