Skip to content

WhatsApp Detection

Check the input global number, whether it is whatsapp account.

Code 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'

Non-callback request (callback is empty), response for the input number have already registered whatsapp

{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "yes"
}
}

Non-callback request (callback is empty), response for the input number not register whatsapp

{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "no"
}
}

Non-callback request (callback is empty), response for the input number is checking

{
"status": "OK",
"message": {
"number": "+628138800001",
"whatsapp": "checking"
}
}

Return by callback address (callback address)

Terminal window
GET https://YOUR_CALLBACKURL/?number=%2B628138800001&whatsapp=yes

HTTP request

POST https://api.ekycpro.com/v1/whatsapp

Request parameters

parameterdescription
numberstring, phone number
countrystring, Country abbreviation. Brazil: BR, Mexico: MX, Nigeria: NG, India: IN.
callbackoptional, string, callback url. Strongly recommended to use callback url

Response format

fieldsdescription
statusstatus code
messagenumber: phone number
whatsapp: conclusion

Request method

Directly Get Result

When the whatsapp value is checking, it needs to be detected again for a period of time (>20s).

Callback Get Result

When the field callback is not empty, it is returned to the callback URL once the result is queried. Please do not call back the same number multiple times. Return method is GET https://YOUR_CALLBACKURL/?number=%2B628138800001&whatsapp=yes

Status code

statusdescription
OKthe whatsapp value is checking, unavailable for free else charge, message contains the result
FAILfree, invalid query
INVALID_INPUTfree, invalid input
RETRY_LATERfree, server error, please try again later