Skip to main content
POST
/
{tenant_id}
/
mfa
/
registration
/
initialize
Start MFA Registration
curl --request POST \
  --url https://passkeys.hanko.io/{tenant_id}/mfa/registration/initialize \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <apikey>' \
  --data '
{
  "user_id": "<string>",
  "username": "<string>",
  "icon": "<string>",
  "display_name": "<string>"
}
'
{
  "publicKey": {
    "rp": {
      "name": "<string>",
      "id": "<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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hanko.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
apiKey
string
required

Secret API key

Minimum string length: 32

Path Parameters

​
tenant_id
string
required

Tenant ID

Body

application/json
​
user_id
string
required
​
username
string
required
Maximum string length: 128
​
icon
string
​
display_name
string
Maximum string length: 128

Response

Example response

​
publicKey
object
required