Demography Append API

Get Started

The Demography Append API adds demographic and modeled consumer attributes to existing customer or prospect records. These may include age, gender, income, education, marital status, home ownership, dwelling type, pet ownership, charitable interests, political indicators, investor signals, solar intent, mortgage attributes, and more.

Submit identifying data such as name, address, ZIP, email, phone, MD5 email hash, or SHA email hash. Use OutputColumn to specify which demographic fields you want returned.

API Endpoint

Replace the placeholder below with your assigned Datazapp API endpoint URL.

Endpoint - you'll get this from your account manager

<datazapp api endpoint URL>

Demography Append API Request

Submit your API key, append module, requested output columns, and input records in the request body.

JSON Request Body - Name, Address, Email & Phone

{
  "ApiKey": "API Key",
  "AppendModule": "DemographyAppend",
  "OutputColumn": [
    "Age",
    "Education",
    "Marital_Status",
    "Gender",
    "Ethnicity",
    "Income",
    "Occupation",
    "Presence_of_Child",
    "Home_Owner",
    "LOR",
    "Dwelling_Type",
    "Home_Value",
    "Dog_Owner",
    "Cat_Owner",
    "Diet_Weight_Loss",
    "Golf_Enthusiasts",
    "Travel_Cruise_Vacations",
    "Travel_International",
    "Arts_Cultural",
    "Animal_Welfare",
    "Childrens_Causes",
    "Environmental_Causes",
    "International_Aid",
    "Religious",
    "Veterans",
    "NumberOfChildren",
    "Party-Leaning_D",
    "Party-Leaning_R",
    "Political_Donor",
    "Unregistered_Voter",
    "Signal_Accredited_Investor",
    "Signal_EV_Purchase",
    "Signal_High_Networth",
    "Propensity_to_Give",
    "Signal_Seller_Score",
    "Signal_Solar_Intenders",
    "Loan_Amount_Range",
    "HomePurchase_Range",
    "NLTV",
    "CREDIT_RANGE",
    "EST_LoanBalance_Range"
  ],
  "Data": [
    {
      "FirstName": "John",
      "LastName": "Doe",
      "Address": "123 Main St",
      "City": "Anytown",
      "Zip": "12345",
      "Email": "[email protected]",
      "Phone": "15555555555"
    }
  ]
}

JSON Request Body - MD5 Email Input

{
  "ApiKey": "API Key",
  "AppendModule": "DemographyAppend",
  "OutputColumn": [
    "Age",
    "Gender",
    "Income",
    "Home_Owner"
  ],
  "Data": [
    {
      "MD5": "MD5Data"
    }
  ]
}

JSON Request Body - SHA Email Input

{
  "ApiKey": "API Key",
  "AppendModule": "DemographyAppend",
  "OutputColumn": [
    "Age",
    "Gender",
    "Income",
    "Home_Owner"
  ],
  "Data": [
    {
      "SHA": "SHAData"
    }
  ]
}

Request Parameters

Parameter	Required	Type	Description
`ApiKey`	Yes	String	Your assigned Datazapp API key.
`AppendModule`	Yes	String	Use `DemographyAppend`.
`OutputColumn`	Yes	Array	List of demographic fields you want returned.
`Data`	Yes	Array	Contains the records to process.
`FirstName`	Conditional	String	First name of the person.
`LastName`	Conditional	String	Last name of the person.
`Address`	Conditional	String	Valid United States postal address.
`City`	Conditional	String	City name.
`Zip`	Conditional	String	5-digit ZIP code. ZIP+4 is also accepted.
`Email`	No	String	Email address for matching.
`Phone`	No	String	Phone number for matching.
`MD5`	No	String	MD5 hashed email input.
`SHA`	No	String	SHA hashed email input.

Output Columns

Column Name	Description
`Age`	Age group or age value of the individual.
`Education`	Education level of the individual or household.
`Marital_Status`	Married, single, inferred married, or inferred single.
`Gender`	Gender of the individual.
`Ethnicity`	Ethnicity of the individual.
`Income`	Income range or income indicator.
`Occupation`	Occupation of the individual.
`Presence_of_Child`	Known presence or absence of children age 0–17 in the household.
`Home_Owner`	Homeowner, probable homeowner, or renter indicator.
`LOR`	Length of residence at the current address.
`Dwelling_Type`	Single-family, multi-family, or unknown dwelling type.
`Home_Value`	Estimated home value or home value range.
`Dog_Owner`	Likely presence of dog owner in household.
`Cat_Owner`	Likely presence of cat owner in household.
`Diet_Weight_Loss`	Interest in dieting or weight loss.
`Golf_Enthusiasts`	Interest in golf or golf-related merchandise.
`Travel_Cruise_Vacations`	Affinity for cruise travel.
`Travel_International`	Interest in international travel.
`Arts_Cultural`	Support for arts or cultural causes.
`Animal_Welfare`	Support for animal welfare causes.
`Childrens_Causes`	Support for children’s causes.
`Environmental_Causes`	Support for environmental causes.
`International_Aid`	Support for foreign or international aid causes.
`Religious`	Religious interest or support for religious causes.
`Veterans`	Support for veterans’ affairs causes.
`NumberOfChildren`	Numeric value representing number of children.
`Party-Leaning_D`	Likely Democratic Party supporter indicator.
`Party-Leaning_R`	Likely Republican Party supporter indicator.
`Political_Donor`	Identified political donor indicator.
`Unregistered_Voter`	Likely eligible but unregistered voter indicator.
`Signal_Accredited_Investor`	Modeled accredited investor indicator.
`Signal_EV_Purchase`	Electric vehicle purchase intent or history indicator.
`Signal_High_Networth`	Modeled high net worth indicator.
`Propensity_to_Give`	Numeric score indicating likelihood to give or donate.
`Signal_Seller_Score`	Predictive score estimating likelihood of being a home seller.
`Signal_Solar_Intenders`	Modeled solar interest or solar intent indicator.
`Loan_Amount_Range`	Loan amount range.
`HomePurchase_Range`	Home purchase price range.
`NLTV`	Net loan-to-value ratio range.
`CREDIT_RANGE`	Credit score or creditworthiness range.
`EST_LoanBalance_Range`	Estimated remaining loan balance range.

API Response

JSON Response

{
  "header": {
    "Status": 0,
    "Message": null
  },
  "ResponseDetail": {
    "App": 0,
    "Token": "IxxxxS",
    "Data": [
      {
        "Age": "33",
        "Education": "B",
        "Marital_Status": "M",
        "Gender": "M",
        "Ethnicity": "",
        "Income": "",
        "Occupation": "",
        "Presence_of_Child": "",
        "Home_Owner": "H",
        "LengthOfResidence": "17",
        "Dwelling_Type": "S",
        "Home_Value": "$150001-$200000",
        "Dog_Owner": "",
        "Cat_Owner": "",
        "Diet_Weight_Loss": "",
        "Golf_Enthusiasts": "",
        "Travel_Cruise_Vacations": "",
        "Travel_International": "Y",
        "Arts_Cultural": "",
        "Animal_Welfare": "",
        "Childrens_Causes": "",
        "Environmental_Causes": "",
        "International_Aid": "",
        "Religious": "Y",
        "Veterans": "",
        "Contributor_General": "",
        "Party_Leaning_D": "D",
        "Party_Leaning_R": "R",
        "Political_Donor": "D",
        "Unregistered_Voter": "",
        "Signal_Accredited_Investor": "Y",
        "Signal_EV_Purchase": "",
        "Signal_High_Networth": "",
        "Propensity_to_Give": "68",
        "Signal_Seller_Score": "2x - Medium",
        "Signal_Solar_Intenders": "Solar-Qualified (1x)",
        "Loan_Amount_Range": "$175k-$199k",
        "HomePurchase_Range": "Above 1M",
        "NLTV": "54",
        "CREDIT_RANGE": "EXCELLENT",
        "EST_LoanBalance_Range": "$175000 - $199999",
        "Tag": "",
        "FirstName": "John",
        "LastName": "Doe",
        "Address": "123 Main St",
        "City": "Anytown",
        "Zip": "12345",
        "AlterFirstName": null,
        "AlterLastName": null,
        "AlterAddress": null,
        "AlterCity": null,
        "AlterZip": null,
        "Matched": false
      }
    ],
    "OrderAmount": "$0.135",
    "Count": 26,
    "Message": null,
    "ProcessedTime": "766 milliseconds"
  },
  "Status": true,
  "Message": null
}

Response Fields

Field	Type	Description
`header.Status`	Integer	Indicates header status.
`header.Message`	String	Indicates error type, when applicable.
`ResponseDetail.Token`	String	System-generated reference token.
`ResponseDetail.Data`	Array	Returned demographic append results.
`Matched`	Boolean / String	Indicates whether the submitted record matched.
`Age`	String	Age value or age range.
`Education`	String	Education code or education level.
`Marital_Status`	String	Marital status code.
`Gender`	String	Gender value.
`Income`	String	Income value or range.
`Home_Owner`	String	Homeowner, probable homeowner, or renter code.
`LengthOfResidence`	String	Length of residence.
`Dwelling_Type`	String	Dwelling type code.
`Home_Value`	String	Home value range.
`Signal_Seller_Score`	String	Home seller likelihood score.
`Signal_Solar_Intenders`	String	Solar interest or intent score.
`Loan_Amount_Range`	String	Loan amount range.
`HomePurchase_Range`	String	Home purchase price range.
`NLTV`	String	Net loan-to-value ratio range.
`CREDIT_RANGE`	String	Credit range.
`EST_LoanBalance_Range`	String	Estimated loan balance range.
`OrderAmount`	String	Amount charged for returned matches.
`Count`	String / Integer	Number of returned values or matched records.
`ProcessedTime`	String	Total processing time.
`Status`	Boolean / String	Indicates overall request status.
`Message`	String	Null when successful, or error detail when applicable.

Errors

The API may return one of the following error messages if the request cannot be completed.

Module does not exist.The specified module does not exist or the AppendModule name is invalid.

User not found.The API key is invalid or the user associated with the API key was not found.

Getting 401 Error.The user does not have access to this API.

Append Request not found.The specified append request could not be found or the token is invalid.

Improper JSON Data. Please check.The JSON data in the request does not match the expected format.

It seems like API has an issue. Please contact Support.There may be an issue with the API. Contact Datazapp support for assistance.