Contact Us
Get Started with Enrich API

What’s New and How to Get Started with our Enrich API

Written By:
Kory Cunningham

We’ve just released the most advanced API on our next generation platform, the Enrich API. The new API provides the person and company data enrichment you’ve come to know and love from our legacy Person and Company APIs, yet includes another level of capabilities to improve querying options, receive real-time data updates, and customize your data return.

In addition to more powerful capabilities, the Enrich API introduces an enhanced FullContact Dashboard to make it easier to manage your API account, as well as a “Try It Out” experience to let you work directly with it. In this post, we’ll walk through these changes and how you can get started.

Improved Querying

The Enrich API introduces a powerful capability for multi-field querying when looking up contacts for enrichment. In our Person API, you could supply an email (included hashed versions), phone number, or Twitter handle to enrich a profile, but only one of those elements in a given request. Now, with the Enrich API and the included multi-field querying, you can supply multiple data elements in a single request to improve the overall query. The old way of enriching data with the Person API looked like this:

curl -H "X-FullContact-APIKey:{Your API Key}" "https://api.fullcontact.com/v2/person.json
?email=bart@fullcontact.com"

Notice we’re passing in the email address “bart@fullcontact.com” in our query. If we had a phone number or a Twitter handle, we’d have to query for those separately, we couldn’t simply add those to our original request. With the Enrich API, that’s changed. Here’s how we can now make a query for the same email address, but also including Bart’s Twitter handle:

curl -X POST https://api.fullcontact.com/v3/person.enrich 
-H "Authorization: Bearer
{Your API Key}" -d '{"email":"bart@fullcontact.com",”twitter”: “@bartlorang”}'

You’ll notice quite a few changes in what the request looks like. First, we’re now making a POST request instead of a GET. We’ve made this change so we can add more information in the body of the request – the information we send across now is a JSON string, with keys for queryable items such as “email” and “twitter”. These changes, as well as the other options available in the Enrich API, are all documented in our API reference docs available at http://docs.fullcontact.com/api/.

Real-time Data Updates

One of the most common feature requests from our customers was the ability for us to deliver updates on contact profiles as soon as we had new data. With our Enrich API, we’re delivering that capability through Data Subscriptions. Now, rather than having to poll our API to check for updates, you can have them pushed to your servers through the use of long-lived webhooks. Here’s an example request to help illustrate:

curl -X POST https://api.fullcontact.com/v3/person.subscribe 
-H "Authorization: Bearer
{Your API Key}" -d '{"email":"bart@fullcontact.com", "webhookUrl":"http://www.example.com/hookUrl"
}'

In this example, we’re creating a data subscription for bart@fullcontact.com, and telling the FullContact Enrich API to send all updates about the matching profile to http://www.example.com/hookUrl. Now, anytime we have new data for bart@fullcontact.com, we’ll post the enriched profile to the webhook URL provided. No need for custom code or advanced logic to poll our systems to get updates!

Customizable Responses

Our Enrich API contains a wealth of data points for person and company profiles – demographic information, employment history, affinities and more. While everyone loves data, we’ve heard from our customers that often times they want to be able to focus on just the data elements that are most important to their use case. Our new Enrich API now provides the ability to customize your API response through the use of our Data Add-ons. By default, the most commonly used data elements, such as name, age range and current job title are available for all responses. We’ve then pre-packaged our more specific and detailed data fields into a handful of Data Add-ons – age, gender and name information available in our Demographics Data Add-on, previous employers and titles in our Employment History Data Add-on, and so on. By packaging these configurable Data Add-ons, you can now pick and choose the data elements most important to you and your use case.

Getting Started with Enrich API

Now that you know about the new and exciting capabilities with Enrich API, how can you get started? As part of our Enrich API release, we’ve introduced a new FullContact Dashboard to help both new and existing users get started with Enrich API. Available at https://dashboard.fullcontact.com, logging in with your existing credentials will bring you to the main page, where you can see familiar information such as plan usage and summary information. You’ll also be able to manage your API keys. For users looking to see what data is returned and how Data Add-ons can impact the response, a new “Try It Out” demo provides a visual representation of the Enrich API data response with no code required, along with the code-behind so you can copy and paste directly into your own applications. Along with the new dashboard, we’ve included an Upgrading section in our API Reference documentation that walks you through the 3 steps to upgrading existing Person and Company API calls to the new Enrich API.

We’re ecstatic about the release of the Enrich API, and what it means for both new and existing customers. We look forward to hearing about the awesome use cases and customer-wins that result from this next-level release and our future platform innovations. As always, we’d love to hear from you, so please reach out to us at api-feedback@fullcontact.com. Until next time, happy coding!

Like this post? Share it:

Recent Posts