Skip to main content
With Bring Your Own Key (BYOK), you register the credentials of your own data provider accounts. FullEnrich then calls these providers with your credentials when it enriches your contacts.
  • Billing: your provider bills your account for each call. Values found with your keys cost FullEnrich credits at a reduced rate, or no credit when you skip verification. See Verification and credits.
  • Fallback: if a provider refuses your credentials, FullEnrich uses its own account for that provider, when it has one.
  • Security: FullEnrich checks your credentials with the provider before it saves them, encrypts them at rest, and never returns them.
BYOK is in beta and is enabled on request. Contact support@fullenrich.com to enable it for your workspace.

​
How it works

1

Create a BYOK key

Call POST /providers with the provider name, your credentials, and a priority. See the supported providers for the credentials each provider needs.
2

Enrich contacts as usual

Call POST /contact/enrich/bulk. The request does not change. FullEnrich places your keys in the waterfall by zone and priority.
3

Read the results

Each email and phone found with one of your keys carries the field byok_provider. See What changes in your results.

​
Manage BYOK keys

A BYOK key holds your credentials for one provider. A workspace has at most one key per provider.

Create a BYOK key

Register and check your credentials for one provider.

List BYOK keys

See every key, with masked credentials.

Check a BYOK key

Test the saved credentials with the provider.

Update a BYOK key

Rotate credentials, change the placement, or disable the key.

Delete a BYOK key

Remove the key and its credentials.

Errors

Status codes and error codes of the BYOK key endpoints.

​
Placement in the waterfall

Use auto only for a provider that FullEnrich also uses for the same data types. Otherwise, POST /contact/enrich/bulk fails with error.enrichment.byok.auto_position_missing. If you are not sure, use front or back.

​
What changes in your results

The enrichment request and the shape of the results do not change.
  • A value found with one of your keys carries byok_provider, set to the provider of the key.
  • A value served from the FullEnrich cache carries from_cache: true.
  • A value found with a key that has verify: false has the status UNVERIFIED.

​
Sub-accounts

Each sub-account has its own BYOK keys. To manage them, add the Sub-Account-ID header to any BYOK request:
During an enrichment for a sub-account, FullEnrich uses the key of the sub-account, or the workspace key when the sub-account has none.