Users & Identity

Core operations for managing user profiles, identity verification, and account-level preferences. Users & Identity provides the foundation for managing participant records, identity validation, and user-level configurations across WEX platforms. It enables developers to create and maintain user profiles, verify identity and banking details, and manage communication preferences. Use this resource to onboard users, ensure compliance through verification workflows, and maintain accurate, up-to-date identity and account data that supports downstream benefits and financial operations.

Core Identity Services

Identity & Person Management API

This suite serves as the central repository for unified identity data, providing a single view of all individuals within the platform, including Consumers, Dependents, Authorized Signers, and Business Contacts.

• Unified Identity Resolver: Resolve any unique person_id into a name, role type, and business association to facilitate cross-entity routing.

• Family & Delegation Mapping: Establish a “Household View” by anchoring dependents and account delegates to primary consumers.

• On-Demand Data Expansion: Optimize performance by selectively retrieving secondary data blocks such as addresses, employment records, or protected personal data.

• Identity Hierarchy: Consumers are anchored to a Business (Employer), while their respective dependents and signers are anchored directly to the Consumer.

Notification Preferences API

Manage how and why consumers receive communications through a comprehensive two-tier preference model.

• Internal Triggers: Manage core event triggers—such as enrollment success or claim denials—that determine if an alert is generated.

• External Delivery: Control the delivery channels—Email, SMS, or Push—used to send generated alerts to the consumer.

• Hierarchy of Choice: The system follows a gatekeeping flow, checking if a trigger is enabled internally before validating if the external delivery channel and category opt-ins are active.

• Master Switches: Utilize global toggles to enable or disable entire communication mediums across the platform.

Organizational Foundations

Administrators API

The foundational step in setting up a new domain by establishing the root business entity.

• Hierarchical Anchor: Represents TPAs or large corporate entities that oversee all downstream employers and plans.

• Safe Provisioning: Mandatory idempotency ensures that only one Administrator entity is created per unique key during onboarding.

Business Management API

Manages the operational tiers of the hierarchy, including Employers, Divisions, and Departments.

• Multi-Tenant Hierarchy: Supports deeply nested parent-child relationships for complex corporate structures.

• Lineage Awareness: Specialized tools to “walk” up the organizational tree from child nodes to the root Administrator.

Integration Standards

Security & Privacy Controls

Managing sensitive data requires rigorous compliance and visibility settings:

Scopes & Permissions

Global Error Reference