> ## 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.

# Authentication

> API keys, scopes and request signing for the Enrichment API.

The Enrichment API is part of the Record Partner API and uses the **same API keys and the same request signing** as the Blue Collar API. If you already call the Blue Collar API, your signing code works unchanged.

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

## API keys

Create a key pair in the Record playground under **Settings → API keys**: a key id (`VFN_LIVE_…` or `VFN_TEST_…`) and a secret (`VFN_SK_…`). The secret never leaves your backend and is never sent: it signs each request.

## Signing

Every request carries `x-api-key`, `x-timestamp` and `x-signature`; creating calls also carry an `Idempotency-Key`. The exact rules, a ready-made `call()` helper in JavaScript and Python, and the reasons behind them are on the Blue Collar [Authentication](https://docs.userecord.io/blue-collar-api/authentication.md#signing-helper) page. Copy the helper once: every code sample in this tab uses it.

## Scopes

Record switches the Enrichment API on per key by granting scopes. Any one scope listed on an endpoint opens it.

| Scope | Lets the key |
| - | - |
| `enrichment:read` | Read enrichments, campaigns, candidates and results. |
| `enrichment:write` | Create enrichments. Also includes everything in `enrichment:read`. |
| `enrichment:campaigns` | Create, pause and resume campaigns. **Contacts real people and spends credits.** Also includes `enrichment:read`. |
| `enrichment:credits` | Read your available credits and where they were spent. Changes nothing, and includes no other scope. |

> [!WARNING]
>
> `enrichment:write` alone cannot create a campaign. Starting a campaign needs `enrichment:campaigns`, so a key that only manages questions can never message your candidates.

A key with no scopes is not enabled and every call answers `403 SCOPE_MISSING`. Ask your Record contact to grant the scopes you need.

## What you can read and change

* **Read:** every enrichment of your organisation in the key's mode, made through the API or on the Enrichment page of the playground. `is_external` says which.
* **Change:** all of them, whichever way they were made: add a campaign to it, and pause or resume its campaigns. What is created in the playground can be managed through the API too. Enrichments themselves are never edited: different questions mean a new enrichment.
* **Other organisations:** their data answers `404 NOT_FOUND`, never `403`.

## Test and live

A `VFN_TEST_` key sees only test data, gets one tenth of every [rate limit](https://docs.userecord.io/enrichment-api/reference/limits.md), an enrichment holds at most 50 test candidates, and the organisation may hold 5 active enrichments at once. A `VFN_LIVE_` key contacts real people.


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