Docs › API reference › Phone verification

Phone validate

Parses, validates and gets location information about a phone number. Use it to validate local and international numbers in any country, find the location of a number, and reformat it into local and international dialling formats.

POSThttps://api.screenlyyid.com/api/v1/phone-validate

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key
`x-correlation-id`	string (uuid)	No	Correlation ID for this customer check

Request body#

Field	Type	Required
`PhoneNumber`	string	No
`CountryCode`	string	No
`IpAdress`	string	No

Responses#

Status	Description
`200`	Successful response

Response body (200)#

Field	Type	Required
`Valid`	boolean	Yes
`Country`	string	No
`CountryCode`	string	No
`PrefixNetwork`	string	No
`InternationalNumber`	string	No
`Location`	string	No
`LocalNumber`	string	No
`Type`	string	No
`CurrencyCode`	string	No
`InternationalCallingCode`	string	No
`IsMobile`	boolean	Yes
`CountryCode3`	string	No

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/phone-validate' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "PhoneNumber": "+61412345678",
  "CountryCode": "AU",
  "IpAdress": "<IpAdress>"
}'

const body = {
  "PhoneNumber": "+61412345678",
  "CountryCode": "AU",
  "IpAdress": "<IpAdress>"
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/phone-validate",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID",
      "Content-Type": "application/json"
    },
    "body": JSON.stringify(body)
  }
);

const result = await response.json();

import requests

payload = {
    "PhoneNumber": "+61412345678",
    "CountryCode": "AU",
    "IpAdress": "<IpAdress>"
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/phone-validate',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID"
    },
    json=payload
)
result = response.json()

using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var json = @"{
  ""PhoneNumber"": ""+61412345678"",
  ""CountryCode"": ""AU"",
  ""IpAdress"": ""<IpAdress>""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/phone-validate", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();