1. Docs
  2. API Reference
  3. OAuth hosted login: verify MFA enrollment

OAuth hosted login: verify MFA enrollment

POST/oauth/mfa-enroll-verify

Verifies the 6-digit TOTP code from the hosted MFA enrollment page against the enrollment_token. On success it renders the one-shot recovery-codes page (whose acknowledgement step mints the authorization code); on failure it restarts the enrollment and re-renders the enroll page with a fresh otpauth URI and the error. Throttled to 10 requests per minute.

Request body

application/json

enrollment_tokenstring Required
codestring Required
labelstring Required
client_idstring Required
redirect_uristring Required
response_typestring Required
scopestring Required
statestring Optional
code_challengestring Required
code_challenge_methodstring Required
noncestring Optional

Responses

text/html

string

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Rate limit

10 requests per 1mPer 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
Request
curl -X POST "https://auth.canopy-io.com/oauth/mfa-enroll-verify" \
  -H "Content-Type: application/json" \
  -d '{
    "enrollment_token": "string",
    "code": "string",
    "label": "string",
    "client_id": "string",
    "redirect_uri": "string",
    "response_type": "string",
    "scope": "string",
    "state": "string",
    "code_challenge": "string",
    "code_challenge_method": "string",
    "nonce": "string"
  }'
Response
Content-Type: text/html

<!doctype html>
<html lang="en">
  <head>…</head>
  <body>
    <!-- The hosted page: its form, any error, and the Environment's branding -->
  </body>
</html>
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy