Demographic Append API Documentation
Introduction The TDG Demographic Append API enables real-time enrichment of customer records with high-fidelity consumer attributes. This demographic data append endpoint provides direct access to 500+ segments, including household income, age, and homeownership data. By integrating our consumer demographic append solution, enterprises can build precise segmentation models directly within their CRM or marketing platforms.
Authentication To access the demographic engine, you must authenticate your requests using an API Key. By authenticating your requests with an API Key, you ensure secure and authorized access to our data services, allowing you to integrate our comprehensive and reliable data seamlessly into your applications and workflows.
Obtaining an API Key To obtain an API key, please contact our technical support team to receive your unique x-api-key within 24 hours. [Contact Us]
Including the API Key in Requests When interacting with our data services through APIs, SDKs, or command-line interfaces (CLI), it’s essential to include your API Key in the request. This API Key acts as a unique identifier that authenticates and authorizes your request to access our data.
Managing Your API Key Proper management of your API Key is crucial. Ensure it is kept confidential and not shared publicly or hard-coded in client-side applications. Rotate your keys periodically and revoke them immediately if compromised.
Best Practices Use HTTPS to encrypt API Key transmissions over the network, preventing interception by unauthorized parties. Implement rate limiting and access controls based on API Key usage to manage and monitor access effectively.
Security Protocols HTTPS encryption is required for all requests. Request and response bodies are encoded in JSON format.
CONVENTIONS
The base URL to send API requests is segregated into 3 categories.
- Lookup: https://api.tdg1.io/v2/lookup
- Append: https://api.tdg1.io/v2/append
- Verify: https://api.tdg1.io/v2/verify
HTTPS is required for all API requests. The TDG API follows RESTful conventions when possible, with most operations performed via POST requests on database resources. Request and response bodies are encoded as JSON.
ENDPOINT SPECIFICATIONS (DEMOGRAPHIC APPEND)
Demographic Append Append lifestyle and financial attributes to your contact records. This demographic appending service utilizes deterministic matching against our master identity graph.
HEADERS
- x-api-key (string) | required: Unique key obtained after contacting us.
BODY PARAMS
- FName (string) | conditionally required: First name, 15 characters max. (Should be a combination of FName, LName, Zip and Address parameters; Phone or Email is Required).
- LName (string) | conditionally required: Last name, 20 characters max. (Should be a combination of FName, LName, Zip and Address parameters; Phone or Email is Required).
- Address1 (string) | conditionally required: Address line 1, 64 characters max. (Should be a combination of FName, LName, Zip and Address parameters; Phone or Email is Required).
- Zip (string) | conditionally required: 5 digit numeric USPS zip code. (Either City/State or Zip is required).
- Phone (string) | conditionally required: 10 digit numeric phone number. (Required if Email is not included).
- Email (string) | conditionally required: Individual email address. (Required if Phone is not included).
- City (string) | optional: City name, 28 characters max. (Either City/State or Zip is required).
- State (string) | optional: 2 character state abbreviation. (Either City/State or Zip is required).
POST: https://api.tdg1.io/v2/append/demographic
Sample Request
curl --location 'https://api.tdg1.io/v2/append/demographic' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data-raw '{
"FName": "<FName>",
"LName": "<LName>",
"Address1": "<Address1>",
"Zip": "<Zip>",
"Phone":"<Phone>",
"Email": "<Email>"
}'
Sample Response
{
"Demographics": {
"Gender": "",
"Age": "",
"DOB": "",
"LOR": "06",
"Homeowner": "H",
"EHI": "F",
"DwellType": "S",
"Married": "M",
"MedYrBld": "1998",
"MobHome": "",
"Pool": "",
"FirePl": "",
"SglParent": "",
"HHNBRSR": "",
"CreditCard": "",
"WealthScr": "H",
"CharityDnr": "",
"MrktHomeVal": "N",
"Education": "",
"Ethnicity": "",
"ChildCd": "Y",
"ChildAgeCd": "A",
"ChildNbrCd": "",
"VehLux": "",
"VehSuv": "Y",
"VehTrk": "Y",
"PctBlk": "R",
"PctWht": "E",
"PctHsp": "Q",
"PctAsi": "T",
"PctEngSpeak": "D",
"PctSpnSpeak": "S",
"PctAsiaSpeak": "T",
"PctSFDU": "A",
"PctMFDU": "",
"MHV": "E",
"MOR": "G",
"PctAuto": "A",
"MedSchl": "153",
"PctWhiteCollar": "K",
"PctBlueCollar": "T",
"PctOccO": "K",
"DemoLvl": "1"
}
}
DEVELOPER TOOLS (SDK & POSTMAN)
TDG SDK The TDG SDK is an open-source project designed to simplify the process of integrating our data services into your applications. By using the SDK, developers can easily access and utilize our API functionalities, ensuring a smooth and efficient development experience.
- Access: Read Documentation on PyPI
Postman Collection Postman is a powerful tool that simplifies API development and testing. It allows you to easily create, test, and manage your API requests without writing any code. Using Postman with the TDG API provides a user-friendly way to explore and integrate our data services.
- Run in Postman: [Import TDG Collection]
- Technical Docs: View Documentation
API RESPONSE CODES & COMPLIANCE
HTTPS STATUS CODE | Description |
200 | Successful |
204 | No Records found |
400 | Missing required parameter(s) |
401 | The user is invalid (verify your credentials) |
429 | You have reached the maximum number of transactions allowed |
440 | Too many results. Please refine your search criteria |
500 | System error. Retry search, if failure continues, contact support |
Compliance Notice: The Data Group is not a Consumer Reporting Agency (CRA). Our demographic append api and demographic data append services are for marketing and lead validation purposes only. Data may not be used for FCRA-regulated purposes, such as determining eligibility for credit, insurance, or employment.
Need Technical Assistance?
