Number validator

Retrieve validation results

Returns the results of an asynchronous batch validation identified by request_id.

get/v1/validation/{request_id}

Path parameters

request_idstring required
Example:12542c5c-1a17-4d12-a163-5b68543e75f6

The request_id returned by the asynchronous bulk validation request.

Response

Returns the batch validation results.

statusstring required

Request status. Possible values are success and in progress.

  • success: All numbers were processed. - in progress: Several numbers are pending validation.
pendinginteger required

The quantity of phone numbers that are pending to be processed.

countinteger required

The quantity of phone numbers passed in the request.

Example response

{
  "status": "success",
  "pending": 10,
  "count": 1000,
  "items": [
    {
      "phone_number": "971501390098",
      "valid": true,
      "country_code": "AE",
      "e164_format": "+971501390098",
      "national_format": "050 139 0098",
      "ported": false,
      "mcc": "424",
      "mnc": "02",
      "number_type": "mobile",
      "carrier_name": "Etisalat",
      "risky_destination": false,
      "unallocated_range": false,
      "reachable": true,
      "roaming": false,
      "timezone": "UTC+04:00",
      "charge": "0.015",
      "error_code": "000"
    },
    {
      "phone_number": "971504359195",
      "valid": true,
      "country_code": "AE",
      "e164_format": "+971504359195",
      "national_format": "050 435 9195",
      "ported": false,
      "mcc": "424",
      "mnc": "02",
      "number_type": "mobile",
      "carrier_name": "Etisalat",
      "risky_destination": false,
      "unallocated_range": false,
      "reachable": true,
      "roaming": false,
      "timezone": "UTC+04:00",
      "charge": "0.015",
      "error_code": "000"
    }
  ]
}

Changes

Changed in 3 of the 50 revisions of this API.1921

    • removed the optional property error_code from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error_code from the response with the 404 status

      response-optional-property-removed

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/carrier_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/country_code became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/mcc became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/mnc became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/number_type became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/ported became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/risky_destination became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/timezone became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/unallocated_range became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/carrier_name became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/mcc became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/mnc became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/number_type became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/ported became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/reachable became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/risky_destination became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/roaming became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/timezone became optional for the status 200

      response-property-became-optional

    • the response property allOf[subschema #1: PhoneValidationBatchResultResponse]/items/items/unallocated_range became optional for the status 200

      response-property-became-optional