Phone Risk API

Description

Performs a score-based risk assessment (with recommended allow/flag/block actions) that takes a phone number as the primary input, along with the end-user IP address and the email address. Leverages a worldwide fraud data consortium, to analyze and assess any risks linked to the data. Identifies unusual patterns or behaviors that might indicate fraudulent activities. Risk can come from multiple vectors including known fraud tied to the data, suspicious traffic patterns & activity, and usage velocity abnormalities.

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

At least one of the following fields (or combinations) are required:

PhoneNumber

Contact's phone number

Optional Parameters

EmailAddress	Contact's email address
LeadIPAddress	Contact's IP address

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

Response JSON

{
    "success": true,
    "errors": [],
    "dataIn": [
        {
            "PhoneNumber": "",
            "EmailAddress": "",
            "LeadIPAddress": ""
        }
    ],
    "dataOut": [
        {
            "EmailAddress": "",
            "LeadIPAddress": "",
            "PhoneCarrierName": "",
            "PhoneLineType": "",
            "PhoneNumber": "",
            "RiskAction": "",
            "RiskLevel": "",
            "RiskScore": ""
        }
    ]
}

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 risk assessment results

"dataOut" Fields

Name	Description
PhoneCarrierName	Name of the phone carrier
PhoneLineType	FIXED_LINE MOBILE PREPAID TOLL_FREE VOIP OTHER
PhoneNumber	Standardized phone number
RiskAction	ALLOW BLOCK FLAG
RiskLevel	VERY_LOW LOW MEDIUM HIGH VERY_HIGH
RiskScore	Value from 0-1000

Risk Score Details

Score	Risk Level	Action
0-200	VERY_LOW	ALLOW
201-400	LOW	ALLOW
401-600	MEDIUM	FLAG
601-800	HIGH	BLOCK
801-1000	VERY_HIGH	BLOCK

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