Numverify

https://numverify.com/documentation
Admin
Numverify is a RESTful JSON API for phone number validation and information lookup supporting 232...
Tokens:3,611
Snippets:42
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### JSONP Callback Example Query

Source: https://numverify.com/documentation

Example API request URL demonstrating the use of JSONP callbacks. Append 'callback=CALLBACK_FUNCTION' to enable this feature.

```http
http://apilayer.net/api/validate?callback=CALLBACK_FUNCTION
```

--------------------------------

### JSONP Callback Example Response

Source: https://numverify.com/documentation

Example API response when using JSONP callbacks. The result set is wrapped in the specified callback function.

```json
CALLBACK_FUNCTION ({
{
  "valid": true,
  "number": "14158586273",
  "local_format": "4158586273",
  "international_format": "+14158586273",
  "country_prefix": "+1",
  "country_code": "US",
  "country_name": "United States of America",
  "location": "Novato",
  "carrier": "AT&T Mobility LLC",
  "line_type": "mobile"
}
})
```

--------------------------------

### Country and Location Data Example

Source: https://numverify.com/documentation

Example JSON snippet showing the country code, country name, and location data returned for a valid phone number.

```json
"country_code": "US",
"country_name": "United States of America",
"location": "Novato",
```

--------------------------------

### Fetch Supported Countries (JavaScript)

Source: https://numverify.com/documentation

Example using JavaScript's fetch API to retrieve the list of supported countries from the numverify API.

```javascript
const url = 'https://apilayer.net/api/countries?access_key={PASTE_YOUR_API_KEY_HERE}';
   const options = {
      method: 'GET'
   };

   try {
      const response = await fetch(url, options);
      const result = await response.text();
      console.log(result);
   } catch (error) {
      console.error(error);
   }
```

--------------------------------

### Standard API Response Format

Source: https://numverify.com/documentation

Example of the JSON object returned by the API upon a successful validation request.

```json
{
  "valid": true,
  "number": "14158586273",
  "local_format": "4158586273",
  "international_format": "+14158586273",
  "country_prefix": "+1",
  "country_code": "US",
  "country_name": "United States of America",
  "location": "Novato",
  "carrier": "AT&T Mobility LLC",
  "line_type": "mobile"
}
```

--------------------------------

### Enable JSON Formatting

Source: https://numverify.com/documentation

Example API request URL showing how to enable JSON formatting by appending '&format=1'. This enhances readability but may increase response size.

```http
http://apilayer.net/api/validate
    ? access_key = YOUR_ACCESS_KEY
    [...]
    & format = 1
```

--------------------------------

### API Error Response Example

Source: https://numverify.com/documentation

An example of an API error response when no phone number is provided. It includes a success status, error code, type, and an informational message.

```json
{
  "success": false,
  "error": {
    "code": 210,
    "type": "no_phone_number_provided",
    "info": "Please specify a phone number. [Example: 14158586273]"
  }
}
```

--------------------------------

### GET /api/countries

Source: https://numverify.com/documentation

Retrieves a list of all supported countries, including their names and dialling codes.

```APIDOC
## GET /api/countries

### Description
Returns a comprehensive list of all 232 supported countries and territories.

### Method
GET

### Endpoint
http://apilayer.net/api/countries

### Parameters
#### Query Parameters
- **access_key** (string) - Required - Your API access key

### Response
#### Success Response (200)
- **[country_code]** (object) - Object containing country_name and dialling_code
```

--------------------------------

### Carrier Detection Example

Source: https://numverify.com/documentation

The API returns a 'carrier' object containing the name of the phone number's registered carrier. Carrier information may not always be available.

```json
{
"carrier": "AT&T Mobility LLC",
[...] 
}
```

--------------------------------

### Line Type Detection Example

Source: https://numverify.com/documentation

The API detects the 'line_type' of a phone number, which can be 'mobile', 'landline', 'special_services', 'toll_free', 'premium_rate', 'satellite', or 'paging'. This helps determine communication compatibility.

```json
{
"line_type": "mobile"
}
```

--------------------------------

### GET /api/validate

Source: https://numverify.com/documentation

Validates a phone number by providing the number and an access key. Supports optional JSONP callbacks and JSON formatting for debugging.

```APIDOC
## GET /api/validate

### Description
Validates a given phone number and returns details such as country, location, carrier, and line type.

### Method
GET

### Endpoint
http://apilayer.net/api/validate

### Parameters
#### Query Parameters
- **access_key** (string) - Required - Your unique API access key.
- **number** (string) - Required - The phone number to validate.
- **callback** (string) - Optional - Name of the callback function for JSONP support.
- **format** (integer) - Optional - Set to 1 to enable human-readable JSON formatting (for debugging only).

### Request Example
http://apilayer.net/api/validate?access_key=YOUR_ACCESS_KEY&number=14158586273

### Response
#### Success Response (200)
- **valid** (boolean) - Indicates if the number is valid.
- **number** (string) - The validated phone number.
- **local_format** (string) - The local format of the number.
- **international_format** (string) - The international format of the number.
- **country_prefix** (string) - The country calling code.
- **country_code** (string) - The 2-letter country code.
- **country_name** (string) - The full country name.
- **location** (string) - The city, state, or county of the number.
- **carrier** (string) - The service provider.
- **line_type** (string) - The type of line (e.g., mobile, landline).

#### Response Example
{
  "valid": true,
  "number": "14158586273",
  "local_format": "4158586273",
  "international_format": "+14158586273",
  "country_prefix": "+1",
  "country_code": "US",
  "country_name": "United States of America",
  "location": "Novato",
  "carrier": "AT&T Mobility LLC",
  "line_type": "mobile"
}
```

--------------------------------

### GET /api/validate

Source: https://numverify.com/documentation

Validates a phone number. For national format numbers, a country_code is required. For international numbers, do not include a country_code.

```APIDOC
## GET /api/validate

### Description
Validates a phone number and returns details including carrier and line type.

### Method
GET

### Endpoint
http://apilayer.net/api/validate

### Parameters
#### Query Parameters
- **access_key** (string) - Required - Your API access key
- **number** (string) - Required - The phone number to validate
- **country_code** (string) - Optional - 2-digit country code (required for national format numbers)

### Response
#### Success Response (200)
- **carrier** (string) - The name of the carrier the number is registered with
- **line_type** (string) - The type of line (e.g., mobile, landline, toll_free)
```

--------------------------------

### JavaScript Fetch API Number Validation

Source: https://numverify.com/documentation

Example using JavaScript's Fetch API to validate a phone number. Replace '{PASTE_YOUR_API_KEY_HERE}' with your actual API key.

```javascript
const url = 'https://apilayer.net/api/validate?access_key={PASTE_YOUR_API_KEY_HERE}&number=14158586273';
   const options = {
      method: 'GET'
   };

   try {
      const response = await fetch(url, options);
      const result = await response.text();
      console.log(result);
   } catch (error) {
      console.error(error);
   }
```

--------------------------------

### Optional API Parameters

Source: https://numverify.com/documentation

Additional parameters for specifying country codes, formatting JSON output, or defining JSONP callbacks.

```text
country_code     specify a country code if you intend to
                 use a national phone number for your request

format           set to "1" in order to request prettified
                 JSON result set (use only for debugging!)

callback         append your preferred JSONP callback function
                 name. (See "JSONP Callbacks" section)
```

--------------------------------

### List Supported Countries (JSON)

Source: https://numverify.com/documentation

Access a comprehensive list of supported countries, including names and dialling codes, by appending your API access key to the countries endpoint.

```json
{
"AF": {
"country_name": "Afghanistan",
"dialling_code": "+93"
},
"AL": {
"country_name": "Albania",
"dialling_code": "+355"
},
"DZ": {
"country_name": "Algeria",
"dialling_code": "+213"
},
"AS": {
"country_name": "American Samoa",
"dialling_code": "+1"
},
[...]
}
```

--------------------------------

### Authenticate with Numverify API

Source: https://numverify.com/documentation

Attach your personal access key to the base endpoint URL to authenticate requests.

```http
http://apilayer.net/api/validate?access_key=YOUR_ACCESS_KEY
```

--------------------------------

### Make a Phone Number Validation Request

Source: https://numverify.com/documentation

Perform a validation request by providing the access_key and the phone number to be validated.

```http
http://apilayer.net/api/validate
    ? access_key = YOUR_ACCESS_KEY
    & number = 14158586273
```

--------------------------------

### Countries Endpoint URL

Source: https://numverify.com/documentation

The URL for the countries endpoint, requiring your personal API access key.

```http
http://apilayer.net/api/countries?access_key=YOUR_ACCESS_KEY
```

--------------------------------

### Phone Number Validation API

Source: https://numverify.com/documentation

This endpoint validates phone numbers and provides detailed information such as country, location, carrier, and line type.

```APIDOC
## GET /api/validate

### Description
Validates a phone number and returns detailed information including validity, formatting, country, location, carrier, and line type.

### Method
GET

### Endpoint
http://apilayer.net/api/validate

### Parameters
#### Query Parameters
- **access_key** (string) - Required - Your unique API Access Key for authentication.
- **number** (string) - Required - The phone number to validate. Example: 14158586273
- **country_code** (string) - Optional - Specify a country code if using a national phone number. Example: US
- **format** (integer) - Optional - Set to "1" for a prettified JSON result set (for debugging).
- **callback** (string) - Optional - Append your preferred JSONP callback function name.

### Request Example
```json
{
  "access_key": "YOUR_ACCESS_KEY",
  "number": "14158586273"
}
```

### Response
#### Success Response (200)
- **valid** (boolean) - Returns true if the specified phone number is valid.
- **number** (string) - The phone number you specified, stripped of any special characters.
- **local_format** (string) - The local (national) format of the specified phone number.
- **international_format** (string) - The international format of the specified phone number.
- **country_prefix** (string) - The international country dial prefix.
- **country_code** (string) - The 2-letter country code.
- **country_name** (string) - The full country name.
- **location** (string) - The city, state, or county, if available.
- **carrier** (string) - The name of the carrier the phone number is registered with.
- **line_type** (string) - The line type of the phone number.

#### Response Example
```json
{
  "valid": true,
  "number": "14158586273",
  "local_format": "4158586273",
  "international_format": "+14158586273",
  "country_prefix": "+1",
  "country_code": "US",
  "country_name": "United States of America",
  "location": "Novato",
  "carrier": "AT&T Mobility LLC",
  "line_type": "mobile"
}
```
```

--------------------------------

### Validate National Phone Number

Source: https://numverify.com/documentation

To validate a phone number in its national format, append the 2-digit country code to the 'country_code' parameter in the API request URL.

```http
http://apilayer.net/api/validate
    ? access_key = YOUR_ACCESS_KEY
    & number = 4158586273
    & country_code = US
```
Tokens:
Raw