Signup
Start Passkey Registration
Getting Started
Integrations
Resources
API Reference
- Signup
- Login
- Credentials
- Transactions
- MFA
- GETWell-known JWKS
Signup
Start Passkey Registration
Initialize a registration for webauthn credentials
POST
/
{tenant_id}
/
registration
/
initialize
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
Secret API key
Minimum length:
32
Path Parameters
UUID of the tenant
Required string length:
36
Body
application/json
Maximum length:
128
Maximum length:
128
Response
200
application/json
Example response
Available options:
cross-platform
, platform
Available options:
discouraged
, preferred
, required
Available options:
discouraged
, preferred
, required
Available options:
direct
, enterprise
, indirect
, none
Was this page helpful?
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
}
}
}