· 2 min read
WhatsApp Number Detection API
Check if a global phone number is on WhatsApp.
Check if a global phone number is a registered WhatsApp account.
API URL
POST https://api.ekycpro.com/v1/whatsapp
Request Example
curl --location --request POST 'https://api.ekycpro.com/v1/whatsapp' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'callback=https://YOUR_CALLBACK_URL' \
--data-urlencode 'number=628138800001&country=ID'
Request Parameters
Parameter | Description |
---|---|
number | Phone number |
country | Country abbreviation (BR: Brazil, MX: Mexico, NG: Nigeria, IN: India) |
callback | Optional callback URL. Strongly recommended |
Response Format
Direct Response (No Callback)
WhatsApp Account Exists:
{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "yes"
}
}
WhatsApp Account Does Not Exist:
{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "no"
}
}
Still Checking:
{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "checking"
}
}
Callback Response
When using a callback URL, the result will be sent to your URL:
GET https://YOUR_CALLBACKURL/?number=%2B628138800001&whatsapp=yes
Request Methods
Direct Method
When the whatsapp
value is “checking”, you need to query again after a period of time (>20s).
Callback Method (Recommended)
When the callback
field is provided, the result will be sent to your callback URL once available. Please do not request the same number multiple times.
Status Codes
status | description |
---|---|
OK | the whatsapp value is checking, unavailable for free else charge, message contains the result |
FAIL | free , invalid query |
INVALID_INPUT | free , invalid input |
RETRY_LATER | free , server error, please try again later |
Integration Notes
Always include the country code with the phone number.
Use the callback method for better performance and reliability.
Handle the “checking” status appropriately in your application.