Skip to content
BuildBase
HTTP API menu

Verify a second-step code and finish the pending sign-in

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

POST/api/v1/auth/mfa/verify

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. Accepts an authenticator or backup code, or a text-message code. A wrong code answers 400 and emits auth.login_failed; too many wrong codes answer 429 (account locked) or 401 (sign-in expired).

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
mfaTokenstringYes40 to 40 characters-
codestringYes4 to 20 characters-
factorstringNoone of "sms"-

Example request

Replace each YOUR_... value with your own.

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

Responses

200 OK

OK

Example
{
  "backupCodesRemaining": 9,
  "data": {
    "deviceToken": "[REDACTED]",
    "token": "[REDACTED]",
    "user": {
      "name": "Session User mfa-backup",
      "role": "user"
    }
  },
  "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
}

Events

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