Skip to main content
POST
Get membership status
Send the exact supported external_system name and an external_ids array of {type, value} identifiers. Include each required type once, in any order, with a nonblank value. System and type names are case-sensitive. The response contains exactly three booleans. enrolled is true when the matched employee has a linked company membership or a pending, unexpired linked invitation. registered is true when that employee has a linked app account. opted_out is true when that employee has an effective opt-out in their company’s active plan program. If no matching employee is found in an authorized company, the response returns false for enrolled, registered, and opted_out. Multiple matching employees return 409 ambiguous_identifier, even when they share a Person ID. Unsupported names, missing or duplicate identifiers, malformed values, and extra properties return 400 invalid_request. A body over 16 KiB returns 413 payload_too_large. 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
external_system
string
required

Exact supported external system name.

Minimum string length: 1
external_ids
object[]
required

Provide the complete identifier set required by the external system. Include each type once, in any order.

Response

App access result.

enrolled
boolean
required

True when a matched employee has a linked company membership or a pending, unexpired linked invitation.

registered
boolean
required

Existing Ignite account, independent of enrollment.

opted_out
boolean
required

True when the matched employee has an effective opt-out in their company's active plan program.