Number validator

Validate multiple numbers

Validates a batch of phone numbers. When async is true, returns a request_id to poll for results instead of the validation details.

post/v1/validation

Request body

phone_numbersstring[] required

List of phone numbers to get detailed information about.

type'format' | 'analysis' | 'validation' required

Depth of validation to perform on the phone number. One of format (checks number syntax only), analysis (returns number metadata such as type and country), or validation (performs a live network lookup of the number's current status).

asyncboolean required

Indicates whether the request should be executed asynchronously. If true, the response will include a request_uuid that can be used to poll for results. If false, the response will include validation results directly.

forceboolean required

Indicates whether to force a fresh validation instead of returning a previously cached result.

Example request

{
  "phone_numbers": [
    "971501390098",
    "971504359195"
  ],
  "async": true,
  "force": true
}

Response

Returns the validation results, or a request_id when validation is asynchronous.

OR

Example response

{
  "status": "success",
  "count": 1000,
  "items": [
    {
      "phone_number": "971569483322",
      "valid": true,
      "country_code": "AE",
      "e164_format": "+971569483322",
      "national_format": "056 948 3322",
      "mcc": "424",
      "mnc": "004",
      "number_type": "mobile",
      "carrier_name": "Etisalat",
      "reachable": true,
      "timezone": "UTC+04:00",
      "charge": "0.015",
      "error_code": "000"
    }
  ]
}

Changes

Changed in 5 of the 50 revisions of this API.20310

  • 76b9bb35619f12See the full diff
    • removed the optional property error_code from the response with the 403 status

      response-optional-property-removed

    • added subschema #2: Async Request to the response body anyOf list for the response status 200

      response-body-any-of-added

    • removed subschema #2 from the response body anyOf list for the response status 200

      response-body-any-of-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 anyOf[subschema #1: PhoneValidationBatchResponse]/items/items/carrier_name became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-became-optional

  • 2e48fd9894e1126See the full diff
    • added PhoneValidationRequest to the request body allOf list

      request-body-all-of-added

    • removed ValidationRequest subschema #2 from the request body allOf list

      request-body-all-of-removed

    • removed the optional property anyOf[subschema #2]/request_uuid from the response with the 200 status

      response-optional-property-removed

    • api operation id Validatemultiplephonenumbers removed and replaced with number_validator_create_bulk

      api-operation-id-removed

    • api tag Number validator added

      api-tag-added

    • api tag Number Validator removed

      api-tag-removed

    • added PhoneValidationBatchResponse to the response body anyOf list for the response status 200

      response-body-any-of-added

    • removed Validatemultiplenumbersresponse from the response body anyOf list for the response status 200

      response-body-any-of-removed

    • added the optional property anyOf[subschema #2]/request_id to the response with the 200 status

      response-optional-property-added

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

    • endpoint added

      endpoint-added