IchraxMemberSnapshots

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

Ichrax.API.InboundMemberSnapshot[]

Inbound member snapshot item accepted by the enrollment integration endpoint.

Ichrax.API.InboundMemberSnapshot

Ichrax.API.InboundMemberSnapshotCompany · 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

Ichrax.API.InboundMemberSnapshotEmployee · required

Employee payload.

Ichrax.API.InboundMemberSnapshotCoverage · required

Coverage payload.

Ichrax.API.InboundMemberSnapshotManagingThirdParty

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

Outbound member snapshot response returned after ingestion.

Ichrax.API.OutboundMemberSnapshot

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 https://api.ichraxdev.com/api-integrations/ichrax/v1/member-snapshots \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "company": {
      "partner_company_id": "partner_company_id",
      "name": "name",
      "tin": "tin"
    },
    "managing_third_party": {
      "partner_managing_third_party_id": "partner_managing_third_party_id",
      "name": "name",
      "tin": "tin",
      "email": "email",
      "phone": "phone"
    },
    "enrollment_action": "new_enrollment",
    "employee": {
      "person": {
        "partner_individual_id": "partner_individual_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "middle_name": "middle_name",
        "suffix": "suffix",
        "date_of_birth": "date_of_birth",
        "sex": "F",
        "ssn": "ssn",
        "marital_status": "single",
        "home_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "mailing_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "contact": {
          "email": "email",
          "phone": "phone",
          "preferred_language": "en",
          "preferred_method": "preferred_method"
        },
        "details": {
          "tobacco": {
            "user": true,
            "duration": "duration"
          },
          "disability": {
            "disabled": true,
            "hearing_impaired": true,
            "visually_impaired": true,
            "speech_impaired": true
          },
          "is_military": true,
          "is_student": true
        }
      },
      "employment": {
        "employment_status": "full-time",
        "occupation": "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": 0,
          "type": "hourly",
          "unit": "unit",
          "effective_date": "2024-08-25"
        }
      }
    },
    "dependents": [
      {
        "person": {
          "partner_individual_id": "partner_individual_id",
          "first_name": "first_name",
          "last_name": "last_name",
          "middle_name": "middle_name",
          "suffix": "suffix",
          "date_of_birth": "date_of_birth",
          "sex": "F",
          "ssn": "ssn",
          "marital_status": "single",
          "home_address": {
            "street_one": "street_one",
            "street_two": "street_two",
            "city": "city",
            "state": "AL",
            "zip_code": "zip_code",
            "county_fips_id": "county_fips_id",
            "county_name": "county_name"
          },
          "mailing_address": {
            "street_one": "street_one",
            "street_two": "street_two",
            "city": "city",
            "state": "AL",
            "zip_code": "zip_code",
            "county_fips_id": "county_fips_id",
            "county_name": "county_name"
          },
          "contact": {
            "email": "email",
            "phone": "phone",
            "preferred_language": "en",
            "preferred_method": "preferred_method"
          },
          "details": {
            "tobacco": {
              "user": true,
              "duration": "duration"
            },
            "disability": {
              "disabled": true,
              "hearing_impaired": true,
              "visually_impaired": true,
              "speech_impaired": true
            },
            "is_military": true,
            "is_student": true
          }
        },
        "relationship": "spouse",
        "child_subtype": "biological"
      }
    ],
    "coverage": {
      "signature_timestamp": "signature_timestamp",
      "carrier_id": "carrier_id",
      "plan_hios_id": "plan_hios_id",
      "plan_type": "hmo",
      "metal_level": "bronze",
      "carrier_specific_config": {
        "electronic_communication_consent": true,
        "pediatric_dental_purchased": true,
        "donate_life_registry": true,
        "communication_impairment": true,
        "communication_impairment_format": "communication_impairment_format",
        "communication_impairment_format_other": "communication_impairment_format_other",
        "other_health_coverage_disability": true,
        "employer_premium_reimbursement": true,
        "employer_health_benefit_plan": true,
        "employer_health_reimbursement": true,
        "establish_hsa": true,
        "current_coverage_is_anthem": true,
        "have_disabled_dependent": true,
        "agent_tin": "agent_tin",
        "agency_tin": "agency_tin",
        "is_agent_assisted": true,
        "is_not_read_english": true,
        "is_not_speak_english": true,
        "is_not_write_english": true,
        "is_limited_english": true,
        "is_agree_to_electronic_signature": true,
        "is_read_completed_app": true,
        "is_agree_to_mem_communication": true,
        "is_read_understand_enroll_form": true,
        "members": [
          {
            "partner_individual_id": "partner_individual_id",
            "is_legal_resident": true,
            "is_incarcerated": true,
            "is_non_binary": true,
            "is_chinese": true,
            "is_korean": true,
            "is_vietnamese": true,
            "is_spanish": true,
            "is_tagalog": true,
            "is_medicare_eligible": true,
            "is_medicare_enrolled": true,
            "is_medicaid_enrolled": true
          }
        ]
      },
      "coverage_members": [
        {
          "partner_individual_id": "partner_individual_id",
          "action": "enroll",
          "effective_start_date": "2024-08-25",
          "effective_end_date": "2024-08-25",
          "event_id": "event_id",
          "pcp_details": {
            "first_name": "first_name",
            "last_name": "last_name",
            "npi": "npi",
            "carrier_id": "carrier_id",
            "is_existing_patient": true
          },
          "prior_coverage": {
            "insurer_name": "insurer_name",
            "policy_type": "group",
            "policy_number": "policy_number",
            "group_number": "group_number",
            "coverage_start_date": "2024-08-25",
            "coverage_end_date": "2024-08-25",
            "term_with_new_policy": true
          }
        }
      ],
      "agent": {
        "first_name": "first_name",
        "last_name": "last_name",
        "address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "npn": "npn",
        "phone": "phone",
        "email_address": "email_address"
      },
      "agency": {
        "tin": "tin",
        "name": "name",
        "address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "phone": "phone",
        "email": "email"
      },
      "payment": {
        "monthly_premium": 0,
        "monthly_employer_contribution_amount": 0,
        "billing_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "credit_card": {
          "card_type": "visa",
          "card_holder_name": "card_holder_name",
          "card_number": "card_number",
          "expiration_date": "expiration_date",
          "security_code": "security_code"
        },
        "bank_account": {
          "account_type": "checking",
          "account_holder_name": "account_holder_name",
          "routing_number": "routing_number",
          "account_number": "account_number"
        }
      }
    },
    "events": [
      {
        "id": "id",
        "type": "coverage",
        "date": "2024-08-25",
        "reason": "open_enrollment"
      }
    ]
  }
]'

Example Request Body

[
  {
    "company": {
      "partner_company_id": "partner_company_id",
      "name": "name",
      "tin": "tin"
    },
    "managing_third_party": {
      "partner_managing_third_party_id": "partner_managing_third_party_id",
      "name": "name",
      "tin": "tin",
      "email": "email",
      "phone": "phone"
    },
    "enrollment_action": "new_enrollment",
    "employee": {
      "person": {
        "partner_individual_id": "partner_individual_id",
        "first_name": "first_name",
        "last_name": "last_name",
        "middle_name": "middle_name",
        "suffix": "suffix",
        "date_of_birth": "date_of_birth",
        "sex": "F",
        "ssn": "ssn",
        "marital_status": "single",
        "home_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "mailing_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "contact": {
          "email": "email",
          "phone": "phone",
          "preferred_language": "en",
          "preferred_method": "preferred_method"
        },
        "details": {
          "tobacco": {
            "user": true,
            "duration": "duration"
          },
          "disability": {
            "disabled": true,
            "hearing_impaired": true,
            "visually_impaired": true,
            "speech_impaired": true
          },
          "is_military": true,
          "is_student": true
        }
      },
      "employment": {
        "employment_status": "full-time",
        "occupation": "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": 0,
          "type": "hourly",
          "unit": "unit",
          "effective_date": "2024-08-25"
        }
      }
    },
    "dependents": [
      {
        "person": {
          "partner_individual_id": "partner_individual_id",
          "first_name": "first_name",
          "last_name": "last_name",
          "middle_name": "middle_name",
          "suffix": "suffix",
          "date_of_birth": "date_of_birth",
          "sex": "F",
          "ssn": "ssn",
          "marital_status": "single",
          "home_address": {
            "street_one": "street_one",
            "street_two": "street_two",
            "city": "city",
            "state": "AL",
            "zip_code": "zip_code",
            "county_fips_id": "county_fips_id",
            "county_name": "county_name"
          },
          "mailing_address": {
            "street_one": "street_one",
            "street_two": "street_two",
            "city": "city",
            "state": "AL",
            "zip_code": "zip_code",
            "county_fips_id": "county_fips_id",
            "county_name": "county_name"
          },
          "contact": {
            "email": "email",
            "phone": "phone",
            "preferred_language": "en",
            "preferred_method": "preferred_method"
          },
          "details": {
            "tobacco": {
              "user": true,
              "duration": "duration"
            },
            "disability": {
              "disabled": true,
              "hearing_impaired": true,
              "visually_impaired": true,
              "speech_impaired": true
            },
            "is_military": true,
            "is_student": true
          }
        },
        "relationship": "spouse",
        "child_subtype": "biological"
      }
    ],
    "coverage": {
      "signature_timestamp": "signature_timestamp",
      "carrier_id": "carrier_id",
      "plan_hios_id": "plan_hios_id",
      "plan_type": "hmo",
      "metal_level": "bronze",
      "carrier_specific_config": {
        "electronic_communication_consent": true,
        "pediatric_dental_purchased": true,
        "donate_life_registry": true,
        "communication_impairment": true,
        "communication_impairment_format": "communication_impairment_format",
        "communication_impairment_format_other": "communication_impairment_format_other",
        "other_health_coverage_disability": true,
        "employer_premium_reimbursement": true,
        "employer_health_benefit_plan": true,
        "employer_health_reimbursement": true,
        "establish_hsa": true,
        "current_coverage_is_anthem": true,
        "have_disabled_dependent": true,
        "agent_tin": "agent_tin",
        "agency_tin": "agency_tin",
        "is_agent_assisted": true,
        "is_not_read_english": true,
        "is_not_speak_english": true,
        "is_not_write_english": true,
        "is_limited_english": true,
        "is_agree_to_electronic_signature": true,
        "is_read_completed_app": true,
        "is_agree_to_mem_communication": true,
        "is_read_understand_enroll_form": true,
        "members": [
          {
            "partner_individual_id": "partner_individual_id",
            "is_legal_resident": true,
            "is_incarcerated": true,
            "is_non_binary": true,
            "is_chinese": true,
            "is_korean": true,
            "is_vietnamese": true,
            "is_spanish": true,
            "is_tagalog": true,
            "is_medicare_eligible": true,
            "is_medicare_enrolled": true,
            "is_medicaid_enrolled": true
          }
        ]
      },
      "coverage_members": [
        {
          "partner_individual_id": "partner_individual_id",
          "action": "enroll",
          "effective_start_date": "2024-08-25",
          "effective_end_date": "2024-08-25",
          "event_id": "event_id",
          "pcp_details": {
            "first_name": "first_name",
            "last_name": "last_name",
            "npi": "npi",
            "carrier_id": "carrier_id",
            "is_existing_patient": true
          },
          "prior_coverage": {
            "insurer_name": "insurer_name",
            "policy_type": "group",
            "policy_number": "policy_number",
            "group_number": "group_number",
            "coverage_start_date": "2024-08-25",
            "coverage_end_date": "2024-08-25",
            "term_with_new_policy": true
          }
        }
      ],
      "agent": {
        "first_name": "first_name",
        "last_name": "last_name",
        "address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "npn": "npn",
        "phone": "phone",
        "email_address": "email_address"
      },
      "agency": {
        "tin": "tin",
        "name": "name",
        "address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "phone": "phone",
        "email": "email"
      },
      "payment": {
        "monthly_premium": 0,
        "monthly_employer_contribution_amount": 0,
        "billing_address": {
          "street_one": "street_one",
          "street_two": "street_two",
          "city": "city",
          "state": "AL",
          "zip_code": "zip_code",
          "county_fips_id": "county_fips_id",
          "county_name": "county_name"
        },
        "credit_card": {
          "card_type": "visa",
          "card_holder_name": "card_holder_name",
          "card_number": "card_number",
          "expiration_date": "expiration_date",
          "security_code": "security_code"
        },
        "bank_account": {
          "account_type": "checking",
          "account_holder_name": "account_holder_name",
          "routing_number": "routing_number",
          "account_number": "account_number"
        }
      }
    },
    "events": [
      {
        "id": "id",
        "type": "coverage",
        "date": "2024-08-25",
        "reason": "open_enrollment"
      }
    ]
  }
]

json

Example Responses

{
  "snapshot_id": "00000000-0000-0000-0000-000000000000",
  "items": [
    {
      "partner_individual_id": "partner_individual_id",
      "code": 0,
      "messages": [
        {
          "code": "code",
          "severity": "severity",
          "field": "field",
          "message": "message"
        }
      ]
    }
  ]
}

text

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

Represents the job-level polling response for a submitted member snapshot.

Ichrax.API.MultiStatusMemberSnapshot

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.

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

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.

Ichrax.API.DryRunMemberSnapshot

null | array

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

IchraxCoverage VendorCapabilities

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

Ichrax.API.InboundMemberSnapshot[]

Inbound member snapshot item accepted by the enrollment integration endpoint.

Ichrax.API.InboundMemberSnapshot

Ichrax.API.InboundMemberSnapshotCompany · 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

Ichrax.API.InboundMemberSnapshotEmployee · required

Employee payload.

Ichrax.API.InboundMemberSnapshotCoverage · required

Coverage payload.

Ichrax.API.InboundMemberSnapshotManagingThirdParty

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

Outbound member snapshot response returned after ingestion.

Ichrax.API.OutboundMemberSnapshot

snapshot_id

string · uuid

External snapshot identifier for status polling.

null | array

Per-item results for all submitted items.

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

Represents the job-level polling response for a submitted member snapshot.

Ichrax.API.MultiStatusMemberSnapshot

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.

Dry-run member snapshots

POST

https://api.ichraxdev.com

/api-integrations/ichrax/v1/member-snapshots-dry-run

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

Ichrax.API.DryRunMemberSnapshot

null | array

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