Premium Economic Insights API

Description

Leverages top-tier consumer analytics and covers nearly every household in the United States to provide comprehensive visibility into household financial status for income, spending, credit, and debt.

Request URL

https://api.rrdblive.com/DDM/WebService.cfc?method=process

Supported HTTP methods: GET or POST

Authentication Parameters

ClientID	Your "Client ID"
CWSID	Your "Client Web Service ID"
Token	A token that is authorized to process this web service request

Required Parameters

FirstName	Contact's first name
LastName	Contact's last name
MailAddress1	Contact's street address
PostalZipCode	Contact's zip code

Optional Parameters

MailAddress2	Contact's street address line 2 (if applicable)
CityName	Contact's city name
ProvinceStateName	Contact's state name or code
PhoneNumber	Contact's phone number
EmailAddress	Contact's email address

Parameters may be passed as either URL query parameters or posted as FORM fields

Response JSON

{
    "success": true,
    "errors": [],
    "dataIn": [
        {
            "FirstName": "",
            "LastName": "",
            "MailAddress1": "",
            "MailAddress2": "",
            "CityName": "",
            "ProvinceStateName": "",
            "PostalZipCode": "",
            "PhoneNumber": "",
            "EmailAddress": ""
        }
    ] ,
    "dataOut": [
        {
            "CityName": "",
            "ECON_ActiveCreditAccountsLevel": "",
            "ECON_CreditScoreLevel": "",
            "ECON_CreditUtilizationLevel": "",
            "ECON_DebtToIncomeLevel": "",
            "ECON_HouseholdAffluenceRating": "",
            "ECON_HouseholdIncome": "",
            "ECON_HouseholdIncomeLevel": "",
            "ECON_HouseholdSpending": "",
            "ECON_HouseholdSpendingLevel": "",
            "ECON_HouseholdStabilityRating": "",
            "EmailAddress": "",
            "FirstName": "",
            "LastName": "",
            "MailAddress1": "",
            "MailAddress2": "",
            "PhoneNumber": "",
            "PostalZipCode": "",
            "ProvinceStateName": ""
        }
    ]
}

Response Keys

Key	Description
success	"true" if request was successful / "false" if errors occurred
errors	If "success" was "false", will contain an array of error objects. See below for sample error response.
dataIn	The original input data
dataOut	If "success" was "true", will return the phone validation results

"dataOut" Fields

Name	Description
CityName	Contact's city name
ECON_ActiveCreditAccountsLevel	Economic Insights: Active Credit Accounts Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_CreditScoreLevel	Economic Insights: Credit Score Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_CreditUtilizationLevel	Economic Insights: Credit Utilization Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_DebtToIncomeLevel	Economic Insights: Debt To Income Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_HouseholdAffluenceRating	Economic Insights: Household Affluence Rating Range from 1 to 1000
ECON_HouseholdIncome	Economic Insights: Household Income Annual $ Amount (Integer)
ECON_HouseholdIncomeLevel	Economic Insights: Household Income Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_HouseholdSpending	Economic Insights: Household Spending Annual $ Amount (Integer)
ECON_HouseholdSpendingLevel	Economic Insights: Household Spending Level VERY_HIGH / HIGH / MEDIUM / LOW / VERY_LOW
ECON_HouseholdStabilityRating	Economic Insights: Household Stability Rating Range from 1 to 1000
EmailAddress	Contact's email address
FirstName	Contact's first name
LastName	Contact's last name
MailAddress1	Contact's street address
MailAddress2	Contact's street address line 2 (if applicable)
PhoneNumber	Contact's phone number
PostalZipCode	Contact's zip code
ProvinceStateName	Contact's state name or code

Sample Error Response JSON

{
    "success": false,
    "errors": [
        {
            "errorID": 1000,
            "errorHeader": "Authentication Failed",
            "errorMessage": "API user access denied"
        }
    ]
}

4xx HTTP Status Code will be returned for all of the following:

errorID	errorHeader	errorMessage
400	API Error	Depends on the cause of error
403	API Error	This API supports HTTPS only
500	Unexpected Error	Depends on the cause of error
1000	Authentication Failed	Depends on the cause of error
2000	Validation Error	Required fields are missing or blank
35030	Web Service Error	Active web service was not found
35040	Web Service Error	The supplied Token is not authorized for use with this CWSID
35050	Web Service Error	No data was submitted
35060	Web Service Error	Depends on the cause of error
35070	Web Service Error	This web service supports only one record at a time