1. Docs
  2. API Reference
  3. Get passkey creation options to complete a sign-in that required a factor

Get passkey creation options to complete a sign-in that required a factor

POST/v1/auth/login/mfa-enroll/webauthn/options

For a sign-in that answered requires_mfa_enrollment: returns navigator.credentials.create() options under Canopy's relying party and a fresh enrollment token carrying the nonce and the interrupted sign-in. 401 for a token that is missing, expired or tampered. Rate-limited to 10 requests per 10 minutes.

Request body

application/json

enrollment_tokenstring Required

The sealed enrollment_token from the sign-in's `mfa_enrollment` continuation.

Responses

application/json

  • dataMfaWebAuthnEnrollOptionsResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Rate limit

10 requests per 10mPer caller: the signed-in user for a bearer token; for an API key, the key and the end user's address when a backend forwards it, otherwise the client address

Returned object

MfaWebAuthnEnrollOptionsResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/login/mfa-enroll/webauthn/options" \
  -H "Content-Type: application/json" \
  -d '{
    "enrollment_token": "string"
  }'
Response
{
  "data": {
    "enrollment_token": "string",
    "options": {}
  }
}
 Related endpoints
POSTAnswer the sign-in challenge with an authenticator app code
POSTAnswer the sign-in challenge with a recovery code
POSTGet passkey assertion options for the sign-in challenge
POSTAnswer the sign-in challenge with a passkey
POSTEnroll an authenticator app to complete a sign-in that required one
POSTEnroll a passkey to complete a sign-in that required a factor
 Was this page helpful?

Tell us how we can improve this guide.

Canopy