Signup
Start Passkey Registration
Signup
Start Passkey Registration
Initialize a registration for webauthn credentials
POST
https://passkeys.hanko.io
/
{tenant_id}
/
registration
/
initialize
host
string
host
string
path_prefix
string
path_prefix
string
apiKey
string
*
apiKey
Required
string
Secret API key
tenant_id
string
*
tenant_id
Required
string
UUID of the tenant
Add Example Value
object
user_id
string
*
user_id
Required
string
username
string
*
username
Required
string
icon
string
icon
string
display_name
string
display_name
string
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>",
"icon": "<string>"
},
"user": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"icon": "<string>"
},
"challenge": "<string>",
"pubKeyCredParams": [
{
"type": "<string>",
"alg": 123
}
],
"timeout": 123,
"excludeCredentials": [
{
"type": "<string>",
"id": "<string>",
"transports": [
"<string>"
]
}
],
"authenticatorSelection": {
"authenticatorAttachement": "<string>",
"requireResidentKey": true,
"residentKey": "<string>",
"userVerification": "<string>"
},
"attestation": "<string>",
"extensions": [
{}
]
}
}
Headers
apiKey
string
requiredSecret API key
Path Parameters
tenant_id
string
requiredUUID of the tenant
Body
application/json
user_id
string
requiredusername
string
requiredicon
string | null
display_name
string | null
Response
200 - application/json
publicKey
object
requiredpublicKey.rp
object
requiredpublicKey.rp.id
string
requiredpublicKey.rp.name
string
requiredpublicKey.rp.icon
string | null
publicKey.user
object
requiredpublicKey.user.id
string
requiredpublicKey.user.displayName
string | null
publicKey.user.name
string
requiredpublicKey.user.icon
string | null
publicKey.challenge
string
requiredpublicKey.pubKeyCredParams
object[] | null
publicKey.pubKeyCredParams.type
string
requiredpublicKey.pubKeyCredParams.alg
integer
requiredpublicKey.timeout
integer | null
publicKey.excludeCredentials
object[] | null
publicKey.excludeCredentials.type
string
requiredpublicKey.excludeCredentials.id
string
requiredpublicKey.excludeCredentials.transports
string[] | null
publicKey.authenticatorSelection
object
publicKey.authenticatorSelection.authenticatorAttachement
string | null
publicKey.authenticatorSelection.requireResidentKey
boolean | null
default: falsepublicKey.authenticatorSelection.residentKey
string | null
publicKey.authenticatorSelection.userVerification
string | null
publicKey.attestation
string
publicKey.extensions
object[]
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>",
"icon": "<string>"
},
"user": {
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"icon": "<string>"
},
"challenge": "<string>",
"pubKeyCredParams": [
{
"type": "<string>",
"alg": 123
}
],
"timeout": 123,
"excludeCredentials": [
{
"type": "<string>",
"id": "<string>",
"transports": [
"<string>"
]
}
],
"authenticatorSelection": {
"authenticatorAttachement": "<string>",
"requireResidentKey": true,
"residentKey": "<string>",
"userVerification": "<string>"
},
"attestation": "<string>",
"extensions": [
{}
]
}
}