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

VendorCapabilities

Vendor capabilities. Exposes the vendors enabled for the calling trading partner, their enrollment constraints, and the carrier_specific_config schema for each vendor.


Get vendor capabilities

GET
https://api.ichraxdev.com
/api-integrations/ichrax/v1/vendor-capabilities

Returns the vendors enabled for this trading partner, their active enrollment constraints, and the JSON schema for the carrier_specific_config field required in snapshot submissions.

Get vendor capabilities › 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 vendor capabilities › Responses

OK

​Ichrax.API.VendorCapabilityDto[]
Ichrax.API.VendorCapabilityDto
familyKey
​null | string

Stable family key (e.g. "anthem", "kaiser"). Use this when correlating across capability matrices and snapshot submissions.

displayName
​null | string

Human-friendly family name for display.

​null | array

Per-plan-year capabilities. Most recent plan year first. The matrix resolution rule is most-recent-≤-N: a snapshot for plan year 2027 resolves against the highest registered plan year that is ≤ 2027.

​null | array

Carrier registries (HIOS IDs etc.) the trading partner is configured to submit to under this family.

GET/api-integrations/ichrax/v1/vendor-capabilities
curl https://api.ichraxdev.com/api-integrations/ichrax/v1/vendor-capabilities \ --header 'x-api-key: <string>' \ --header 'Authorization: Bearer <token>'
Example Responses
[ { "familyKey": "familyKey", "displayName": "displayName", "planYears": [ { "planYear": 0, "contractSchema": null, "contractRules": [ { "appliesTo": { "stateCodes": [ "string" ], "vendorRegistries": [ "string" ] }, "description": "description", "rules": [ { "propertyPath": "propertyPath", "ruleKind": "ruleKind", "description": "description", "detail": "detail" } ] } ], "constraints": [ { "appliesTo": { "stateCodes": [ "string" ], "vendorRegistries": [ "string" ] }, "rules": [ { "eventReasons": [ "open_enrollment" ], "actions": [ { "action": "Enroll", "dateConstraints": [ { "field": "QualifyingEventDate" } ] } ] } ] } ], "routableChangeTypes": [ { "appliesTo": { "stateCodes": [ "string" ], "vendorRegistries": [ "string" ] }, "changeTypes": [ "Enroll" ] } ] } ], "registries": [ { "carrierId": "carrierId", "vendorKey": "vendorKey", "stateCode": "stateCode", "transmissionType": "transmissionType" } ] } ]
text

IchraxMemberSnapshots