> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userecord.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Every Enrichment API endpoint, with its request and response schema.

```text Base URL theme={null}
https://api-bc.userecord.io/api/v1/partner
```

Each endpoint adds its path to the base URL. For example, **Create an enrichment** is `POST https://api-bc.userecord.io/api/v1/partner/enrichments`, and **List results** is `GET https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/results`.

You need two things: your **key id** and your **secret**. The signature, timestamp and `Idempotency-Key` are generated for you. Copy the `call()` helper from [Authentication](https://docs.userecord.io/blue-collar-api/authentication.md#signing-helper) first: the code samples on each endpoint page use it.

## Try it

Every endpoint page has a **Try it** button. Enter your key id in `x-api-key` and your secret in `x-secret-key`, fill the request and press **Send**. `x-secret-key` is only a form field: the page signs the request in your browser and removes the secret before sending. See [Why does Try it say `x-secret-key`?](https://docs.userecord.io/blue-collar-api/authentication#why-does-try-it-say-x-secret-key).

> [!WARNING]
>
> **Create a campaign** really contacts the numbers you send. Use a TEST key.

## On each endpoint page

* **Scope**: the scope the key needs. Any one listed is enough.
* **Idempotency-Key**: whether the endpoint needs one, accepts one, or ignores it. Try it makes one for you.
* **Responses**: the success answer and the errors specific to that endpoint. Errors any endpoint can return, such as `401`, `429` and `500`, are listed in [Errors](https://docs.userecord.io/blue-collar-api/reference/errors.md).

## Endpoints

| Group | What it covers |
| - | - |
| Enrichments | Create, list and read an enrichment, and its overview. |
| Campaigns | Send candidates, follow progress, pause and resume. |
| Candidates | Where each candidate stands, and one candidate in full. |
| Results | The final result of each candidate who finished. |

Results are read with [`GET /results`](https://docs.userecord.io/enrichment-api/guides/candidates-and-results#how-to-get-results): each one is final as soon as it appears.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.