Request Properties

Request Properties

You can modify your requests by adding additional properties to your JSON payload.

Confidence Level

The confidence parameter can be added in the request body to adjust quality threshold of data returned, with acceptable values of LOW (60%), MED (80%), HIGH (Default - 95%), and MAX (98%), with the default set to HIGH. If the confidence level of the data to be returned does not meet or exceed the parameter provided, then the result will not be a match. Generally, setting this value higher results in more accurate data, but fewer matches, while setting the value lower results in more matches and data, but lower quality and accuracy.

curl -X POST https://api.fullcontact.com/v3/person.enrich \
-H "Authorization: Bearer {Your API Key}" \
-H "Content-Type: application/json" \
-d '{
    "email":"[email protected]",
    "confidenceLevel": "MED"
  }'

Data Filter

To tailor the API response and only receive data back for specific Insights Bundles that are already enabled on your account, you can specify the Insights Bundles in the request within the request body. By specifying certain Insights Bundles in your request, this will only return data found in those particular Bundles if a match is to be found, which will be reflected in both your Insights Bundle usage as well as your billing. If this object is not present in your request, all Insights Bundles that are enabled on your plan will be returned and again reflected in both your usage as well as your billing. If you have a bundle like Individual Plus that inherently enables all bundles you will not able to break that out to smaller bundles using the filter.
Acceptable values include automotive, demographic, employment_history, finances, hem_amplification, household, individual, interests, lifestyle, location, maid_amplification, professional, purchases, resolve, resolve_crm, shopping_habits and social.

curl -X POST https://api.fullcontact.com/v3/person.enrich \
-H "Authorization: Bearer {Your API Key}" \
-H "Content-Type: application/json" \
-d '{
    "email":"[email protected]",
    "twitter":"@bartlorang",
    "dataFilter": ["social", "employment_history"]
  }'

Inferencer

Based upon the input provided, our algorithms may incorporate inferencers in order to identify and return enrichment information for an individual. Should you wish not to leverage infererncers, you may disable this enhanced feature by including an additional header in the request.

curl -X POST https://api.fullcontact.com/v3/person.enrich \
-H "Authorization: Bearer {Your API Key}" \
-H "Content-Type: application/json" \
-d '{
    "email":"[email protected]",
    "infer": false
  }'

Reporting Key

Supply a "Reporting Key" header to tailor the API response and associated usage tracking for your own internal specific client use cases and needs. This helps you see where specific billed events are coming from.

curl -X POST \
  https://api.fullcontact.com/v3/person.enrich \
  -H 'Authorization: Bearer {Your API Key}' \
  -H "Content-Type: application/json" \
  -H "Reporting-Key: segmentXYZ" \
  -d '{
  "emails": [
    "[email protected]",
    "[email protected]"
  ]
    }'

Permission in Enrich

For those customers who are already using FullContact's Enrich Product you now have the capability to capture and continuously manage the permissions and preferences of your consumer as well as receive insights back via our Enrichment Insights Bundles. Create opted-in consumer permissions by passing over the consent string within the body the JSON request.

The following fields are required to create a permission:

  • One or many of the acceptable multi field inputs
  • Permission Purposes purpose ID, enabled (true/false) & channel (unspecified or a valid channel of email, mobile, web, phone and/or offline)
  • Collection Method
  • Collection Location
  • Policy URL
  • Terms of Service
curl -X POST \
  https://api.fullcontact.com/v3/person.enrich \
  -H "Authorization: Bearer {Your API Key}" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "maids": ["adkkjre", "alkdjfakd"],
    "permission": {
        "consentPurposes": [{
                "purposeId": 2,
                "channel": ["web", "phone"],
                "ttl": 365,
                "enabled": true
            },
            {
                "purposeId": 3,
                "channel": ["mobile"],
                "ttl": "NULL",
                "enabled": true
            }
        ],
    "locale": "US",
    "ipAddress": "127.0.0.1",
    "language": "en",
    "collectionMethod": "cookiePopUp",
    "collectionLocation": "homepage",
    "policyUrl": "http://foo.baz",
    "termsService": "http://foo.tos"
    }
    }

Download our purposes data model here.
You have the ability to store consents across web, mobile, email, phone and offline channels.

Webhook URL

This endpoint supports the use of webhooks as an optional parameter on the request body containing a URL to an endpoint on your service that will accept a posted json response of an enrichment result. Check out Webhooks to learn more about receiving data to your specified URL.


Did this page help you?