Partner APIBackground Checks

Retrieve a background check

Retrieves a background check and its per-check statuses. Results are eligibility-style determinations (eligible / review), never raw records. For FL AHCA Level 2 / Clearinghouse items, only orchestration status is reported — determinations flow to AHCA and the provider, never through CONFIRM.

Authentication

AuthorizationBearer
Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

org_idstringRequired

Organization ID (org_...).

bgc_idstringRequired

Background check ID (bgc_...).

Response

The background check.
idstringOptional

Background check ID (bgc_...).

candidate_idstringOptional
external_refstring or nullOptional

The candidate’s external_ref, echoed for correlation.

packageenumOptional
statusenumOptional

Order lifecycle: ordered → in_progress → completed or action_required.

checkslist of objectsOptional
ordered_atdatetimeOptional
completed_atdatetime or nullOptional

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error