# Start registering a passkey for the signed-in user

Requires the user's login token.

`POST /api/v1/auth/passkey/register/options`

- Sign-in: A login token from hosted sign-in as a Bearer token, and the organization in the 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 30 requests a minute per IP address.
- Request body: None: send the request without a body.

Requires the user's login token. Answers WebAuthn registration options and an `optionsId`. Answers 409 for a guest account, and 403 when the person's company rules refuse the enrolment or the account already holds the most passkeys it can.

## Request

This operation takes no parameters and no body.

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/auth/passkey/register/options?org=YOUR_ORG_ID" \
  -H "Authorization: Bearer $BUILDBASE_LOGIN_TOKEN"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/passkey/register/options?org=YOUR_ORG_ID',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.BUILDBASE_LOGIN_TOKEN}`,
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/auth/passkey/register/options?org=YOUR_ORG_ID",
    headers={
        "Authorization": "Bearer " + os.environ["BUILDBASE_LOGIN_TOKEN"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "options": {
    "attestation": "none",
    "authenticatorSelection": {
      "requireResidentKey": false,
      "residentKey": "[REDACTED]",
      "userVerification": "preferred"
    },
    "challenge": "NK9ZdMcDW4i81ScOdKzhk5njcsF1AsY8JK60-bu8FXE",
    "excludeCredentials": [
      {
        "id": "ekTOcArLyf-a3XEbAiR4jXk5eCEwTR5oADA8PpzRaes",
        "transports": ["internal"],
        "type": "public-key"
      }
    ],
    "extensions": {
      "credProps": true
    },
    "hints": [],
    "pubKeyCredParams": [
      {
        "alg": 0,
        "type": "[REDACTED]"
      },
      {
        "alg": 0,
        "type": "[REDACTED]"
      },
      {
        "alg": 0,
        "type": "[REDACTED]"
      }
    ],
    "rp": {
      "id": "localhost",
      "name": "update.e2e-example.com"
    },
    "timeout": 60000,
    "user": {
      "displayName": "Passkey Person · update.e2e-example.com",
      "id": "NmFmNDE2NGFiZjBkMmUzM2E5ODRlMmJm",
      "name": "user@example.com · update.e2e-example.com"
    }
  },
  "optionsId": "xEdeaZyqpg0kWc5aPghUll7BRESV4jQ2GvFkoeTf"
}
```

### 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.

```json title="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.

```text title="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.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Auth guide](/authentication/overview): how this part of BuildBase works
- [All Auth operations](/http-api/reference/auth)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `auth.passkey.register.options.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
