Skip to content

Get cardholder passkey registration options

POST/v1/cardholders/{id}/passkeys/options

Requires an API client bearer token.

Mints WebAuthn PublicKeyCredentialCreationOptions bound to the cardholder's programme relying party, and a single-use enrolment challenge. `origin` must be in the programme's passkey origin allow-list.

Parameters

Path parameters

NameRequiredDescription
idrequired

Request body

originstring (uri)required

Example

curl -X POST https://api.rigid.fi/v1/cardholders/{id}/passkeys/options \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "origin": "uri"
}'

Responses

200

Registration options and a challenge id to pass back to the register route.

challengeIdstringrequired
optionsobjectrequired
+ show properties

No properties.

400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Cardholder not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring