Person
Overview
The Person API centralizes the management of consumer, dependent, and beneficiary information, ensuring accurate and consistent person-level data across systems. It enables users to create, update, and retrieve detailed profiles, serving as a reliable foundation for downstream processes and integrations.
Why use the API?
- Provides a single place to manage person data.
- Ensures consistency of consumer and dependent information across systems.
- Enables other APIs to access accurate person details.
What can the API do?
- Retrieve person details (consumer, dependent, beneficiary).
- Create or update person information.
Key Features
- Support for multiple person types (consumer, dependent, beneficiary).
- Standardized data management.
- Seamless integration with Identity and Claims APIs.
Person API Operations
The Person API is divided into the following subsections. Select the API Reference tab to find functional information about each subsection and corresponding operations.
- Consumers
Endpoints
/v1/authorized-signers?consumer_id=consumer_id&expand=expand&ssn_mode=MASKED
/v1/consumers/{consumer_id}?expand=expand&ssn_mode=MASKED
/v1/consumers/lookup?page_size=12345&page=12345
/v1/dependents?consumer_id=consumer_id&expand=expand&ssn_mode=MASKED
/v1/employee-groups?page=0&page_size=20&status=ACTIVE&employer_account_id=employer_account...
/v1/employee-groups/{id}
/v1/employee-groups/{id}/plan-visibility
/v1/employee-groups/{id}/membership-rules
/v1/employee-groups/{id}/membership-rules/evaluate?page=0&page_size=20
/v1/employee-groups
/v1/employee-groups/{id}/membership-rules
/v1/employee-groups/{id}
/v1/employee-groups/{id}
/v1/employees/{id}?expand=expand
/v1/employees
/v1/employees/searches
/v1/employees/{id}
/v1/employees/{id}
/v1/employees/{id}
/v1/persons/{person_id}