Skip to main content
POST
Get membership status
Coming soon — unavailable in sandbox and production. The code sample uses the current Partner API host for illustration; the final hostname and contract are undecided. Do not send requests to this route. The lookup would use one external_system and external_id pair without a company or organization parameter. It would return exactly three booleans, without an envelope or identifiers. No authorized identity match would return all three values as false. Matches resolving to different people would return HTTP 409 rather than combining their statuses. Service failures would return a non-2xx response rather than false booleans. The exact enrollment-state mapping, the proposed rule across multiple employments, and opt-out aggregation across different participation decisions remain undecided.

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 system name.

external_id
string
required

Opaque ID in that system.

Response

Proposed app access result.

enrolled
boolean
required

Effective enrollment; exact state mapping pending.

registered
boolean
required

Existing app account, independent of enrollment.

opted_out
boolean
required

Effective opt-out; aggregation across employments pending.