1. Docs
  2. API Reference
  3. Get MFA enrollment summary for an identity

Get MFA enrollment summary for an identity

GET/api/v1/identities/{id}/mfa

Returns an identity's MFA enrollment summary — enrolled factors and recovery-code state — as a server-to-server admin read. MFA factors are a single set per identity across the Account; access is gated by an Environment-scoped membership check. Secret material is redacted in the response. Returns 404 when the identity has no membership in this Environment.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

  • dataAccountIdentityMfaResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AccountIdentityMfaResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identities/value/mfa" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "factors": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "totp",
        "label": "iPhone 15",
        "enrolled_at": "2026-04-20T12:00:00.000Z",
        "last_used_at": "2026-04-20T12:00:00.000Z",
        "webauthn_rp_id": "acme.com"
      }
    ],
    "recovery_codes_generation": 0,
    "recovery_codes_remaining": 0,
    "mfa_admin_reset_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
GETGet Application identities summary
POSTBulk-create identities
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTSet an identity's password (admin)
POSTForce a password reset for an identity (admin)
GETList an identity's active sessions (admin)
DELETERevoke one of an identity's sessions (admin)
POSTRevoke all of an identity's sessions (admin)
POSTForce-reset an identity's MFA — admin recovery action
GETRead an identity's auth state for backend decisioning
POSTMark an identity's email verified (admin)
GETGet identity's role assignments
GETGet identity's effective permissions
GETGet where an identity may act with one permission
GETGet where an identity holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy