curl --request POST \
--url https://app.fullenrich.com/api/v2/providers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "prospeo",
"credentials": {
"api_key": "pk_live_your_prospeo_key"
},
"priority": 10,
"zone": "front",
"data_types": [
"contact.work_emails",
"contact.phones"
],
"verify": true,
"enabled": true
}
'{
"id": "9f1c2d3e-4b5a-4c6d-8e7f-0a1b2c3d4e5f",
"workspace_id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
"provider": "prospeo",
"zone": "front",
"priority": 10,
"data_types": [
"contact.work_emails",
"contact.phones"
],
"verify": true,
"enabled": true,
"created_at": "2026-10-05T09:30:00Z",
"updated_at": "2026-10-05T09:30:00Z",
"sub_account_id": "70ff6a88-6291-417d-b6cd-04f1ca123470"
}Bring Your Own Key
Create a BYOK Key
Register your own credentials for one data provider. FullEnrich checks the credentials with the provider before it saves them. The key applies to the workspace, or to the sub-account named in the Sub-Account-ID header.
POST
/
providers
curl --request POST \
--url https://app.fullenrich.com/api/v2/providers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "prospeo",
"credentials": {
"api_key": "pk_live_your_prospeo_key"
},
"priority": 10,
"zone": "front",
"data_types": [
"contact.work_emails",
"contact.phones"
],
"verify": true,
"enabled": true
}
'{
"id": "9f1c2d3e-4b5a-4c6d-8e7f-0a1b2c3d4e5f",
"workspace_id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
"provider": "prospeo",
"zone": "front",
"priority": 10,
"data_types": [
"contact.work_emails",
"contact.phones"
],
"verify": true,
"enabled": true,
"created_at": "2026-10-05T09:30:00Z",
"updated_at": "2026-10-05T09:30:00Z",
"sub_account_id": "70ff6a88-6291-417d-b6cd-04f1ca123470"
}Register your credentials for one provider.
- FullEnrich checks the credentials with the provider before it saves them.
- One key per provider and per scope.
- See the supported providers for the
providervalues and the credentials each one needs.
Authorizations
Headers
Body
application/json
Data types this key supplies. Each value must be supported by the provider, with no duplicate. Default: all data types the provider supports.
Minimum array length:
1Data type a key can supply.
Available options:
contact.work_emails, contact.personal_emails, contact.phones Example:
["contact.work_emails", "contact.phones"]
Response
Created. The response contains the key without its credentials.
Was this page helpful?