Get Eligibility Check By Id

Beta

GET

/eligibility-checks/v1/:eligibility_check_id

GET

/eligibility-checks/v1/:eligibility_check_id

curl https://pre-api.joincandidhealth.com/eligibility-checks/v1/eligibility_check_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "id",
  "source": "STEDI",
  "payerId": "payerId",
  "providerNPI": "providerNPI",
  "status": "ACTIVE",
  "errors": [
    {
      "source": "CANDID",
      "errorDetails": {
        "field?": "field?",
        "description?": "description?",
        "location?": "location?",
        "possibleResolutions?": "possibleResolutions?",
        "code?": "code?",
        "followupAction?": "followupAction?"
      }
    },
    {
      "source": "CANDID",
      "errorDetails": {
        "field?": "field?",
        "description?": "description?",
        "location?": "location?",
        "possibleResolutions?": "possibleResolutions?",
        "code?": "code?",
        "followupAction?": "followupAction?"
      }
    }
  ],
  "dateOfService": "2024-01-15T09:30:00Z",
  "dependent": {
    "name": "name"
  }
}

Fetch an eligibility check by it's primary key

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

eligibility_check_idstringRequired

Response

This endpoint returns an object.

idstring

sourceenum

Allowed values:

payerIdstring

providerNPIstring

statusenum

enum to represent the status of a patient's coverage

Allowed values:

errorslist of objects

dateOfServicedatetimeOptional

dependentobjectOptional