Phone Identity API

Description

Retrieves a wealth of information regarding a given phone number, encompassing its line type, the carrier name, and the contact details tied to that number. Identifies the number as belonging to a business or person. For businesses, the industry type is returned, otherwise age range and gender are returned.

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

PhoneNumber

Contact's phone number

Optional Parameters

FirstName	Contact's first name
LastName	Contact's last name
PostalZipCode	Contact's zip code

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

Response JSON

{
    "success": true,
    "errors": [],
    "dataIn": [
        {
            "PhoneNumber": ""
        }
    ] ,
    "dataOut": [
        {
            "AgeRange": "",
            "AlternateNames": "",
            "CityName": "",
            "CountryName": "",
            "EmailAddress": "",
            "FirstName": "",
            "Gender": "",
            "LastName": "",
            "MailAddress1": "",
            "MailAddress2": "",
            "MiddleName": "",
            "OwnerIndustry": "",
            "OwnerName": "",
            "OwnerType": "",
            "PhoneCarrierName": "",
            "PhoneLineType": "",
            "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 intelligence results

"dataOut" Fields

Name	Description
AgeRange	Phone contact's age range if a person
AlternateNames	Array of the contact's alternate names if a person
CityName	Phone contact's city name
CountryName	Phone contact's country code
EmailAddress	Phone contact's email address
FirstName	Phone contact's first name if a person
Gender	Phone contact's gender if a person
LastName	Phone contact's last name if a person
MailAddress1	Phone contact's postal address line 1
MailAddress2	Phone contact's postal address line 2 (usually blank)
MiddleName	Phone contact's middle name if a person
OwnerIndustry	Phone contact's industry if a business
OwnerName	Phone contact's name
OwnerType	Business or Person
PhoneCarrierName	Name of the phone carrier
PhoneLineType	FIXED_LINE MOBILE PREPAID TOLL_FREE VOIP OTHER
PhoneNumber	Standardized phone number
PostalZipCode	Phone contact's postal code
ProvinceStateName	Phone contact's province or state

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