Accounts and verification

Reference data, identity-verification monitoring, requirement monitors, Person sign-in flows, Account hierarchy and settings, and Person-side lists in the Wingspan V3 API.

This section covers the account, onboarding, and verification calls that the task-based guides in other sections don't walk through. Each page lists the endpoints, the request fields, one worked example, and the errors the API returns.

  1. Onboarding reference data: list supported locations, MCC codes, and occupations.
  2. Identity verification checks: cancel a verification and read its per-check results.
  3. Identity verification monitors and alerts: subscribe a subject to ongoing screening and review the alerts.
  4. Requirement monitors: watch, renew, pause, and cancel the lifecycle of a requirement.
  5. Requirement definition groups: read, update, and delete groups, and manage their items.
  6. Person invites and sign-in: invite a Person, redeem the invite, and handle email, phone, and password changes.
  7. Stakeholder invitations: list pending teammate invitations and accept one.
  8. Account hierarchy and settings: navigate the tree, read the parent link, entitlements, settings, and eligibility, and change an entity type.
  9. Paystubs and benefit enrollments: list paystubs and benefit enrollments for an Account or a Person.
  10. Forms received: list the tax forms issued to a Person or an Account.
  11. Person identity verifications and MFA factors: read a Person's verifications and enrolled factors.
  12. Requirement definitions: create, update, archive, and delete requirement templates.
  13. Transfer a principal and move an Account: change an Account's Principal or parent.

Related sections: Payees and onboarding and Organizations and embedding.


Did this page help you?