Standard Order API

The Order API is a RESTful HTTP API that is used to create orders in the Cognition middleware platform. With this API, you can easily create and manage orders in the Cognition background screening system and check the returned results of those orders.

The API allows you to pass “Applicant Data” (which is PII for the individual you are running a screening search on) via a POST request to the /v1/orders/ endpoint and retrieve the order details via a GET request to the /v1/orders/{id}/ endpoint. You can also choose to be notified when an order changes status by providing a postbackWebhookURL at the time of order creation.

Once an order is created using the Order API, it is processed by Cerebrum's middleware. The screening process involves running various searches; the searches that will be run are determined by the "package" that is passed using the packageId field in the POST body to the /v1/orders/ endpoint. The package contains a list of the searches that will be performed on the order, along with various other organization and package-level configurations.

It's important to note that the time it takes for an order to return a result can vary, depending on the selected package. Typically, screening results are returned within our standard acceptable range, which can span from 1 minute to 48 hours, depending on the complexity of the searches involved. However, in certain cases, the time to return a result can take up to one week.

Once the result is complete, a notification is returned to the provided postbackWebhookUrl, after which you can GET the /v1/orders/{id}/ endpoint to retrieve the order details and screening results.