Skip to content
BuildBase
HTTP API menu

Register a new account on hosted sign-up

Answers 403 method_unavailable for a password the app does not take, 403 signup_closed when the org does not allow this sign-up, 400 CAPTCHA_FAILED for a...

POST/api/v1/auth/register

Sign-in
No credential. Name the organization with the hosted sign-in state header or the org query parameter.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 20 requests a minute per IP address.

Answers 403 method_unavailable for a password the app does not take, 403 signup_closed when the org does not allow this sign-up, 400 CAPTCHA_FAILED for a failed security check, and 409 username_taken. Creates the user, sends the email verification code and returns a login token.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
namestringYes2 to 100 characters-
emailstringYesformat email, at most 320 characters-
passwordstringNo8 to 256 characters-
invitationTokenstringNo64 to 64 characters-
turnstileTokenstringNoat most 2048 characters-
captchaTokenstringNoat most 8192 characters-
usernamestringNo1 to 64 characters-
contextobjectNo--
context.timezonestringNoat most 64 characters-
context.countrystringNoat most 64 characters-
context.languagestringNoat most 64 characters-
context.currencystringNoat most 64 characters-

Example request

Replace each YOUR_... value with your own.

curl -X POST "https://api.console.buildbase.app/api/v1/auth/register?org=YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "email": "[email protected]"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/register?org=YOUR_ORG_ID',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      email: '[email protected]',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/auth/register?org=YOUR_ORG_ID",
    json={
        "name": "Example",
        "email": "[email protected]",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "message": "Your company does not allow that way to sign in here. Choose another way, or ask your IT team.",
  "reason": "sign_in_method_not_allowed",
  "success": false
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

Errors

Each refusal, what it means, and what to do. The request changed nothing.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}

Events

A successful call can send these webhook events to the endpoints that subscribe to them: