Improve your ability to personalize your marketing campaigns by adding valuable demographic insights to your customer lists with consumer insights from the Demographic API. With a consumer's name, country, and one other identifying piece of information, pull rich consumer insights from the Versium database, including:
- Individual and household demographics, such as age range and marital status.
- Interests & activities
- Purchase behavior
- Finances, such as their household income
- What type of car they drive.
Format
Here's the format to call the Demographic Append API:
Example with single output type:
https://api.versium.com/v2/demographic?output[]=demographic&first=vernoca&last=queck&city=seattle
Example with multiple output types:
https://api.versium.com/v2/demographic?output[]=demographic&output[]=financial&output[]=political&first=vernoca&last=queck&city=seattle
Output Type
Output type is what the user would like to obtain from the Contact Append API. There are four different types of output type and each have required and optional parameters as described in the below table.
Output Type | Required Search Param. | Optional Search Param. |
---|---|---|
demographic | phone OR email OR Address, city, state, zip OR first, last, city, state OR first, last, zip | address_2, country |
financial | phone OR email OR Address, city, state, zip OR first, last, city, state OR first, last, zip | address_2, country |
lifestyle | phone OR email OR Address, city, state, zip OR first, last, city, state OR first, last, zip | address_2, country |
political | phone OR email OR Address, city, state, zip OR first, last, city, state OR first, last, zip | address_2, country |
full_demographic | phone OR email OR Address, city, state, zip OR first, last, city, state OR first, last, zip | address_2, country |
- The full list of attributes returned by the demographic output type can be found on the Output Sample
- The full list of attributes returned by the full_demographic output type can be found on the Full Demographic Insights page. Also please see the Output Sample of the Full Demographic API in JSON format
Inputs - what the API uses to search
Search Parameters are used as fields that the Demographic Append API will use to search at the Versium REACH back end.
This API service accepts consumer contact information in Common API Inputs and Options It matches your inputs with consumers in the Versium data and returns consumer information, as available.
value | description | example |
---|---|---|
first | A person’s first name | John |
last | A person’s last name | Smith |
address | A house/building number and street | 123 Main St |
address_2 | The unit number of an address | Apt 12 or Unit 510 |
city | A city name | Seattle |
state | A US state | WA |
zip | A 5 digit US ZIP code | 98052 |
country | A 2 digit country code (only US is supported) | US |
phone | A valid 10 digit North American phone number | 2061235555 |
A valid email address (consumer or business email) | [email protected] |
Optional Parameters
Optional Configuration Parameters are used to specify and configure how the Demographic Append API will perform the search.
Optional Config. Param. | value | description | usage |
---|---|---|---|
cfg_maxrecs | 1 (default) -> 100 | number of returned records | Can be used with all output types. |
rcfg_max_time | A whole or decimal number | Maximum allowed API run time (in seconds) | Can be used with all output types. |
cfg_required | A comma or semi-colon separated string of field names. | A list of response field names that must be populated in order for a record to be returned. If comma separated, all fields must be present. If semi-colon separated, any one of the fields must be present. Note: when using this parameter, all category attributes will be returned as long as the required ones are present. Examples: Require DOB OR Age Range cfg_required=DOB;Age Range Require Auto Make and Auto Model cfg_required=Auto Make,Auto Model | Can be used with all output types. |