Skip to main content
POST
Get membership status
The lookup accepts only hhaexchange as external_system and requires a nonempty external_id. It accepts no other request properties and has no company or organization parameter. Invalid input returns 400 invalid_request; a body over 16 KiB returns 413 payload_too_large. The response contains exactly three booleans, without an envelope or identifiers. enrolled requires effective Rima coverage plus a linked company membership or a pending, unexpired invitation for the covered employee. opted_out is true only when every applicable participation is effectively opted out. No authorized identity match returns all three values as false. Multiple authorized matches return 409 ambiguous_identifier unless they share one non-null Person ID, including when linked and unlinked records match. Service failures return 500 internal_error rather than false booleans.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

JSON request body. Bodies over 16 KiB return 413 payload_too_large.

external_system
enum<string>
required

Exact supported system name.

Available options:
hhaexchange
external_id
string
required

Opaque ID in that system.

Minimum string length: 1

Response

App access result.

enrolled
boolean
required

True when an employee has effective Rima coverage and either a linked company membership or a pending, unexpired invitation for that covered employee.

registered
boolean
required

Existing app account, independent of enrollment.

opted_out
boolean
required

True when every applicable participation is effectively opted out; false when none exists.