Step 1 – Log in to the Platform
Start by logging into your platform after creating an account.
Step 2– Generating an API Key
API keys can be generated by clicking the "Generate New API Key" button in the Platform's Settings tab. You can also manage your API keys here.
Note: Once you've generated your key, make sure to save it somewhere safe; if it is lost, the only option is to regenerate it, since API Keys cannot be read in their entirety through the platform.
Step 3– Using the API Key in an API Code
Our API documentation includes sample code for retrieving the necessary matches.
Make sure to enter the API key you generated without the {} brackets.
Here's an example showing how to enrich a person using the API:
curl --request POST 'https://api.fullcontact.com/v3/person.enrich' \
-H 'Authorization: Bearer {FC_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"email": "snriedel85@gmail.com"
}'
Step 4 - Calling API
There are several ways to call our API.
Using Terminal:
Terminal is a program that receives user commands and sends them to the operating system for processing. It displays the output in Mac or Linux operating systems, whereas Command Prompt is used in Windows. You can reach the Terminal or Command Prompt by using your system's search bar. Once you get the code, put it into your PC's Terminal/Command Prompt.
Using Postman:
Postman serves as a comprehensive API platform for the development and management of APIs.
To initiate a request, input the desired URL into the 'request URL' tab and set the HTTP method to 'POST'.
Under the 'Authorization' section, select 'Bearer Token' from the drop-down menu and provide the API key in the 'Token' tab.
Finally, in the 'Body' tab, configure the format to 'raw'. Enter the email address or the specific field for the query, then click the 'Send' button.
-H "Authorization: Bearer {Your API Key}" \
-H "Content-Type: application/json" \
-d '{"domain":"fullcontact.com"}'
This sample code can be used to retrieve company data via Terminal or Postman.
Related Articles
Querying Account Stats (V3 Developer API)
If you find you are in need of information about whether you can continue to query - or if you need to hold off to conserve quotas - you can call on our Stats Endpoint. Understanding your current API usage is helpful, not only for billing purposes, ...
Getting Started: Permission API
FullContact's Permission API helps partners, agencies and brands monitor a range of permissions and preference activities over time and obtain information about an individual's consent, which includes: Acknowledgment and purpose of consented data ...
Issues Verifying Your API Account
When trying to verify your API account through the Platform via an international number, if you run into any issues please contact us and provide the following: Provide your phone number The country you were in when attempting to verify We will be ...
Getting Started: Multi-Field Request
What is Multi-Field Request? Multi-Field Request is a feature enhancement to our Enrich API launched on July 1st, 2019. It adds the ability to match multiple input fields that may be available instead of just one. Using multi-field requests, you can ...
Getting Started: Data Delivery
API & Batch There are two methods of delivering data to FullContact: batch or real-time API. Real-time API Client sets up API integration with FullContact so that data can be delivered in real time into the application of their choice (e.g. CRM, ...