Person identity verifications and MFA factors

Read a Person's identity verifications and enrolled MFA factors with the Wingspan V3 API.

Two Person-scoped lists give a signed-in human a read view of their own verification records and sign-in factors. They're read-only mirrors. Create and change these records on the resource's own endpoints.

Prerequisites

  • A Person session for the Person in the path.
  • Don't send X-Wingspan-Account. Both calls are Person-scoped, and the header returns 400 AccountScopeNotApplicable.

Endpoints

Method and pathOperation
GET /v3/platform/persons/{personId}/identity-verificationslistPersonIdentityVerifications
GET /v3/platform/persons/{personId}/mfa-factorslistPersonMfaFactors

Both take page[size] and page[token].

Identity verifications

The list returns identity verification records where the Person is the subject. Each row carries accountId or personId for its owner. Create a verification, resume it, cancel it, and read its checks on /v3/onboarding/identity-verifications. See Identity verification and Identity verification checks.

curl "https://api.wingspan.app/v3/platform/persons/$PERSON_ID/identity-verifications" \
  -H "Authorization: Bearer $WINGSPAN_TOKEN"

MFA factors

The list returns the factors enrolled for the Person. It needs a session-backed bearer token. An API key can't list factors.

FieldMeaning
id, personIdThe factor id and its owner.
typeTotp, Sms, or Email.
statusPendingVerification, Active, or Disabled.
labelThe display label.
events, actors, metadataTimestamps, who acted, and your metadata.

Enroll, verify, and delete factors on /v3/platform/mfa-factors. See Environments and authentication for the step-up flow.

curl "https://api.wingspan.app/v3/platform/persons/$PERSON_ID/mfa-factors" \
  -H "Authorization: Bearer $WINGSPAN_TOKEN"

Errors

StatusWhen
400X-Wingspan-Account was sent, or a parameter is malformed.
401No valid credential.
403The caller can't read this Person's records.
404The Person isn't visible to the caller.

Related pages


Did this page help you?