ICHRAX Developer Portal
  • Documentation
  • API Reference
IchraxCoverage
    Get a subscriber's current coverageget
IchraxMemberSnapshots
    Ingest member snapshotspostPoll snapshot processing statusgetDry-run member snapshotspost
VendorCapabilities
    Get vendor capabilitiesget
Schemas
ICHRAX External ICHRAX API
ICHRAX External ICHRAX API

IchraxCoverage

Coverage integration. Exposes the coverage a subscriber's family holds on a given date, as recorded from successful submissions.


Get a subscriber's current coverage

GET
https://api.ichraxdev.com
/api-integrations/ichrax/v1/coverage/{partner_individual_id}

Returns the coverage a subscriber's family holds on a date, grouped by plan, as recorded from successful submissions. The path id must be the subscriber's partner_individual_id; a dependent's id returns 404. as_of defaults to today. A subscriber with recorded coverage that has all ended before as_of returns 200 with an empty coverages array; a subscriber with no recorded coverage at all returns 404.

Get a subscriber's current coverage › path Parameters

partner_individual_id
​string · required

Get a subscriber's current coverage › query Parameters

as_of
​string · date

Get a subscriber's current coverage › Headers

x-api-key
​string · required

The x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get a subscriber's current coverage › Responses

OK

The coverage a subscriber's family holds on a given date, grouped by plan.
Ichrax.API.SubscriberCoverage
partner_individual_id
​null | string

The subscriber's partner_individual_id, as supplied in the request path.

as_of
​string · date

The date the coverage was evaluated on. Defaults to today when the request omits as_of.

​null | array

One entry per plan the family is covered under on as_of. Empty when no coverage is in force on that date.

GET/api-integrations/ichrax/v1/coverage/{partner_individual_id}
curl https://api.ichraxdev.com/api-integrations/ichrax/v1/coverage/:partner_individual_id \ --header 'x-api-key: <string>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "partner_individual_id": "partner_individual_id", "as_of": "2024-08-25", "coverages": [ { "internal_company_id": "internal_company_id", "carrier_id": "carrier_id", "plan_hios_id": "plan_hios_id", "plan_year": 0, "members": [ { "partner_individual_id": "partner_individual_id", "relationship": "subscriber", "effective_date": "2024-08-25", "end_date": "2024-08-25" } ] } ] }
text

IchraxMemberSnapshots