Skip to main content
Record contacts your candidates on WhatsApp, follows up by phone call and SMS, and verifies them against the job. The Blue Collar API lets your ATS or backend run that whole flow and receive each candidate’s result.

​
Verify candidates from your own system, in 4 steps

Do the steps in this order. Each one returns an id that the next one needs.
1

Workflow

How and when candidates are contacted: channels, send window and retries. Create it once and reuse it. You get workflow_id.
2

Job mandate

The job: skills to verify and screening questions. Record prepares the questions in the background. Needs workflow_id, you get mandate_id.
3

Campaign

The people: name and phone number of each candidate. Record contacts and verifies them. Needs mandate_id, you get campaign_id.
4

Results

Verdict and score for each candidate, sent to your webhook as soon as they finish. Needs campaign_id, you get candidate_id.

​
The 7 calls you need

  1. POST /workflows → save workflow_id
  2. POST /mandates → save mandate_id
  3. GET /mandates/{mandate_id} → repeat until status is ready
  4. POST /campaigns → save campaign_id
  5. GET /campaigns/{campaign_id} → watch it go out
  6. POST /webhooks/endpoints → results are sent to you, signed; answer 2xx to confirm. No public URL? Pull them with POST /events/pull
  7. GET /campaigns/{campaign_id}/results → catch up or check: status and collected output

​
4 rules to remember

  • You only need your key id and secret. Timestamp, signature and Idempotency-Key are made by the helper (or by Try it).
  • Creating calls carry an Idempotency-Key, so a retry never creates twice. The helper adds it.
  • Use a TEST key first. A campaign contacts real people and spends credits.
  • Every error is { "success": false, "error": { "code", … } }; all codes are explained in Errors.

​
What Record checks

A job mandate runs one or more checks, named in its methods.

​
Before you start

  • An API key pair from the Record playground, under Settings → API keys.
  • The Blue Collar API switched on for that key. Record does this by granting scopes.
  • A TEST key for development. It sees only test data and can only contact phone numbers that Record has listed for it.

Quickstart

Make your first signed call and run the four steps.

Authentication

API keys, scopes and request signing.

Webhooks

Receive results as soon as candidates finish.

API reference

Every endpoint with its request and response schema.