FullContact’s Enrich API offers these key benefits from the previous API versions:
- Access to new data add-on functionality to provide additional data enrichment such as social affinities, employment history, demographics, and more.
- The ability to subscribe to a contact so FullContact will push any updates to the contact immediately versus having to poll us again (for person enrichment only).
- More secure authorization.
How to Use Enrich API (Person and Company Enrichment):
1) Generate New API Key(s)
- Login to Dashboard and click “Generate API Key”.
- Note: If the access to the account or the email address is not possible, please refer to the instructions on changing access on your account here.
- Copy your key to your clipboard and store in a safe place. Important: API keys are obfuscated and cannot be retrieved once the popup goes away.
2) Update your Requests. Enrich API has a different request structure, with a different mechanism for sending your API key as well as a different way for sending matching criteria for person and company profiles.
- Authorization Header In the previous version of the API, API keys could be sent either as a query parameter, or within the X-FullContact-APIKey header. With the new API, keys are now sent across within the Authorization header, with the string “Bearer “ (yes, that’s a space after “Bearer”) added to the beginning of your key. This is the only allowed method for including keys in the new API.
- POST instead of GET One of the more significant changes in our API is the move to an RPC-style interface instead of REST. This means that all requests to our new APIs will be done using the POST method instead of GET. Be sure that you code is updated to now send requests using the POST method.
- Query Changes In our previous API, lookup parameters for both Person and Company were sent as query parameters in the request. In our new APIs, this information is now sent across as keys inside of a post body object, referred to as the Person Summary Object. All of the previous queryable fields (email address, phone, etc.) are still supported in the Enrich API.
3) Parse the Response. Our new APIs now return only JSON, so if your code is using something other than JSON today, be sure to update it to accept a JSON response. The structure of the response is also different, so you will need to change how you are accessing the various elements. View our Person Enrichment and Company Enrichment documentation sections for details on what the new response looks like.
4) Reach Out to Us. We’d love to know when you’re up and running! We want to make sure your API plan is optimized for your use case and can answer any questions. Please contact your account representative and let them know you activated the Enrich API key.
If you don’t know who your account representative is, email firstname.lastname@example.org.
To learn more about Enrich API, please visit our API Documentation