Order a background check

Orders a background-check package for the candidate. The `fl_registry_hire` package bundles: national sex-offender registry search, OIG/LEIE exclusion check, Florida license verification, and reference checks. Requires `consent.fcra_disclosure: true` on the candidate (set at ingest or via PATCH-less re-ingest is not supported — capture it at ingest); orders without it are rejected with `409 conflict_error` (`code: fcra_disclosure_required`). **FL AHCA Level 2 / Clearinghouse:** where a package includes Level 2 screening, CONFIRM tracks orchestration **status only** (`initiated`, `screening_in_progress`, `determination_received`). Results flow legally to AHCA and the provider — never through CONFIRM. Results in `checks[]` are eligibility-style determinations (`eligible` / `review`), not raw records, consistent with FCRA. Partners must make final FCRA adverse-action decisions through their own compliant process; this section is a draft pending legal review.

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_...).

cand_idstringRequired

Candidate ID (cand_...).

Headers

Idempotency-KeystringOptional<=255 characters

Unique key (e.g. a UUID) making this POST safe to retry. Replays within 24 hours return the original response without repeating side effects.

Request

This endpoint expects an object.
packageenumRequired

Background-check package to order. fl_registry_hire = national sex-offender registry + OIG/LEIE exclusion + FL license verification + reference checks.

Allowed values:

Response

Background check ordered.
idstringOptional

Background check ID (bgc_...).

candidate_idstringOptional
external_refstring or nullOptional

The candidate’s external_ref, echoed for correlation.

packageenumOptional
statusenumOptional

Order lifecycle: orderedin_progresscompleted or action_required.

checkslist of objectsOptional
ordered_atdatetimeOptional
completed_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error