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

# Check network status for a payer in a state

> Asks whether OpenLoop holds contracted, credentialed providers for a payer in a state, within your organization. **Answered inline**: there is nothing to poll.

The organization comes from your access token's organization claim; there is no body field or query parameter for it. A token carrying no claim is a 401.

**This is not the `network_status` on an eligibility verification.** That field is the payer's own classification of a benefit it quoted for one patient. This endpoint answers OpenLoop's contracting position for the payer, with no patient in it. The two can disagree, and neither is derived from the other.

**`in_network: false` is a complete answer, not a failure.**

**A payer id we do not hold is a 400**, refused rather than answered as out of network.

**Not yet enabled on the production edge.** This path appears in the reference but answers 404 against the production server, and there is no committed enablement date. Do not sequence a launch behind it. Confirm status with your OLH implementation contact before designing against it.

**Permissions:** `eligibility:read`. `eligibility:write` is not accepted in its place: the check contacts no payer and bills nothing.



## OpenAPI

````yaml /openapi.json post /network-status
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /network-status:
    post:
      tags:
        - Eligibility
      summary: Check network status for a payer in a state
      description: >-
        Asks whether OpenLoop holds contracted, credentialed providers for a
        payer in a state, within your organization. **Answered inline**: there
        is nothing to poll.


        The organization comes from your access token's organization claim;
        there is no body field or query parameter for it. A token carrying no
        claim is a 401.


        **This is not the `network_status` on an eligibility verification.**
        That field is the payer's own classification of a benefit it quoted for
        one patient. This endpoint answers OpenLoop's contracting position for
        the payer, with no patient in it. The two can disagree, and neither is
        derived from the other.


        **`in_network: false` is a complete answer, not a failure.**


        **A payer id we do not hold is a 400**, refused rather than answered as
        out of network.


        **Not yet enabled on the production edge.** This path appears in the
        reference but answers 404 against the production server, and there is no
        committed enablement date. Do not sequence a launch behind it. Confirm
        status with your OLH implementation contact before designing against it.


        **Permissions:** `eligibility:read`. `eligibility:write` is not accepted
        in its place: the check contacts no payer and bills nothing.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkStatusRequest'
      responses:
        '200':
          description: >-
            The network status was resolved. `in_network: false` is a resolved
            answer too.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/NetworkStatus'
                  request_id:
                    type: string
                    example: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
                required:
                  - data
                  - request_id
        '400':
          description: >-
            The request body failed validation: a missing or unknown field, a
            `state` that is not a US state code, or an empty `payer_id`. Also
            where a payer id we do not hold lands: a payer we cannot identify is
            refused here rather than answered as out of network. `error.message`
            names the fields that failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: 'Invalid request: payer_id'
                  error_code: BAD_REQUEST
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
        '401':
          description: >-
            Missing or invalid access token, or a token that carries no
            organization claim.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: the token carries no organization
                  error_code: AUTHENTICATION_ERROR
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
        '403':
          description: >-
            Missing the `eligibility:read` permission. A token that holds only
            `eligibility:write` lands here too.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: insufficient_permissions
                  error_code: FORBIDDEN
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
        '429':
          description: >-
            Too many requests: a poll inside the interval the previous read
            reported, a throttled request, or exhausted shared real-time
            capacity. The message is the same on every eligibility endpoint and
            names no duration, because the window behind each of those differs.
            Back off and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: Too many requests. Retry later.
                  error_code: TOO_MANY_REQUESTS
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
        '500':
          description: >-
            Something failed that names no cause. `error_code` is always
            `UNHANDLED_EXCEPTION` and the message is fixed prose — quote
            `request_id` to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: Internal server error
                  error_code: UNHANDLED_EXCEPTION
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
        '504':
          description: >-
            The request timed out before an answer arrived. Try again. The
            message names no hop: which one ran out of time is not something you
            can act on.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  message: The request timed out. Try again.
                  error_code: REQUEST_TIMEOUT
                request_id: c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05
      security:
        - serviceToken:
            - eligibility:read
components:
  schemas:
    NetworkStatusRequest:
      type: object
      additionalProperties: false
      required:
        - state
        - payer_id
      properties:
        state:
          type: string
          pattern: ^[A-Za-z]{2}$
          description: >-
            The US state to ask about, for example `CA`. State input is
            case-insensitive and surrounding whitespace is trimmed. A two-letter
            code that is not a real state is a 400.
          example: CA
        payer_id:
          type: string
          minLength: 1
          description: >-
            The payer to ask about. Surrounding whitespace is trimmed. A payer
            id we do not hold is a 400, not an `in_network: false` answer. `GET
            /payers` lists the payer ids eligibility checks accept, not the ones
            this endpoint accepts.
          example: '60054'
    NetworkStatus:
      type: object
      additionalProperties: false
      required:
        - in_network
      description: >-
        Whether OpenLoop holds contracted, credentialed providers for this payer
        in this state, within your organization. Not the payer's own network
        classification of a patient's benefit, which a verification reports in
        `result.benefits[].network_status`.
      properties:
        in_network:
          type: boolean
          description: >-
            `true` when at least one contracted, credentialed provider backs the
            answer, `false` when none does.
          example: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            error_code:
              type: string
          required:
            - message
            - error_code
        request_id:
          type: string
      required:
        - error
        - request_id
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.