API Overview - Datafinder is a service of Versium

Financial, Household and Auto Append Documentation

Financial, Household and Auto Append API Overview

Datafinder's Consumer Financial, Household and Auto Append API service allows you to input basic contact information from your CRM and append LifeData to your customer list. Gain insight into your customer's finances such as their household income or what type of car they drive.

Request URL

https://api.datafinder.com/v2 /qdf.php?k2={your-key}&service=finhouse

Parameters

Config Parameters

Use the config parameters to adjust elements like the output language.

Name	Description	Required?
k2	Your api key	Yes
service	Which API service to use. Use "finhouse" in this case.	Yes
output	Specify json or xml output responses. Default is JSON. Example:output=json
cfg_mc	Specify the required match codes for a result to be returned. Example: cfg_mc=LF,ACSZ For a list of all match codes, see the Match Codes page.

Search Parameters

Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.

NOTE: d_first and d_last are required for an individual level match.

Name	Description
d_first	A first name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_first=john
d_last	A last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_last=Doe
d_fullname	A first and last name. Requires: d_email or d_phone or d_fulladdr, d_city, d_state or d_fulladdr,d_zip or d_dob or d_lat,d_long Example:d_fullname=john smith
d_zip	A 5 digit zip code in the USA. Requires: d_fulladdr Example:d_zip=87402
d_fulladdr	Entire house number + street + suite (e.g. "7530 164th Ave NE, Ste A204") Requires: d_city,d_state or d_zip Example:d_fulladdr=123 lucky ln
d_city	A city in the USA. Requires: d_fulladdr,d_state Example: d_city=Anaheim
d_state	Two letter state abbreviation Requires: d_fulladdr,d_city or d_fulladdr,d_zip Example: d_state=CO
d_phone	Ten digits NPANXXNNNN Example: d_phone=8003950164
d_email	Valid email address Example: d_email=account_name@domain.com
d_lat,d_long	latitude / longitude Example: d_long=74.0059,d_lat=40.7127
d_ip	IP Address Example: 127.0.0.1

Output Fields

The API results will follow the schema shown below and will include:

version - api version
query-id - id unique to each query
results - list of append results
input-query - list of input search parameters and their values
num-results - number of match records for the given search parameters
query-time - how long the processing took
page-time - how long the lookup took

For a list of fields returned, please see the examples section below.

Output schema in JSON:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxxxxx",
    "results": [
      {
        "key": "value"
      }
    ],
    "input-query": {
      "key": "value"
    },
    "num-results": 1,
    "query-time": "0.000",
    "page-time": "0.000"
  }
}

If we cannot match the input search parameters to a record then no results will be returned. The result would appear as follows:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxx",
    "input-query": {
      "FirstName": "John",
      "LastName": "Doe",
      "EmailAddr": "john.doe@domain.com"
    },
    "num-results": 0,
    "query-time": "0.138",
    "page-time": "0.193"
  }
}

Example Queries and Response

Search for contact information using a phone and first/last name:

https://api.datafinder.com/v2 /qdf.php?k2=key&service=finhouse &d_phone=5555555555&d_first=jane&d_last=doe

                               
{
  "datafinder": {
    "version": "2.0",
    "query-id": "90436072acb5ae217b92a8562d687e27",
    "results": [
      {
        "#RawScore": 25,
        "#WeightedScore": 25,
        "#RawMatchCodes": "P0",        
        "FirstName": "Jane",
        "MiddleName": "J",
        "LastName": "Doe",
        "Address": "555 10th st",
        "City": "Seattle",
        "State": "WA",
        "Zip": "98055",
        "Zip4": "4988",
        "Phone": "5555555555",
        "TimeStamp": "20131200",
        "EstimatedHouseholdIncome": "< $50,000",
        "LengthOfResidence": "11 - 15 years",
        "HomePurchaseDate": "199610",
        "HomePurchasePrice": "$250,000-299,999",
        "DwellingType": "S",
        "NumberCreditLines": "4",
        "CreditCardUser": "YES",
        "CardHolderGasDeptRetail": "YES",
        "AutoYear": "2006",
        "AutoMake": "MITSUBISHI",
        "AutoModel": "ECLIPSE",
        "AutoEdition": "GS",
        "HomeValue": "$300,000-349,999",
        "EstWealth": "$100,000-249,999",
        "UpscaleCardHolder": "YES"
      }
    ],
    "input-query": {
      "Phone": "5555555555",
      "FirstName": "Jane",
      "LastName": "Doe",
    },
    "num-results": 1,
    "query-time": "0.628",
    "page-time": "6.615"
  }
}