Skip to main content

Asynchronous Integration Guide

Blacktrust's architecture operates asynchronously due to the complexity of processing external information such as credit bureaus, criminal records, and identity validation.

The atomic resources tied to this flow are called Processes. The following diagram illustrates the optimal flow for registering candidates and querying results:

Workflow​

Step-by-Step Explanation​

  1. Authentication (Auth): Before consuming any endpoint you must authenticate with the method defined in your contract: an API Key (x-api-key header) or username and password (POST /signin and Authorization: Bearer header). They are alternative methods; see Authentication to find out which one applies to you.
  2. Registration: You send a POST /candidate-requests specifying the packageId.
  3. Immediate Validation: The Universal API validates your parameters through the validation engine.
  4. 202 Accepted Response: If valid, the system does not block the connection waiting for the scraper; it responds with a uuid immediately.
  5. Worker Processing: Our Processes run in the background with high concurrency.
  6. Polling: You can check the status using the uuid via GET /candidate-requests/{uuid} to get the Request Overview.