Authentication
Authentication is done using HTTP header x-api-key.

Please contact your account administrator if you need help locating your key or contact support@spendid.io

cURL

-H "x-api-key: {api_key}"
JSON

{
“message”: “Forbidden”
}

Demographics
The Demographics object contains demographic information describing a consumer. It is the basis for the SPENDiD algorithm.

This is an object representing a consumer demographic profile. It is required by all requests and is used as the basis for the SPENDiD algorithm.

JSON

{
“gross_annual_income”: 71672,
“net_annual_income”: 57648,
“age”: 40,
“household_members”: 4,
“zip”: “25892”,
“is_homeowner”: true
}
property type description default
gross_annual_income number income (before taxes) for all earners in the family optional
net_annual_income number income after taxes for all earners in the family. This is considered a constraint for budget models required
age int age (years) of the primary earner optional
household_members int head count of the household. optional
zip string ZIP code. required
is_homeowner bool indicates whether household owns or rents their home false