Skip to main content
PATCH
/
v1
/
eligibility
/
batches
/
{batch_id}
Update Batch
curl --request PATCH \
  --url https://api.example.com/v1/eligibility/batches/{batch_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "total_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "has_more": true
  },
  "name": "<string>",
  "active_count": 0,
  "inactive_count": 0,
  "failed_count": 0,
  "pending_count": 0,
  "updated_at": "2023-11-07T05:31:56Z",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "eligibility_search_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "request": {
        "trading_partner_service_id": "<string>",
        "trading_partner_name": "<string>",
        "provider": {
          "organization_name": "<string>",
          "npi": "<string>",
          "service_provider_number": "<string>"
        },
        "subscriber": {
          "first_name": "<string>",
          "last_name": "<string>",
          "date_of_birth": "2023-12-25",
          "member_id": "<string>"
        },
        "encounter": {
          "service_type_codes": [
            "1"
          ],
          "date_of_service": "2023-12-25"
        },
        "dependent": {
          "first_name": "<string>",
          "last_name": "<string>",
          "date_of_birth": "2023-12-25",
          "member_id": "<string>",
          "relationship_code": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extracted_data": {
        "subscriber": {
          "first_name": "<string>",
          "last_name": "<string>",
          "middle_name": "<string>",
          "member_id": "<string>",
          "dob": "2023-12-25",
          "gender": "male",
          "address": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "alabama",
          "zip": "<string>"
        },
        "payor": {
          "eligibility_status": "active",
          "coverage_from": "2023-12-25",
          "coverage_to": "2023-12-25",
          "group_number": "<string>",
          "group_description": "<string>",
          "plan_name": "<string>",
          "plan_type": "01",
          "cob_notes": "<string>",
          "party_performing_verification": "<string>",
          "party_performing_verification_id": "<string>",
          "benefits_related_entities": [
            {
              "entity_name": "<string>",
              "entity_firstname": "<string>",
              "entity_type": "<string>",
              "entity_identifier": "<string>",
              "address": {
                "address1": "<string>",
                "address2": "<string>",
                "city": "<string>",
                "state": "alabama",
                "postal_code": "<string>"
              },
              "contact_information": {
                "phone_number": "<string>",
                "fax_number": "<string>",
                "email": "<string>",
                "url": "<string>"
              },
              "service_type_codes": [
                "1"
              ],
              "benefit_name": "<string>"
            }
          ],
          "benefits_related_entities_formatted": "<string>",
          "individual_deductible_in_network": 123,
          "individual_deductible_out_network": 123,
          "individual_deductible_remaining_in_network": 123,
          "individual_deductible_remaining_out_network": 123,
          "family_deductible_in_network": 123,
          "family_deductible_out_network": 123,
          "family_deductible_remaining_in_network": 123,
          "family_deductible_remaining_out_network": 123,
          "individual_oop_max_in_network": 123,
          "individual_oop_max_out_network": 123,
          "individual_oop_max_remaining_in_network": 123,
          "individual_oop_max_remaining_out_network": 123,
          "family_oop_max_in_network": 123,
          "family_oop_max_out_network": 123,
          "family_oop_max_remaining_in_network": 123,
          "family_oop_max_remaining_out_network": 123
        },
        "meta": {
          "eligibility_search_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payer_name": "<string>",
          "has_errors": false,
          "check_status": "active"
        },
        "dependent": {
          "first_name": "<string>",
          "last_name": "<string>",
          "middle_name": "<string>",
          "dob": "2023-12-25",
          "gender": "male",
          "relationship_to_subscriber": "spouse",
          "address": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "alabama",
          "zip": "<string>"
        },
        "services": [
          {
            "service_type": "medical_care",
            "service_type_code": "1",
            "copay_in_network": 123,
            "copay_out_network": 123,
            "co_insurance_in_network": 123,
            "co_insurance_out_network": 123,
            "visit_limit_in_network": 123,
            "visit_limit_out_network": 123,
            "visit_limit_remaining_in_network": 123,
            "visit_limit_remaining_out_network": 123,
            "visit_limit_time_period_in_network": "<string>",
            "visit_limit_time_period_out_network": "<string>",
            "has_matching_benefits": false
          }
        ]
      },
      "eligibility_status": "pending",
      "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Path Parameters

batch_id
string<uuid>
required

Body

application/json

Request schema for updating batch eligibility check

name
string
required

Batch name (required, max 100 characters)

Required string length: 1 - 100

Response

Successful Response

Response for GET batch endpoint - includes batch info and paginated checks

batch_id
string<uuid>
required

Batch ID

status
enum<string>
required

Current batch status

Available options:
pending,
validated,
validation_failed,
in_progress,
completed,
completed_with_errors
total_count
integer
required

Total eligibility checks in batch

created_at
string<date-time>
required

Batch creation timestamp

pagination
BatchEligibilityListPagination · object
required

Pagination info

name
string | null

Batch name

active_count
integer
default:0

Checks with Active eligibility status

inactive_count
integer
default:0

Checks with Inactive eligibility status

failed_count
integer
default:0

Checks that failed or had errors

pending_count
integer
default:0

Checks pending response (in progress)

updated_at
string<date-time> | null

Last update timestamp

data
EligibilityCheckItem · object[]

Paginated eligibility checks