Skip to main content
GET
Get payor detection run
Poll this endpoint until status is COMPLETE, then inspect the payor_detections array for individual results. While the run is IN_PROGRESS, the payor_detections array will be empty. The response includes summary counts to help you quickly assess results:
  • coverages_found — Number of detections with confirmed coverage (confidence_level = COVERAGE_FOUND)
  • potential_coverages — Number of detections that may need manual review (confidence_level = POTENTIAL_COVERAGE)
  • total — Total number of detections in the run
Each detection in payor_detections includes a confidence_level and status that together tell you whether coverage was confirmed, potential, or not found. See the Payor Detection Overview for detailed explanations of each status and confidence level. When a detection shows COVERAGE_FOUND, you can use the detected_payor_entity_id and member_number to create a patient plan via the Create Patient Plan API.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payor_detection_run_id
string
required

Response

id
string<uuid>
required

The ID of the payor detection run

status
enum<string>
required

The status of the payor detection run

Available options:
IN_PROGRESS,
COMPLETE
coverages_found
integer
required

Number of detections with COVERAGE_FOUND confidence level

potential_coverages
integer
required

Number of detections with POTENTIAL_COVERAGE confidence level

total
integer
required

Total number of payor detections in this run

created_at
string<date-time>
required

When this run was created

payor_detections
V1PayorDetectionSchema · object[]

The individual payor detection results