A screening is a background check on a candidate with a specific package.
Once a candidate is created and a package has been selected, the screening can be initiated on that candidate by calling the POST /v2/screenings
endpoint. The turnaround time for completion of a screening is variable. Most screening reports are returned within 24-72 hours, and the results can be found by calling GET /v2/screenings/{id}
, where {id}
is the identifier for the screening.
An application can subscribe to updates on the fulfillment of a screening using the callback
field. Callbacks will be POST
ed to the provided URL for any changes screening status, including changes to the report items. (See Callbacks)
The API also supports Idempotency for safely retrying screening requests without accidentally performing the same operation twice.