Phone Verification Response - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Below are the response fields w.r.t Batch Phone validation. For Single Phone validation root element will be response:

Table 1. Response
Field Type Description
responses.id Unique id Optional parameter which will tag along with result when passed at the time of input.
responses.status Status Status of the response.
responses.phoneNumber Result array Result of phone validation.
responses.phoneNumber.callingCountryCode String International dialling prefix of the phone number defined in the E.164 standard.
responses.phoneNumber.country String The phone number's ISO country code.
responses.phoneNumber.mobileCountryCode String The three digit mobile country code of the carrier, used with the mobile network code to identify a mobile network operator.
responses.phoneNumber.mobileNetworkCode String The two-three digit mobile network code of the carrier, used with the mobile country code to identify a mobile network operator (only returned for mobile numbers).

responses. phoneNumber.carrierName

 String The name of the carrier; subject to change.

responses.phoneNumber.phoneType

 String The following are the possible values for the phoneType

landline: The phone number is a landline number; generally not capable of receiving SMS messages.

mobile: The phone number is a mobile number; generally capable of receiving SMS messages.

fixedVoip: A virtual phone number associated with a physical device (e.g., Comcast or Vonage).

nonFixedVoip: A virtual phone number that can be obtained on the internet without the need for a physical device (e.g., Google Voice or Enflick).

personal: A phone number designated for personal use.

tollFree: A toll-free phone number, which is one where calls are free for the calling party.

premium: A premium rate phone number, which typically charges higher than normal rates for special services.

sharedCost: A shared cost phone number, which is one where the charge is partially paid by the calling party and charges higher than normal rates.

uan: A universal access number, which is a national number which can route incoming calls to different destinations.

voicemail: A phone number associated with a voicemail service.

pager: A phone number associated with a pager device.

unknown: A valid phone number, but the line type could not be determined.
responses.phoneNumber.nationalNumberFormat String The phone number in national format.
responses.phoneNumber.formattedPhoneNumber String The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.
response.phoneNumber.validStatus Boolean Only valid phone numbers will return results. If you attempt to lookup a phone number which is invalid, you will receive validStatus: false in the response.
response.phoneNumber.validationDescription String

In some cases you will also receive a reason for the validation failure in the validationDescription field.

The following are the possible values:

TOO_SHORT

TOO_LONG

INVALID_BUT_POSSIBLE

INVALID_COUNTRY_CODE

INVALID_LENGTH

NOT_A_NUMBER

Phone Verification API sample response:

Below is a sample Single Phone Verification API Response:
{
    "response": {
        "status": "OK",
        "phoneNumber": {
            "callingCountryCode": "1",
            "country": "US",
            "mobileCountryCode": "310",
            "carrierName": "Teleport Communications America, LLC",
            "phoneType": "landline",
            "nationalNumberFormat": "(414) 465-4885",
            "formattedPhoneNumber": "+14144654885",
            "validStatus": true
        }
    }
}
Below is a sample Batch Phone Verification API Response:
{
    "responses": [
        {
            "status": "OK",
            "id": "1",
            "phoneNumber": {
                "callingCountryCode": "1",
                "country": "US",
                "mobileCountryCode": "310",
                "carrierName": "Teleport Communications America, LLC",
                "phoneType": "landline",
                "nationalNumberFormat": "(414) 465-4885",
                "formattedPhoneNumber": "+14144654885",
                "validStatus": true
            }
        },
        {
            "status": "OK",
            "id": "1",
            "phoneNumber": {
                "nationalNumberFormat": "4144",
                "formattedPhoneNumber": "14144",
                "validStatus": false,
                "validationDescription": "TOO_SHORT"
            }
        }
    ]
}

Error Codes

Phone Verification API will return the following error codes in case of any error:
Table 2. Error Codes
Error Code Description
DIS-1001 Invalid token
DIS-1002 Not Authorized to access this API
DIS-1003 Issue with internal services
DIS-PV-1001 Batch size must not exceed 10
DIS-PV-1002 PhoneNumber can not be null or empty
DIS-PV-1003 Request is not valid
DIS-PV-1004 Required body is not specified