Phone Verification

Performs single phone number verification.

This endpoint is for single phone number verification.

post/v1/phone-numbers/validate

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/phone-numbers/validate
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

phoneNumberstring required

Phone number to be verified. Include the country code if applicable.

countrystring

Optional country code in ISO2 or ISO3 format to assist in phone number verification.

Example request

{
  "phoneNumber": "+1234567890",
  "country": "US"
}

Response

Phone verified successfully

Example response

{
  "response": {
    "status": "OK",
    "phoneNumber": {
      "callingCountryCode": "1",
      "country": "CAN",
      "mobileCountryCode": "310",
      "mobileNetworkCode": "010",
      "carrierName": "Verizon Wireless",
      "phoneType": "mobile",
      "nationalNumberFormat": "(706) 306-2767",
      "formattedPhoneNumber": "17063062767",
      "validStatus": true,
      "validationDescription": "Phone number validation successful.",
      "qualityScore": "0.95"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.