Auto Append API Documentation
Introduction The TDG Auto Append API is a high-capacity infrastructure for comprehensive data enrichment. This endpoint is designed to automatically resolve and append missing consumer attributes to fragmented datasets. By matching primary signals (Phone, Email, or Name/Address) against our master identity graph, this data append api returns a complete customer profile, including verified residential addresses and household vehicle intelligence. Use this endpoint for high-scale automated data enrichment and identity linkage.
Authentication To access the Auto Append 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 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 mandatory. All request and response bodies are transmitted 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 (AUTO APPEND)
- x-api-key (string) | required: Unique key obtained after contacting us.
- Phone (string) | conditionally required: 10 digit numeric phone number (no spaces, dashes, or parentheses). *Required if Email or Name/Address markers are not provided.
- Email (string) | conditionally required: Individual’s email address. 100 characters max. *Required if Phone or Name/Address markers are not provided.
- FullName (string) | conditionally required: Individual’s full name. *FullName, Address1, and Zip are required altogether if used as the primary marker.
- Address1 (string) | conditionally required: Street address. *FullName, Address1, and Zip are required altogether if used as the primary marker.
- Zip (string) | conditionally required: 5 digit numeric USPS zip code. *FullName, Address1, and Zip are required altogether if used as the primary marker.
POST: https://api.tdg1.io/v2/append/auto
Sample Request
curl --location 'https://api.tdg1.io/v2/append/auto' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data-raw '{
"Phone": "<phone>",
"Email": "<email>",
"FullName": "<full name>",
"Address1": "<address>",
"Zip": "<zip>"
}'
Sample Response
{
"Name": {
"FName": "Tom",
"LName": "Smith",
"MName": "A",
"Suffix": ""
},
"Address": {
"House": "123",
"PreDir": "",
"Street": "LONG LAKE",
"StrType": "",
"PostDir": "",
"AptType": "",
"AptNbr": "",
"City": "Orlando",
"State": "FL",
"Zip": "12345",
"Z4": "9111",
"DPC": "564",
"CRTE": "R019",
"CNTY": "SEM",
"Z4Type": "S",
"DPV": "Y",
"Vacant": "N",
"MSA": "5960",
"CBSA": "36740"
},
"IDS": {
"PID": "Y67511710678784",
"AID": "Y00000676763",
"HHID": "Y0000007676"
},
"Vehicle": {
"Make": "Hyundai",
"Model": "Creta",
"Year": "2020",
"ClassCD": "Sedan",
"FuelTypeCD": "G",
"MFGCD": "",
"StyleCD": "UTIL",
"Mileages": "A",
"ODate": "20001025"
},
"Vehicle2": {
"Make": "Porsche",
"Model": "camrea",
"Year": "2019",
"ClassCD": "Sedan",
"FuelTypeCD": "G",
"MFGCD": "",
"StyleCD": "UTIL",
"Mileages": "A",
"ODate": "20101103"
},
"Vehicle3": {
"Make": "TOYOTA",
"Model": "Corolla Altis",
"Year": "2019",
"ClassCD": "Sedan",
"FuelTypeCD": "G",
"MFGCD": "",
"StyleCD": "PICKUP",
"Mileages": "A",
"ODate": "20090809"
},
"Vehicle4": {
"Make": "",
"Model": "",
"Year": "",
"ClassCD": "",
"FuelTypeCD": "",
"MFGCD": "",
"StyleCD": "",
"Mileages": "",
"ODate": ""
}
}
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 automated data enrichment tools and consumer 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?
