> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecobalt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Eligibility Benefits

> Returns the per-benefit detail for a single eligibility check.

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](/api-reference/eligibility-checks/get), then page the
benefits here. Narrow results with `benefit_type`.

### Example Request

```bash theme={null}
curl -X GET "https://api.usecobalt.com/v1/eligibility-checks/abc123def4567890abcdef1234567890/benefits?benefit_type=Co-Payment&page=1&page_size=100" \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH'
```

### Example Response

```json theme={null}
{
    "success": true,
    "benefits": [
        {
            "line_number": 17,
            "benefit_type": "Co-Payment",
            "benefit_type_code": "B",
            "coverage_level": "IND",
            "service_type_codes": ["98"],
            "insurance_type": null,
            "time_period": null,
            "amount": 25,
            "percent": null,
            "network_indicator": "in-network",
            "messages": ["Specialist Visit or Evaluation"],
            "raw_segment": "EB*B*IND*98****25*****Y"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 100,
        "total_records": 1,
        "total_pages": 1
    }
}
```

### 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`.


## OpenAPI

````yaml GET /eligibility-checks/{id}/benefits
openapi: 3.0.0
info:
  title: Cobalt API
  version: 1.0.1
  description: API for interacting with Cobalt's EHR integration services
servers:
  - url: https://api.usecobalt.com/v1
security:
  - ClientCredentials: []
    ClientSecret: []
    AccessToken: []
paths:
  /eligibility-checks/{id}/benefits:
    get:
      tags:
        - Eligibility
      summary: List eligibility benefits
      description: >-
        Returns a page of the per-benefit detail (deductibles, copays,
        coinsurance, out-of-pocket, limitations) parsed from a single
        eligibility check’s 271.
      operationId: getEligibilityBenefits
      parameters:
        - name: id
          in: path
          required: true
          description: Cobalt eligibility check ID from the list endpoint.
          schema:
            type: string
        - name: benefit_type
          in: query
          required: false
          description: >-
            Filter by decoded benefit type (e.g. Deductible, Co-Payment,
            Co-Insurance, Out of Pocket).
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number (default 1).
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          required: false
          description: Results per page (default 100, max 500).
          schema:
            type: integer
            default: 100
            maximum: 500
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  benefits:
                    type: array
                    items:
                      type: object
                      properties:
                        line_number:
                          type: integer
                          description: Segment order within the 271.
                        benefit_type:
                          type: string
                          description: >-
                            Decoded EB01, e.g. Active Coverage, Deductible,
                            Co-Payment, Co-Insurance, Out of Pocket,
                            Limitations, Non-Covered.
                        benefit_type_code:
                          type: string
                          description: Raw X12 EB01 code.
                        coverage_level:
                          type: string
                          description: IND (individual) or FAM (family).
                        service_type_codes:
                          type: array
                          items:
                            type: string
                          description: X12 service type codes the benefit applies to.
                        insurance_type:
                          type: string
                        time_period:
                          type: string
                          description: >-
                            Decoded time period, e.g. Calendar Year or
                            Remaining.
                        amount:
                          type: number
                          description: Monetary amount (deductible/copay/out-of-pocket).
                        percent:
                          type: number
                          description: >-
                            Coinsurance percentage as a decimal (e.g. 0.2 =
                            20%).
                        network_indicator:
                          type: string
                          description: >-
                            in-network, out-of-network, unknown, or
                            not-applicable.
                        messages:
                          type: array
                          items:
                            type: string
                          description: Payer free-text notes attached to the benefit line.
                        raw_segment:
                          type: string
                          description: The raw X12 EB segment.
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      page_size:
                        type: integer
                      total_records:
                        type: integer
                      total_pages:
                        type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
components:
  securitySchemes:
    ClientCredentials:
      type: apiKey
      in: header
      name: client_id
    ClientSecret:
      type: apiKey
      in: header
      name: client_secret
    AccessToken:
      type: apiKey
      in: header
      name: access_token

````