Skip to main content
GET
List eligibility benefits
A 271 response breaks down into many benefit lines, one per service type and coverage level: deductibles, copays, coinsurance, out-of-pocket maximums, limitations, and exclusions. Get the check id from Get Eligibility Checks, then page the benefits here. Narrow results with benefit_type.

Example Request

Example Response

Query Parameters

  • benefit_type: Filter by decoded benefit type (e.g. Deductible, Co-Payment, Co-Insurance, Out of Pocket).
  • page: Page number (default 1).
  • page_size: Results per page (default 100, max 500).

Response Parameters

  • line_number: Segment order within the 271.
  • benefit_type: Decoded benefit category, e.g. Active Coverage, Deductible, Co-Payment, Co-Insurance, Out of Pocket, Limitations, Non-Covered.
  • benefit_type_code: The raw X12 EB01 code.
  • coverage_level: IND (individual) or FAM (family).
  • service_type_codes: X12 service type codes the benefit applies to.
  • insurance_type: Insurance type code, when present.
  • time_period: Decoded time period, e.g. Calendar Year or Remaining.
  • amount: Monetary amount (deductible, copay, or out-of-pocket).
  • percent: Coinsurance percentage as a decimal (e.g. 0.2 = 20%).
  • network_indicator: in-network, out-of-network, unknown, or not-applicable.
  • messages: Payer free-text notes attached to the benefit line.
  • raw_segment: The raw X12 EB segment, retained for reference.
  • pagination: page, page_size, total_records, total_pages.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Path Parameters

id
string
required

Cobalt eligibility check ID from the list endpoint.

Query Parameters

benefit_type
string

Filter by decoded benefit type (e.g. Deductible, Co-Payment, Co-Insurance, Out of Pocket).

page
integer
default:1

Page number (default 1).

page_size
integer
default:100

Results per page (default 100, max 500).

Required range: x <= 500

Response

Successful response

success
boolean
benefits
object[]
pagination
object