POST/auth/register

Register an account

Creates a user account from an email address, password, name, and phone number, and reports plainly when the address is already registered.

AccessNo sign-in required

Registration creates the account and nothing more. A new account belongs to no organisation and no workspace until it is invited to one, or until an organisation request made from it is approved. Once the call succeeds, the account can sign in through POST /auth/login.

An email address that is already registered is reported plainly rather than hidden behind a generic failure, so you can tell the person to sign in instead. Any other failure returns a generic error, so do not infer a cause from it.

Body parameters

emailstringrequired

The address that identifies the account. It is the sign-in identifier and the destination for verification and reset codes.

passwordstringrequired

The password the account signs in with.

first_namestringrequired

The account holder's given name, shown alongside their approvals and audit log entries.

surnamestringrequired

The account holder's family name.

phonestringrequired

A contact telephone number for the account.

bash

curl -X POST "$SQRL_API/auth/register" \
  -H "content-type: application/json" \
  -d '{
        "email": "operator@example.com",
        "password": "<account-password>",
        "first_name": "Ada",
        "surname": "Okafor",
        "phone": "+441632960431"
      }'

const res = await fetch(`${process.env.SQRL_API}/auth/register`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    email: "operator@example.com",
    password: "<account-password>",
    first_name: "Ada",
    surname: "Okafor",
    phone: "+441632960431",
  }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/auth/register", api_base))
    .json(&serde_json::json!({
        "email": "operator@example.com",
        "password": "<account-password>",
        "first_name": "Ada",
        "surname": "Okafor",
        "phone": "+441632960431",
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

#What happens next

The account exists but has nowhere to work yet. Either an administrator invites it to a workspace, which the holder accepts through GET /api/v1/accept-invite, or the holder signs in and submits POST /api/v1/request-organisation for staff to review. Taking part in vault approvals also needs a signing key, which the holder registers themselves through POST /api/v1/register-key.

Was this page helpful?