API Documentation Sections
API Overview
Introduction to Check This Phone API
Overview
The Check This Phone API is a powerful tool designed to validate, format, and standardize phone numbers from around the world. It helps developers ensure that phone numbers are stored correctly, cleanly, and consistently in their databases, preventing errors caused by incorrect or improperly formatted input.
With support for 232+ countries, the API uses an advanced phone number processing engine to accurately analyze phone numbers, detect their validity, and return them in a structured format.
Key Features
β Phone Number Validation β Check if a number is valid and correctly formatted.
β Automatic Formatting β Convert phone numbers into E.164, national, international, and RFC3966 formats.
β Country Detection β Identify the country associated with a phone number.
β Carrier Lookup β Retrieve carrier information when available.
β Error Handling β Get precise error messages for invalid or improperly formatted numbers.
β Bulk Verification β Process multiple phone numbers at once using batch requests.
β RESTful API β Easy-to-use and compatible with any programming language.
How It Works
1οΈβ£ Send a request with a phone number and optional country code.
2οΈβ£ Our system analyzes, verifies, and formats the number with precision.
3οΈβ£ Receive a structured response with validation status, formatted versions, and additional metadata.
Use Cases
πΉ CRM & Customer Databases β Ensure only valid phone numbers are stored.
πΉ E-commerce & Online Forms β Prevent users from entering incorrect numbers.
πΉ Marketing & Messaging Services β Validate numbers before sending SMS or calls.
πΉ Bulk Data Processing β Clean and standardize large datasets of phone numbers.
Next Steps
π Get Started Quickly β Check the Quick Start Guide.
π Learn How to Authenticate β See Authentication & API Keys.
π Explore API Endpoints β View the Core API Endpoints.
For further assistance, check out the Support & Contact section. π
Authentication
Authentication & API Keys
To access the Check This Phone API, authentication is required via an API token. This token ensures secure communication and identifies your requests.
Obtaining an API Token
1. Register for Free β Sign up on our platform to create an account.
2. Access the Dashboard β Log in and navigate to the API Token section.
3. Generate a New Token β Click the "Generate Token" button to create your unique API key.
Using the API Token
There are two ways to authenticate your requests using the API token:
1. For POST requests β Include the token in the Authorization header using the Bearer scheme:
1
2 curl -X POST https://api.check-this-phone.com/phone/verify
3 -H "Authorization: Bearer YOUR_API_TOKEN"
4 -d "number=+123456789"
5
2. For GET requests β Append the token as a query parameter:
1
2 curl -X GET "https://api.check-this-phone.com/phone/verify?number=+123456789&api_key=YOUR_API_TOKEN"
3
Keep your API token secure and do not share it. If compromised, you can revoke and generate a new one from your dashboard.
Quick Start Guide π
Welcome to the Check This Phone API! Follow these steps to get started quickly and verify phone numbers with ease.
1. Subscribe for Free π
- Sign up and get an API key instantly.
- Enjoy 100 free requests to test the service.
2. Make Your First Request π
Use your API key to verify a phone number.
1
2 curl -X GET "https://api.check-this-phone.com/phone/verify?api_key=YOUR_API_KEY&number=+33612345678"
3
Example Response
1
2 {
3 "is_valid": true,
4 "international_format": "+33 6 12 34 56 78",
5 "national_format": "06 12 34 56 78",
6 "E164_format": "+33612345678",
7 "RFC3966_format": "tel:+33-6-12-34-56-78",
8 "country_code": 33,
9 "region_code": "FR",
10 "type": "Mobile",
11 "carrier": "SFR",
12 "time_zones": [
13 "Europe/Paris"
14 ]
15 }
16
3. Upgrade for More Requests π
Need more than 100 requests? Upgrade to a paid plan for higher limits and priority access.
π π³ View Pricing & Upgrade
4. Integrate Easily π
- Use our detailed API reference for integration.
- Compatible in PHP, JavaScript, Python, and more.
- Support for batch batch verification via CSV.
5. Start Building Now! π
You're all set! Start verifying phone numbers and enhance your applications with accurate phone data.
π‘ Need help? Contact our support team anytime by clicking here.
Supported Countries
Supported Countries
Overview
Our API provides an endpoint to fetch a list of supported countries. Additionally, a search input allows users to check whether a specific country is included.
Coverage
- Supports 243 countries , ensuring global availability.
- Covers more than 240 regions , including various dialing codes.
- Regularly updated to maintain accuracy.
How to Access the List?
API Endpoint: Retrieve the full list of supported countries.
1
2 curl -X GET "https://api.check-this-phone.com/phone/countries?api_key=YOUR_API_KEY" -H "Accept: application/json"
3
Dropdown Input: Easily check for a country using the selection field below.
public.pages.documentation.core_endpoints.h2
Core API Endpoints
1. Verify a Phone Number (GET)
1GET /phone/verify
Allows users to validate and format a phone number using query parameters.
2. Verify a Phone Number (POST)
1POST /phone/verify
Accepts a JSON payload to validate and format a phone number.
3. Extract Phone Numbers from Text
1POST /phone/extract-from-text
Extracts phone numbers from a given text input.
4. Get Supported Countries
1GET /phone/countries
Returns a list of supported countries for phone validation.
Validating Phone
Validating a phone number
This section provides information on the API endpoints related to phone number validation. The API supports verifying single phone numbers, extracting phone numbers from text, and retrieving the list of supported countries for phone number validation.
1. Phone Validating
a. Validating a Single Phone (GET)
Description: This endpoint allows you to validate a single phone number using a GET request.
To pass the locale only if the phone's country code is not present, you can check if the phone number has a country code (i.e., it includes the international dialing code). If the country code is missing, then you can append the locale to the query parameters.
The locale parameter can be used in any situation, but it significantly increases precision when checking.
The locale parameter follows the ISO 3166-1 alpha-2 country code standard for region identification.
Request:
Method: GET
1https://api.check-this-phone.com/phone/verify?number=PHONE_NUMBER&locale=LOCALE
1
2 curl --location 'https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr'
3
Query Parameters:
api_key: Your API key.
number: The phone number you want to validate (e.g., +33 9 87 65 43 21)..
locale: The locale for the phone number validation (e.g., fr for French).
Response:
1
2 {
3 "status": "success",
4 "phone": {
5 "is_valid": true,
6 "international_format": "+33 9 87 65 43 21",
7 "national_format": "09 87 65 43 21",
8 "E164_format": "+33987654321",
9 "RFC3966_format": "tel:+33-9-87-65-43-21",
10 "country_code": 33,
11 "region_code": "FR",
12 "type": "VoIP",
13 "carrier": "Unknown",
14 "time_zones": [
15 "Europe/Paris"
16 ]
17 }
18 }
19
This endpoint will return the validation result for the provided phone number. The response structure will vary depending on the validation outcome.
b. Validating a Single Phone (POST)
Description: This endpoint validates a single phone number using a POST request. You can include the phone number and locale in the body of the request.
Request:
Method: POST
URL:
1https://api.check-this-phone.com/phone/verify
Authorization: Bearer token authentication using the API key.
Request Body:
1
2 {
3 "locale": "fr",
4 "number": "+33 9 87 65 43 21"
5 }
6
Examples of request:
1
2 curl --location 'https://api.check-this-phone.com/phone/verify'
3 --header 'Content-Type: application/json'
4 --header 'Authorization: Bearer __YOUR_API_KEY__'
5 --data '{
6 "locale" : "fr",
7 "number" : "+33 9 87 65 43 21"
8 }'
9
Response:
The response will contain the validation result for the phone number provided in the request body.
1
2 {
3 "status": "success",
4 "phone": {
5 "is_valid": true,
6 "international_format": "+33 9 87 65 43 21",
7 "national_format": "09 87 65 43 21",
8 "E164_format": "+33987654321",
9 "RFC3966_format": "tel:+33-9-87-65-43-21",
10 "country_code": 33,
11 "region_code": "FR",
12 "type": "VoIP",
13 "carrier": "Unknown",
14 "time_zones": [
15 "Europe/Paris"
16 ]
17 }
18 }
19
c. Extracting Phones from Text (POST)
Description: : This endpoint allows you to extract phone numbers from a given text content. It uses a POST request with the text in the body, and it will return any detected phone numbers.
Request:
Method: POST
1https://api.check-this-phone.com/phone/extract-from-text
Authorization: Bearer token authentication using the API key.
Request Body:
1
2 {
3 "locale": "fr",
4 "content": "If you're planning to contact us, here are some important numbers:
5 n- Our customer service number: +33 1 23 45 67 89
6 n- Technical support: +33 6 12 34 56 78
7 n- For emergencies: +33 9 87 65 43 21
8 nFeel free to reach out during business hours!"
9 }
10
Examples of request:
1
2 curl --location 'https://api.check-this-phone.com/phone/extract-from-text'
3 --header 'Content-Type: application/json'
4 --header 'Authorization: Bearer __YOUR_API_KEY__'
5 --data '{
6 "locale": "fr",
7 "content": "If you re planning to contact us, here are some important numbers:
8 Our customer service number: +33 1 23 45 67 89
9 Technical support: +33 6 12 34 56 78
10 For emergencies: +33 9 87 65 43 21
11 Feel free to reach out during business hours!"
12 }
13'
14
Response:
1
2 {
3 "status": "success",
4 "phone": [
5 {
6 "phone_number": "+33123456789",
7 "locale": "FR",
8 "is_valid": "Valid",
9 "E164_format": "+33123456789",
10 "RFC3966_format": "tel:+33-1-23-45-67-89",
11 "carrier": "Unknown",
12 "country_code": 33,
13 "international_format": "+33 1 23 45 67 89",
14 "national_format": "01 23 45 67 89",
15 "region_code": "FR",
16 "time_zones": "Europe/Paris",
17 "type": "Fixed Line"
18 },
19 {
20 "phone_number": "+33612345678",
21 "locale": "FR",
22 "is_valid": "Valid",
23 "E164_format": "+33612345678",
24 "RFC3966_format": "tel:+33-6-12-34-56-78",
25 "carrier": "SFR",
26 "country_code": 33,
27 "international_format": "+33 6 12 34 56 78",
28 "national_format": "06 12 34 56 78",
29 "region_code": "FR",
30 "time_zones": "Europe/Paris",
31 "type": "Mobile"
32 },
33 {
34 "phone_number": "+33987654321",
35 "locale": "FR",
36 "is_valid": "Valid",
37 "E164_format": "+33987654321",
38 "RFC3966_format": "tel:+33-9-87-65-43-21",
39 "carrier": "Unknown",
40 "country_code": 33,
41 "international_format": "+33 9 87 65 43 21",
42 "national_format": "09 87 65 43 21",
43 "region_code": "FR",
44 "time_zones": "Europe/Paris",
45 "type": "VoIP"
46 }
47 ]
48 }
49
The response will contain an array of phone numbers detected in the provided text.
2. Supported Countries
a. Retrieving Supported Countries (GET)
Description: This endpoint retrieves a list of supported countries for phone number validation. It returns details about the countries, including their name, country code, and phone code.
Request:
Method: GET
1https://api.check-this-phone.com/phone/countries?api_key=__YOUR_API_KEY__
Query Parameters:
api_key: Your API key.
Response:
The response will include a list of countries with their details. Below is an example of the structure of the response:
1
2 {
3 "total": 243,
4 "countries": [
5 {
6 "id": 2,
7 "name": "Grenada",
8 "alpha2": "GD",
9 "phone_code": "+1473"
10 },
11 {
12 "id": 3,
13 "name": "France",
14 "alpha2": "FR",
15 "phone_code": "+33"
16 }
17 ]
18 }
19
Response object
This section provides detailed information about the fields in the phone number validation response.
When you validate a phone number, the system returns a comprehensive set of data that helps you understand various aspects of the number's validity, format, and related information.
Below, you will find a table that describes each field in the response, helping you interpret the information correctly.
Field | Description |
---|---|
is_valid | Boolean: Indicates whether the phone number is valid according to the formatting rules and number type checks. |
international_format | String: The phone number formatted in the international format (e.g., +33 9 87 65 43 21). It includes the country code and the national number. |
national_format | String: The phone number formatted in the national format (e.g., 09 87 65 43 21 for France), specific to the country without the international country code. |
E164_format | String: The phone number in the E.164 format (e.g., +33987654321), which includes the country code without any spaces, hyphens, or parentheses. |
RFC3966_format | String: The phone number formatted according to RFC3966 (e.g., tel:+33-9-87-65-43-21). This format is commonly used in web and URI-based applications. |
country_code | Integer: The country calling code for the phone number (e.g., 33 for France), which is used to dial into the country from abroad. |
region_code | String: The region code (ISO 3166-1 alpha-2 country code) for the phone number's country (e.g., FR for France). |
type | String: The type of phone number (e.g., 'Mobile', 'Fixed Line', 'Toll-Free', etc.), based on the phone number's classification. |
carrier | String: The name of the carrier or service provider for the phone number (e.g., 'Verizon') or 'Unknown' if no carrier is detected. |
time_zones | Array: A list of time zones (e.g., ['Europe/Paris', 'America/New_York']) associated with the region or country of the phone number. |
Rate Limits
Rate Limits & Additional Requests
Our API enforces rate limits based on the plan you subscribe to. Each plan comes with a predefined number of requests, and once this limit is reached, additional requests will not be processed unless an extra package is purchased.
Purchasing Additional Requests
Customers can purchase additional request packages directly via the dashboard. These extra packages are available in three tiers:
1000 extra requests
5000 extra requests
10000 extra requests
Pricing details for these packages are only available within the dashboard.
Usage Notifications
To help customers manage their request limits effectively, we send an email notification when 70% of the total request quota has been used.
This ensures that you have enough time to take necessary actions before reaching your limit.
Grace Period for Premium Plans
For all paid plans, except the Basic Plan, we provide a tolerance of 100 additional requests after the limit is reached. This prevents an immediate service interruption and allows for a smooth transition while additional requests are arranged.
Customer Support & Custom Solutions
Our team is committed to providing uninterrupted service and is open to discussing alternative solutions if needed. If you require a custom request limit adjustment, feel free to contact us via the support section in your dashboard.
Error Handling
Error Codes and Descriptions
This section outlines the possible error codes returned by the API, along with their meanings and potential solutions.
Error Code | Description | Explanation & Resolution |
---|---|---|
1001 | API key is missing. | The request must include an API key in the parameters. Ensure that the `api_key` field is provided. |
1002 | Invalid credentials (API key not found). | The API key provided does not match any valid credentials. Verify that the correct API key is being used. |
1003 | Request limit exceeded. | The user has reached the maximum number of allowed API requests. Consider upgrading the plan or checking the request quota. |
1004 | Error fetching request statistics. | There was an issue retrieving usage statistics for the account. Try again later or contact support if the problem persists. |
1005 | Invalid token. | The provided token is not valid or has been revoked. Ensure that the token is correctly generated and active. |
1006 | Phone number is missing or invalid. | The request does not contain a valid phone number. Ensure that the `number` field is included and formatted correctly. |
1007 | Invalid JSON format. | The request body contains improperly formatted JSON. Ensure that the JSON structure is valid and correctly encoded. |
1008 | Text content is missing. | The request must include a "text" field, but it was either missing or empty. Make sure the text parameter is properly provided. |
Support
Support & Assistance
We are committed to providing reliable support for all our customers to ensure a seamless experience with our API.
How to Get Support
Support is available through the following channels:
Dashboard: All customers can access the support section in the dashboard to submit requests.
Email: You can reach our support team at contact@check-this-phone.com.
Support Eligibility
All paid plans full support.
The free plan does not include support. free plan does not include support.
If you require assistance, please activate a support request via the dashboard in the Support section.
Our team will be happy to assist you!
Zapier Integration
π Integrating Phone Verification API with Zapier
Overview
Zapier allows you to automate workflows by integrating different applications. You can use Zapier Webhooks to connect the Phone Verification API to other apps like Google Sheets, Slack, or Email.
π Steps to Integrate
1. Create a Zap
- Log in to Zapier.
- Click "Create Zap". Create Zap.
- Select "Webhook by Zapier" as the Trigger.
2. Choose Trigger Event
- Select Retrieve Poll (for scheduled checks) or "Custom Webhook " (for real-time requests).
3. Set Up Webhook URL
- Choose GET as the request method.
- Use the following Webhook URL (replace ( with your actual API key __API_KEY__ with your actual API key):
- Select " Webhook by Zapier" as the Trigger.URL
1https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr
- If needed, make the number and locale dynamic using previous Zap steps.
4. Test the Webhook
- Click "Test Trigger" to verify that the API request returns the correct response.
5. Use the API Response in Another Action
Choose an action step, such as:
- Save results to Google Sheets
- Send a Slack notification
- Trigger an email alert
6. Activate Your Zap! π
- Click "Publish" and start automating.
π Example: Using a Zapier Code Step (JavaScript)
If you need additional flexibility, you can use the "public.pages.documentation.zapier_integration.content.27.1" public.pages.documentation.zapier_integration.content.27.2
1
2 fetch("https://api.check-this-phone.com/phone/verify?api_key=__API_KEY__&number=+33987654321&locale=fr")
3 .then(response => response.json())
4 .then(data => console.log(data));
5
This script fetches phone validation data and can be used in custom Zapier automations.