POST
/
{tenant_id}
/
registration
/
initialize
Start Passkey Registration
curl --request POST \
  --url https://passkeys.hanko.io/{tenant_id}/registration/initialize \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <apikey>' \
  --data '{
  "user_id": "<string>",
  "username": "<string>",
  "icon": "<string>",
  "display_name": "<string>"
}'
{
  "publicKey": {
    "rp": {
      "id": "<string>",
      "name": "<string>"
    },
    "user": {
      "id": "<string>",
      "displayName": "<string>",
      "name": "<string>"
    },
    "challenge": "<string>",
    "pubKeyCredParams": [
      {
        "type": "public-key",
        "alg": 123
      }
    ],
    "timeout": 123,
    "excludeCredentials": [
      {
        "type": "public-key",
        "id": "<string>",
        "transports": [
          "ble"
        ]
      }
    ],
    "authenticatorSelection": {
      "authenticatorAttachement": "cross-platform",
      "requireResidentKey": false,
      "residentKey": "discouraged",
      "userVerification": "discouraged"
    },
    "attestation": "direct",
    "extensions": {
      "appid": "<string>",
      "appidExclude": "<string>",
      "credProps": true
    }
  }
}

Headers

​
apiKey
string
required

Secret API key

Minimum length: 32

Path Parameters

​
tenant_id
string<uuid>
required

UUID of the tenant

Required string length: 36
Example:
["1f496bcd-49da-4839-a02f-7ce681ccb488"]

Body

application/json

The body is of type object.

Response

Example response

The response is of type object.