{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_pre-encounter.subpackage_pre-encounter/coverages.subpackage_pre-encounter/coverages/v1 API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_pre-encounter.subpackage_pre-encounter/coverages.subpackage_pre-encounter/coverages/v1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Multi",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "patient_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of Coverages based on the search criteria."
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual."
        },
        {
          "info": {
            "name": "Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//:id/:version",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a Coverage. The path must contain the next version number to prevent race conditions. For example, if the current version of the coverage is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the coverage. Updating historic versions is not supported."
        },
        {
          "info": {
            "name": "Get Multi Paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//get-multi-paginated",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "patient_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "payer_plan_group_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Must be between 0 and 1000. Defaults to 100"
              }
            ]
          },
          "docs": "Returns a page of Coverages based on the search criteria."
        },
        {
          "info": {
            "name": "Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "gets a specific Coverage"
        },
        {
          "info": {
            "name": "Get History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//:id/history",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "non_auto_updated_coverages_only",
                "value": "",
                "type": "query",
                "description": "If true, only returns coverages that have NOT been auto-updated by the system."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "Defaults to ascending. Sorts by version."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Must be between 0 and 1000. No default."
              }
            ]
          },
          "docs": "Gets a coverage's history. Full history is returned if no filters are \ndefined. The return list is ordered by version, defaulting to ascending."
        },
        {
          "info": {
            "name": "Scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//updates/scan",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "since",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.\n\n**Polling Pattern:**\nTo continuously poll for updates without gaps:\n1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`)\n2. The API returns up to 100 coverage records, sorted by `updated_at` ascending\n3. Find the `updated_at` value from the last record in the response\n4. Use that `updated_at` value as the `since` parameter in "
        },
        {
          "info": {
            "name": "Batch Update Ppg",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//batch-update-ppg/:ppg_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "ppg_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Finds all coverages associated with the given ppg_id and updates the ppg_fields for each coverage."
        },
        {
          "info": {
            "name": "Check Eligibility",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//:id/eligibility",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates an eligibility check. Returns the metadata of the check if successfully initiated."
        },
        {
          "info": {
            "name": "Get Eligibility",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/coverages/v1//:id/eligibility/:check_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "check_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets the eligibility of a patient for a specific coverage if successful."
        }
      ]
    }
  ],
  "bundled": true
}