Skip to navigation
API ReferencePre EncounterCoveragesV1

Scan

Beta

Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.

Polling Pattern: To continuously poll for updates without gaps:

  1. Make your initial request with a since timestamp (e.g., since=2020-01-01T13:00:00.000Z)
  2. The API returns up to 100 coverage records, sorted by updated_at ascending
  3. Find the updated_at value from the last record in the response
  4. Use that updated_at value as the since parameter in your next request
  5. Repeat steps 2-4 to ingest updates until you receive an empty list

Important Notes:

  • The since parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version)
  • All coverage records include updated_at, id, version, deactivated, and updating_user fields for tracking changes
  • Timestamps have millisecond resolution for precise ordering

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

sincedatetimeRequired

Response

This endpoint returns a list of objects.
deactivatedboolean
True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
idUUID
The unique identifier for a Coverage in the database
insurance_planobject
organization_idstring
The organization that owns this object.
patientstring
The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage
relationshipenum

The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html

Allowed values:
statusenum
The status indiciating if the coverage is active or not.
Allowed values:
subscriberobject

The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the object.
verifiedboolean
A boolean indicating if the coverage has been verified by a user.
versioninteger
The version of the object. Any update to any property of an object object will create a new version.
auto_update_enabledbooleanOptional
Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration.
benefitsobjectOptional
The eligibility of the patient for the coverage, manually verified by users.
eligibility_checkslist of objectsOptional
A list of eligibility check metadata that have been initiated on this coverage.
latest_eligibility_checkobjectOptional
The latest eligibility check metadata that has been initiated on this coverage.
orconbooleanOptional

ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false.

previous_appointment_copaysmap from enums to integersOptional

A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly.

Allowed values: