Phone Verification

Performs batch phone number verification.

This endpoint is for batch phone number verification with a maximum batch size of 10.

post/v1/phone-numbers/validate/batch

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/phone-numbers/validate/batch
  • 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

Example request

{
  "phoneNumbers": [
    {
      "id": "2",
      "phoneNumber": "9712345731",
      "country": "CAN"
    }
  ]
}

Response

Batch phones verified successfully

Example response

{
  "responses": [
    {
      "status": "OK",
      "id": "1",
      "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"
      },
      "code": "DIS-1003",
      "detail": "Issue with internal services. Please try again after sometime"
    }
  ]
}

Changes

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