Overview - Ready Health - API Documentation

A requirement is a compliance item a candidate must satisfy for a job or placement — for example a BLS card, a TB test, or an OIG exclusion check. Ready Health owns the loop around those items:

Ingest the requirement list from the VMS or another source
Fulfill each item with a document, registry search, primary source verification or generated statement
Upload the compiled packet back to the VMS

What triggers the lifecycle

Creating or updating a job or placement queues the sync. Which source Ready Health reads from — VMS scrape, MSP email, or a pre-configured template — is set per integration. Ready Health manages access credentials to the VMS and ATS systems required. See Requirement ingestion for sources and the resulting requirement list.

What fulfillment looks like

Each ingested requirement has a fulfillmentType:

Type	What Ready Health creates
`DOCUMENT`	A document slot the candidate (or your app) fills
`REGISTRY_SEARCH`	A search (exclusions, license verification, etc.)
`STATEMENT`	A generated statement
`PASS_THROUGH`	No new artifact — the item is already satisfied or handled outside Ready Health

GET /placement/{id} returns the candidate’s requirement rows and their status (PENDING → IN_PROGRESS → FULFILLED, plus reject / expire / skip states).

Uploading back to the VMS

Once the relevant requirements are FULFILLED, call Upload Packet to VMS. Upload is async; poll package status until the packet is UPLOADED. See VMS Upload.