Skip to main content

Authentication

The Universal API supports two alternative authentication methods. Your integration uses only one: the one Blacktrust defines with you at the contract level. Along with your contract you receive only the credentials for that method.

One or the other, never both

On each request, send a single authentication mechanism: either the x-api-key header or the Authorization: Bearer header. There is no need (nor is it recommended) to combine them.


Which one is mine?​

If Blacktrust gave you…Your method is…What you send on each requestGuide
An API KeyAPI Keyx-api-key: {apiKey}API Key
An email and a passwordUsername and password (Bearer token)Authorization: Bearer {accessToken}Sign In

If you are not sure which one applies to you, check with your Blacktrust sales contact.


How each method works​

No prior step is required: send your apiKey in the x-api-key header from the very first request.

curl -X GET "{BASE_URL}/candidate-requests/{uuid}" \
-H "x-api-key: {apiKey}" \
-H "Content-Type: application/json"

See the API Key guide →


Switching methods​

The authentication method is configured at the contract level. If you need to change it, or rotate your credentials, request it through your sales contact.