ICHRAX Developer Portal
  • Documentation
  • API Reference
IchraxMemberSnapshots
    Ingest member snapshotspostPoll snapshot processing statusgetDry-run member snapshotspost
VendorCapabilities
    Get vendor capabilitiesget
Schemas
ICHRAX External ICHRAX API
ICHRAX External ICHRAX API

IchraxMemberSnapshots

Endpointhttps://api.ichraxdev.com

Member Snapshots integration. Exposes endpoints for submitting member enrollment snapshots and polling the processing job status.


Ingest member snapshots

POST
https://api.ichraxdev.com
/api-integrations/ichrax/v1/member-snapshots

Accepts a trading partner member snapshot batch and returns a snapshot identifier.

Ingest member snapshots › 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.

Ingest member snapshots › Request Body

​object[]
Inbound member snapshot item accepted by the enrollment integration endpoint.
​object · required

Company payload. Identifies the company the enrollment belongs to.

enrollment_action
​string · enum · minLength: 1 · required

Enrollment action type (new_enrollment, change, or termination).

Enum values:
new_enrollment
change
termination
​object · required

Employee payload.

​object · required

Coverage payload.

​object

Managing third party payload. Identifies the party that collected and manages the enrollment when it is not the submitting trading partner.

​null | array

Optional dependents payload array.

​null | array

Optional events payload array.

Ingest member snapshots › Responses

OK

Outbound member snapshot response returned after ingestion.
snapshot_id
​string · uuid

External snapshot identifier for status polling.

​null | array

Per-item results for all submitted items.

POST/api-integrations/ichrax/v1/member-snapshots
curl --request POST \
  --url https://api.ichraxdev.com/api-integrations/ichrax/v1/member-snapshots \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
[
  {
    "company": {
      "partner_company_id": "partner_company_id",
      "name": {},
      "tin": {}
    },
    "managing_third_party": {
      "partner_managing_third_party_id": {},
      "name": {},
      "tin": {},
      "email": {},
      "phone": {}
    },
    "enrollment_action": "new_enrollment",
    "employee": {
      "person": {
        "partner_individual_id": "partner_individual_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "middle_name": {},
        "suffix": {},
        "date_of_birth": "date_of_birth",
        "sex": "F",
        "ssn": {},
        "marital_status": "single",
        "home_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "mailing_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "contact": {
          "email": {},
          "phone": {},
          "preferred_language": "en",
          "preferred_method": {}
        },
        "details": {
          "tobacco": {
            "user": true,
            "duration": {}
          },
          "disability": {
            "disabled": {},
            "hearing_impaired": {},
            "visually_impaired": {},
            "speech_impaired": {}
          },
          "is_military": {},
          "is_student": {}
        }
      },
      "employment": {
        "employment_status": "full-time",
        "occupation": {},
        "employment_dates": {
          "hire_date": "2024-08-25",
          "full_time_start": "2024-08-25",
          "rehire": "2024-08-25",
          "retirement": "2024-08-25",
          "terminated": "2024-08-25"
        },
        "salary": {
          "amount": {},
          "type": "hourly",
          "unit": {},
          "effective_date": "2024-08-25"
        }
      }
    },
    "dependents": {},
    "coverage": {
      "carrier_id": "carrier_id",
      "plan_hios_id": "plan_hios_id",
      "plan_type": "hmo",
      "metal_level": "bronze",
      "carrier_specific_config": {
        "electronic_communication_consent": {},
        "pediatric_dental_purchased": {},
        "donate_life_registry": {},
        "communication_impairment": {},
        "communication_impairment_format": {},
        "communication_impairment_format_other": {},
        "other_health_coverage_disability": {},
        "employer_premium_reimbursement": {},
        "employer_health_benefit_plan": {},
        "employer_health_reimbursement": {},
        "establish_hsa": {},
        "current_coverage_is_anthem": {},
        "have_disabled_dependent": {},
        "agent_tin": {},
        "agency_tin": {},
        "is_agent_assisted": {},
        "is_not_read_english": {},
        "is_not_speak_english": {},
        "is_not_write_english": {},
        "is_limited_english": {},
        "is_agree_to_electronic_signature": {},
        "is_read_completed_app": {},
        "is_agree_to_mem_communication": {},
        "is_read_understand_enroll_form": {},
        "members": {}
      },
      "coverage_members": [
        {
          "partner_individual_id": "partner_individual_id",
          "action": "enroll",
          "effective_start_date": "2024-08-25",
          "effective_end_date": "2024-08-25",
          "event_id": {},
          "pcp_details": {
            "first_name": {},
            "last_name": {},
            "npi": {},
            "carrier_id": {},
            "is_existing_patient": {}
          },
          "prior_coverage": {
            "insurer_name": {},
            "policy_type": "group",
            "policy_number": {},
            "group_number": {},
            "coverage_start_date": "2024-08-25",
            "coverage_end_date": "2024-08-25",
            "term_with_new_policy": {}
          }
        }
      ],
      "agent": {
        "first_name": {},
        "last_name": {},
        "address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "npn": {},
        "phone": {},
        "email_address": {}
      },
      "agency": {
        "tin": {},
        "name": {},
        "address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "phone": {},
        "email": {}
      },
      "payment": {
        "monthly_premium": {},
        "monthly_employer_contribution_amount": {},
        "billing_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "credit_card": {
          "card_type": "visa",
          "card_holder_name": {},
          "card_number": {},
          "expiration_date": {},
          "security_code": {}
        },
        "bank_account": {
          "account_type": "checking",
          "account_holder_name": {},
          "routing_number": {},
          "account_number": {}
        }
      }
    },
    "events": {}
  }
]
'
shell
Example Request Body
[
  {
    "company": {
      "partner_company_id": "partner_company_id",
      "name": {},
      "tin": {}
    },
    "managing_third_party": {
      "partner_managing_third_party_id": {},
      "name": {},
      "tin": {},
      "email": {},
      "phone": {}
    },
    "enrollment_action": "new_enrollment",
    "employee": {
      "person": {
        "partner_individual_id": "partner_individual_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "middle_name": {},
        "suffix": {},
        "date_of_birth": "date_of_birth",
        "sex": "F",
        "ssn": {},
        "marital_status": "single",
        "home_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "mailing_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "contact": {
          "email": {},
          "phone": {},
          "preferred_language": "en",
          "preferred_method": {}
        },
        "details": {
          "tobacco": {
            "user": true,
            "duration": {}
          },
          "disability": {
            "disabled": {},
            "hearing_impaired": {},
            "visually_impaired": {},
            "speech_impaired": {}
          },
          "is_military": {},
          "is_student": {}
        }
      },
      "employment": {
        "employment_status": "full-time",
        "occupation": {},
        "employment_dates": {
          "hire_date": "2024-08-25",
          "full_time_start": "2024-08-25",
          "rehire": "2024-08-25",
          "retirement": "2024-08-25",
          "terminated": "2024-08-25"
        },
        "salary": {
          "amount": {},
          "type": "hourly",
          "unit": {},
          "effective_date": "2024-08-25"
        }
      }
    },
    "dependents": {},
    "coverage": {
      "carrier_id": "carrier_id",
      "plan_hios_id": "plan_hios_id",
      "plan_type": "hmo",
      "metal_level": "bronze",
      "carrier_specific_config": {
        "electronic_communication_consent": {},
        "pediatric_dental_purchased": {},
        "donate_life_registry": {},
        "communication_impairment": {},
        "communication_impairment_format": {},
        "communication_impairment_format_other": {},
        "other_health_coverage_disability": {},
        "employer_premium_reimbursement": {},
        "employer_health_benefit_plan": {},
        "employer_health_reimbursement": {},
        "establish_hsa": {},
        "current_coverage_is_anthem": {},
        "have_disabled_dependent": {},
        "agent_tin": {},
        "agency_tin": {},
        "is_agent_assisted": {},
        "is_not_read_english": {},
        "is_not_speak_english": {},
        "is_not_write_english": {},
        "is_limited_english": {},
        "is_agree_to_electronic_signature": {},
        "is_read_completed_app": {},
        "is_agree_to_mem_communication": {},
        "is_read_understand_enroll_form": {},
        "members": {}
      },
      "coverage_members": [
        {
          "partner_individual_id": "partner_individual_id",
          "action": "enroll",
          "effective_start_date": "2024-08-25",
          "effective_end_date": "2024-08-25",
          "event_id": {},
          "pcp_details": {
            "first_name": {},
            "last_name": {},
            "npi": {},
            "carrier_id": {},
            "is_existing_patient": {}
          },
          "prior_coverage": {
            "insurer_name": {},
            "policy_type": "group",
            "policy_number": {},
            "group_number": {},
            "coverage_start_date": "2024-08-25",
            "coverage_end_date": "2024-08-25",
            "term_with_new_policy": {}
          }
        }
      ],
      "agent": {
        "first_name": {},
        "last_name": {},
        "address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "npn": {},
        "phone": {},
        "email_address": {}
      },
      "agency": {
        "tin": {},
        "name": {},
        "address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "phone": {},
        "email": {}
      },
      "payment": {
        "monthly_premium": {},
        "monthly_employer_contribution_amount": {},
        "billing_address": {
          "street_one": "street_one",
          "street_two": {},
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": {}
        },
        "credit_card": {
          "card_type": "visa",
          "card_holder_name": {},
          "card_number": {},
          "expiration_date": {},
          "security_code": {}
        },
        "bank_account": {
          "account_type": "checking",
          "account_holder_name": {},
          "routing_number": {},
          "account_number": {}
        }
      }
    },
    "events": {}
  }
]
json
Example Responses
{
  "snapshot_id": "00000000-0000-0000-0000-000000000000",
  "items": {}
}
plain

Poll snapshot processing status

GET
https://api.ichraxdev.com
/api-integrations/ichrax/v1/member-snapshots/{snapshot_id}

Returns the current status for a submitted member snapshot. Poll this endpoint with the snapshot_id returned from POST /member-snapshots until status is complete or error.

Poll snapshot processing status › path Parameters

snapshot_id
​string · uuid · required

Poll snapshot processing status › 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.

Poll snapshot processing status › Responses

OK

Represents the job-level polling response for a submitted member snapshot.
snapshot_id
​null | string

Snapshot identifier returned from submission.

status
​null | string

External processing status (pending, processing, complete, error).

​null | array

Item-level outcomes for transactions in the submitted snapshot payload.

GET/api-integrations/ichrax/v1/member-snapshots/{snapshot_id}
curl --request GET \
  --url https://api.ichraxdev.com/api-integrations/ichrax/v1/member-snapshots/:snapshot_id \
  --header 'x-api-key: <string>'
shell
Example Responses
{
  "snapshot_id": {},
  "status": {},
  "body": {}
}
plain

Dry-run member snapshots

POST
https://api.ichraxdev.com
/api-integrations/ichrax/v1/member-snapshots-dry-run

Validates and simulates a member snapshot batch without persisting, queueing, or transmitting anything. Each item runs through the same validation gates and carrier pipeline as a real submission, with carrier calls mocked for success, and the response reports the outcome each item would reach. A dry run confirms a submission passes validation and that every carrier request is constructible from the data; it cannot predict whether the real carrier would accept it.

Dry-run member snapshots › 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.

Dry-run member snapshots › Request Body

No data returned

Dry-run member snapshots › Responses

OK

Response returned for a dry-run submission (POST /member-snapshots?dry_run=true). A dry run is evaluated synchronously and persists nothing, so there is no snapshot identifier to poll — each item carries the terminal outcome the submission would reach.
​null | array

Per-item dry-run outcomes, one per submitted snapshot item.

POST/api-integrations/ichrax/v1/member-snapshots-dry-run
curl --request POST \
  --url https://api.ichraxdev.com/api-integrations/ichrax/v1/member-snapshots-dry-run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '{}'
shell
Example Request Body
{}
json
Example Responses
{
  "items": {}
}
plain

VendorCapabilities