Skip to content
BuildBase
HTTP API menu

Start setting up an authenticator app during a sign-in that requires it

No router-level gate; the pending sign-in's mfaToken is the credential.

POST/api/v1/auth/mfa/totp/enroll

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.

No router-level gate; the pending sign-in's mfaToken is the credential. Only for a sign-in that must enroll a second step first (400 otherwise). Answers the new secret, its otpauth URL and a QR code.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
mfaTokenstringYes40 to 40 characters-

Example request

Replace each YOUR_... value with your own.

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

Responses

200 OK

OK

Example
{
  "data": {
    "otpauthUrl": "otpauth://totp/Updated%20Auth%20Config:e2e-mfa-register-1767225600000%40test.example.com?secret=[REDACTED]&issuer=Updated%20Auth%20Config",
    "qrSvg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 51 51\" shape-rendering=\"crispEdges\"><path fill=\"#ffffff\" d=\"M0 0h51v51H0z\"/><path stroke=\"#000000\" d=\"M1 1.5h7m1 0h2m3 0h1m1 0h4m3 0h4m1 0h2m2 0h1m3 0h2m3 0h1m1 0h7M1 2.5h1m5 0h1m1 0h6m3 0h1m2 0h1m3 0h3m4 0h2m5 0h3m1 0h1m5 0h1M1 3.5h1m1 0h3m1 0h1m1 0h4m2 0h1m3 0h2m2 0h3m3 0h5m1 0h2m1 0h1m1 0h2m1 0h1m1 0h3m1 0h1M1 4.5h1m1 0h3m1 0h1m3 0h1m1 0h3m4 0h5m2 0h3m1 0h6m1 0h1m1 0h1m2 0h1m1 0h3m1 0h1M1 5.5h1m1 0h3m1 0h1m1 0h1m3 0h2m3 0h2m1 0h1m1 0h6m1 0h",
    "secret": "[REDACTED]"
  },
  "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"
}

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
}