Please see this article for information on API authorization, testing endpoints, and how obtain your API key.
If you would like to programmatically enrich data, you can leverage our enrichment API to achieve this.
This API endpoint allows an enrichment to be performed on a single email or CRM input data record based on a the settings of a previously created enrichment campaign in your account.
To retrieve the API endpoint/CampaignId for a completed enrichment, you can navigate to the Enrichments menu in your account and click the expand/down arrow next to an enrichment to view the details of the enrichment. From here, you can click on the "</>" code icon to bring up the API posting Instructions for this Enrichment campaign.
The posting Instructions will include the HTTP POST endpoint to process additional enrichments for an enrichment campaign Id via API, as well a sample Postman collection with your API credentials embedded.
A sample JSON Post Payload for Email input data would appear as follows:
{
"Email": "[email protected]"
}
A sample JSON Post Payload for CRM input data would appear as follows:
{
"FirstName": "John",
"LastName": "Doe",
"Address": "123 Main Street",
"City": "Saint Louis",
"State": "MO",
"Zip": "63101"
}
For both input payload types, any additional properties on the input record may be passed in and will be returned on the ResultData array of the JSON response.
In addition to the required campaignId parameter on the HTTP Post call, an optional parameter of "enrhichmentResprocessingOption" may also passed through by passing in this optional value as query string parameter in the Url as shown:
By default, if a given input record has been previously submitted for appends for a given enrichment campaignId, no appends will be preformed and the call will error out. To override this default behavior, the following values may be passed in for the enrhichmentResprocessingOption parameter:
Fail Resubmits = 1 (default)
Reprocess Append = 2 (re-runs the append for the input record)
Return Existing Append = 3 (returns the previously appended values if already processed)
A sample response payload will follow the JSON structure below and the Result data object will always include all input fields and any successfully appended fields, if any. The array of AppendFieldResults will list all enrichments defined for the Enrichment campaign and show the append results and credits consumed, if any, for each append attempt.
{
"ProcessingResult": {
"Status": "success",
"StatusMessage": null,
"FieldsAppended": 9,
"CreditsConsumed": 198,
"OverageCreditsConsumed": 198,
"AppendFieldResults": [
{
"FieldName": "Name & Verified Addresss",
"Appended": false,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Phone Number",
"Appended": false,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Gender",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Age Range",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Marital Status",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Presence Of Children",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Net Worth Range",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Household Income Range",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Length Of Residence Range",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Homeowner Status",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
},
{
"FieldName": "Education Level",
"Appended": true,
"CreditsConsumed": 18,
"OverageCreditsConsumed": 18
}
]
},
"ResultData": {
"FirstName": "",
"LastName": "",
"Address": "",
"Address2": null,
"City": "",
"State": "",
"Zip": "",
"Email": "[email protected]",
"Phone": null,
"Zipcode": null,
"Gender": "Female",
"AgeRange": "25-34",
"MaritalStatus": "Single",
"PresenceOfChildren": "Yes",
"NetWorthRange": "10k-25k",
"HouseholdIncomeRange": "50k-75k",
"LengthOfResidenceRange": "16-19 years",
"HomeownerStatus": "Own",
"EducationLevel": "Completed High School",
"PhoneNumber": null
}
}