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 /v1/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 /v1/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 POSTed to the provided URL for any changes screening status, including adverse actions and disputes as well as changes to the report items. (See Callbacks)

Screening can be initiated with a charge Id ( See Charges) if you had been set up to enable ECommerce. The card token submitted to the charge object would be authorized and funds would be captured. An email receipt would be sent to the candidate on successful capture of funds.

📘

The API also supports Idempotency for safely retrying screening requests without accidentally performing the same operation twice.

Charge Id can also be used as Idempotency key to retry the screenings.