v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Validate a phone number

Performs a number validation request. This is a paid service. For pricing check here

post/numbervalidator

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

application/json

Request body

getPortedboolean

Indicates if the number validator result will concern the number's ported network (only if the number is ported). Pricing differs if you select this option. Visit here for pricing information. Default value: false

tostring required

The number that the number validator service will use. Format with a '+' and country code (E.164 format).

hoststring

The host name or the IP address. This field is used in order to get information about the country of an IP or a domain name.

Response

200

tostring

createdAtstring

getPortedboolean

numberValidatorIdstring

applicationNamestring

validboolean

Example response

{
  "to": "+306932XXXXXX",
  "createdAt": "2017-01-24T09:22:11.627Z",
  "getPorted": true,
  "numberValidatorId": "b2bff937-15eb-473f-b5bc-ba377acf03ba",
  "details": {
    "type": "mobile",
    "ported": true,
    "network": "Cosmote (OTE)",
    "networkCode": "20201",
    "countryCode": "GRC",
    "countryPrefix": "30"
  },
  "formats": {
    "international": "+30 693 2XX XXXX",
    "national": "693 2XX XXXX",
    "rfc3966": "tel:+30-693-2XX-XXXX"
  },
  "geo": {
    "host": "www.testdomain.com",
    "country": "Netherlands",
    "countryISO2Code": "NL",
    "countryISO3Code": "NLD",
    "continent": "EU"
  },
  "applicationName": "default",
  "valid": true
}