Skip to content
BuildBase
HTTP API menu

Create an account for a verified phone number and sign in

Called with the hosted sign-in context, using the signupToken from phone verification (401 once it has expired or after three tries).

Warning

Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

POST/api/v1/auth/phone/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 10 requests a minute per IP address.

Called with the hosted sign-in context, using the signupToken from phone verification (401 once it has expired or after three tries). Creates the account with the phone and the given email, then answers a login token or a second-step challenge. Answers 409 when the email cannot be used, 403 when sign-up is closed, and 400 for a disposable address.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
signupTokenstringYes40 to 40 characters-
namestringYes1 to 200 characters-
emailstringYesformat email, at most 320 characters-
turnstileTokenstringNoat most 2048 characters-
captchaTokenstringNoat most 8192 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/phone/register?org=YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "signupToken": "string",
  "name": "Example",
  "email": "[email protected]"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/phone/register?org=YOUR_ORG_ID',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      signupToken: 'string',
      name: 'Example',
      email: '[email protected]',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
import requests

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

Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

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: