The FullContact Developer APIs are used to manage and enhance contact information. Use our APIs to provide social profiles in your app, improve contacts in address books, enrich CRM information, or create highly personalized marketing campaigns.
All requests to all endpoints require you to specify your unique API key. The API Key is assigned to you by FullContact and is used to identify and authorize each request. Your API key should be kept private, and should never be displayed publicly.
There are two methods to specify the API key in a request: 1. Specify it using the apiKey= query parameter; 2. specify the API key in the HTTP request header using an extended header field with name X-FullContact-APIKey.
The use of the HTTP header field rather than the apiKey query parameter provides an added level of security. Although we utilize HTTPS to ensure that all requests are encrypted for network transport, there is a possibility that the plain-text URI, with the value of the apiKey, might appear the logs of HTTP servers which process the requests.
All successful responses are returned in JSON, XML, HTML or vCard, depending on the response format you request. On our paid endpoints, such as the Person, Card Reader , and Disposable Email endpoints, only queries that respond with a 200 response code (successfully completed), are counted towards monthly allowances and overages.
|200 OK||Your request processed successfully.|
|202 Accepted||Your request is currently being processed. You can check again later to see the request has been processed.|
|400 Bad Request||Your request was malformed.|
|403 Forbidden||Your API key is invalid, missing, or has exceeded its quota. **Paid plans will not receive a 403 response when they exceed their alotted matches. They will only receive a 403 for exceeding rate limit quotas.|
|404 Not Found||This person was searched in the past 24 hours and nothing was found.|
|405 Method Not Allowed||You have queried the API with an unsupported HTTP method. Retry your query with either GET or POST.|
|410 Gone||This resource cannot be found. You will receive this status code if you attempt to query our deprecated V1 endpoints.|
|422 Invalid||Invalid or missing API query parameter.|
|500 Internal Server Error||There was an unexpected error on our server. If you see this please contact email@example.com.|
All API requests are subject to rate limits that exist independently of your API key's monthly usage allowance. We track rate-limits on a 60-second basis. For example, if your API is subject to a 10/second rate limit, we'll allow you 600 requests per 60 second window. To make it easier for your application to determine if it is being rate-limited, or if it is likely to be in the future, we've added the following HTTP headers to successful responses:
What You Need to Know About Rate Limits by FullContact
|Header Name||Example Value||Description|
|X-Rate-Limit-Limit||600||The rate limit ceiling for your request|
|X-Rate-Limit-Remaining||10||The number of requests left in the 60 second window.|
|X-Rate-Limit-Reset||20||The number of UTC epoch seconds remaining until the 60 second window resets|
|Thanks to Twitter and Github for this pattern.|