Get Insurance Discovery

Beta

GET

/coverages/v1//insurance-discovery/:check_id

GET

/coverages/v1//insurance-discovery/:check_id

curl https://pre-api.joincandidhealth.com/coverages/v1/insurance-discovery/check_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "metadata": {
    "check_id": "check_id",
    "status": "PENDING",
    "initiated_by": "initiated_by",
    "initiated_at": "2024-01-15T09:30:00Z"
  },
  "response": {
    "discovery_id": "discovery_id",
    "status": "PENDING",
    "items": [
      {
        "key": "value"
      },
      {
        "key": "value"
      }
    ],
    "coverages_found": 1,
    "errors": [
      {
        "field?": "field?",
        "description?": "description?",
        "location?": "location?",
        "possibleResolutions?": "possibleResolutions?",
        "code?": "code?",
        "followupAction?": "followupAction?"
      },
      {
        "field?": "field?",
        "description?": "description?",
        "location?": "location?",
        "possibleResolutions?": "possibleResolutions?",
        "code?": "code?",
        "followupAction?": "followupAction?"
      }
    ]
  }
}

Gets the insurance discovery of a patient if successful.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

check_idstringRequired

Response

This endpoint returns an object.

metadataobject

responseobjectOptional

An object representing the data for an insurance discovery response.