Skip to main content

Introduction (Auth & Flow)

Welcome to the official documentation for Blacktrust's Universal API.

The Asynchronous Model​

All heavy workflows, such as background checks, are designed around an Asynchronous model, handled internally by our atomic services, strictly known as Processes.

The general authentication and interaction flow (Auth & Flow) works as follows:

  1. Auth: Authenticate with the method defined in your contract: an API Key (x-api-key) or username and password (POST /signin → Bearer token). See Authentication.
  2. Registration: Submit a candidate via /candidate-requests, validated by the Pipe.
  3. Quick Response (202 Accepted): You receive a uuid while the required Processes run in the background.
  4. Final Response: You access levels 3 and 4 of the candidate through continuous polling or by waiting for a Webhook.

Click Core Concepts or the Integration Guide in the side menu to dive into the technical details.