Skip to content
BuildBase
HTTP API menu

Answer the age question on hosted sign-up or at sign-in

With the sign-in page's auth state, the answer is judged and kept only as a verdict under that state; answers 403 age_refused below the org's minimum and...

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/age-gate

Sign-in
None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
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.

With the sign-in page's auth state, the answer is judged and kept only as a verdict under that state; answers 403 age_refused below the org's minimum and 400 age_answer_invalid for an answer that does not fit the question. With a pending token instead (an existing account parked at sign-in, no auth state needed), a pass is kept on the account and the parked sign-in finishes, while a refusal is kept on the account, ends its sessions and answers 403; an unknown or spent token answers 401 mfa_expired.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
pendingstringYes40 to 40 characters-
confirmedbooleanNo--
birthDatestringNoat most 10 characters-

Example request

Replace each YOUR_... value with your own.

curl -X POST "https://api.console.buildbase.app/api/v1/auth/age-gate" \
  -H "Content-Type: application/json" \
  -d '{
  "pending": "string"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/age-gate',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      pending: 'string',
    }),
  }
);
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/age-gate",
    json={
        "pending": "string",
    },
    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"
}

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
}