---
title: "Start passkey registration"
method: POST
path: "/api/auth/passkeys/register/options"
tags: ["Authentication"]
---

# Start passkey registration

`POST /api/auth/passkeys/register/options`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/auth/passkeys/register/options`
- Auth: API key in cookie `gc-session`

Creates WebAuthn registration options for this account.

## Response `200`

Response for status 200

- object
  - `challenge` string, required
  - `rp` object, required
    - `id` string, required
    - `name` string, required
  - `user` object, required
    - `id` string, required
    - `name` string, required
    - `displayName` string, required
  - `pubKeyCredParams` object[], required
    - `type` 'public-key', required
    - `alg` -7 | -257, required
  - `timeout` number, required
  - `excludeCredentials` object[], required
    - `id` string, required
    - `type` 'public-key', required
    - `transports` string[]
  - `attestation` 'none', required
  - `authenticatorSelection` object, required
    - `residentKey` 'required', required
    - `requireResidentKey` true
    - `userVerification` 'required', required
  - `extensions` object
    - `credProps` boolean

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)