Add a passkey
POST
/cms/customer/passkey/register
const url = 'https://api.example.com/cms/customer/passkey/register';const options = { method: 'POST', headers: { 'API-Key': '<API-Key>', Authorization: 'Bearer <token>', Token: '<Token>', 'Content-Type': 'application/json' }, body: '{"challenge_id":"example","credential":{},"name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.com/cms/customer/passkey/register \ --header 'API-Key: <API-Key>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Token: <Token>' \ --data '{ "challenge_id": "example", "credential": {}, "name": "example" }'Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
challenge_id
required
From /cms/customer/passkey/register/options
string
credential
required
Result of navigator.credentials.create() / startRegistration(), as an object or a JSON string
object
name
Name for the passkey, e.g. the device (optional, max 100 characters)
string
Example generated
{ "challenge_id": "example", "credential": {}, "name": "example"}Responses
Section titled “Responses”The added passkey
Media typeapplication/json
Passkey
A passkey registered on a customer account. Never includes key material.
object
id
Passkey ID
integer format: int64
name
Name the customer gave it (e.g. “iPhone”); null when not named
string
created
When it was added, MySQL datetime (Y-m-d H:i:s)
string
lastUsed
When it was last used to log in, MySQL datetime; null when never used
string
lastUsedCountry
Country code of the last login with it, when known
string
Example
{ "created": "2026-11-17 10:12:00", "lastUsedCountry": "NL"}CHALLENGE_INVALID, PASSKEY_INVALID, PASSKEY_ALREADY_REGISTERED or PASSKEY_LIMIT_REACHED
Not logged in