Skip to content
BuildBase
HTTP API menu

Send a one-time code to a phone number

Called with the hosted sign-in context.

POST/api/v1/auth/phone/send

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. Answers the same success message whether or not the number has an account; a code is delivered only to an existing, unblocked account or when public sign-up is open. Answers 403 when phone sign-in or the chosen channel is not offered, 400 for an invalid number, and 503 when no SMS provider is configured.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
phonestringYes1 to 32 characters-
channelstringNoone of "sms", "whatsapp", "voice"-
turnstileTokenstringNoat most 2048 characters-
captchaTokenstringNoat most 8192 characters-

Example request

Replace each YOUR_... value with your own.

curl -X POST "https://api.console.buildbase.app/api/v1/auth/phone/send?org=YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+15555550100"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/phone/send?org=YOUR_ORG_ID',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      phone: '+15555550100',
    }),
  }
);
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/phone/send?org=YOUR_ORG_ID",
    json={
        "phone": "+15555550100",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "message": "We sent a code to your phone.",
  "retryAfter": 30,
  "success": true
}

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
}