Check if the phone number is registered on WhatsApp
curl --request GET \
--url https://{host}/api/contacts/check-exists \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/contacts/check-exists"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/contacts/check-exists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/contacts/check-exists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/contacts/check-exists"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/contacts/check-exists")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/contacts/check-exists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"exists": true,
"jid": "5511999999999@s.whatsapp.net",
"isInWhatsapp": true
}
Contacts
Check if Number is Registered on WhatsApp
Check if a phone number is registered on WhatsApp
GET
/
api
/
contacts
/
check-exists
Check if the phone number is registered on WhatsApp
curl --request GET \
--url https://{host}/api/contacts/check-exists \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/contacts/check-exists"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/contacts/check-exists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/contacts/check-exists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/api/contacts/check-exists"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/api/contacts/check-exists")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/contacts/check-exists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"exists": true,
"jid": "5511999999999@s.whatsapp.net",
"isInWhatsapp": true
}
Description
This endpoint checks if a specific phone number is registered and active on WhatsApp. Useful for validating numbers before sending messages.Query Parameters
string
required
Authenticated session ID
string
required
Phone number to be checked (international format, numbers only). Example:
5511999999999{
"exists": true,
"jid": "5511999999999@s.whatsapp.net",
"isInWhatsapp": true
}
Status Codes
200- Verification completed successfully400- Invalid parameters401- Unauthorized session404- Session not found
Usage Example
curl -X GET "https://api.wappfy.com.br/api/contacts/check-exists?sessionId=my-session&phone=5511999999999"
const sessionId = 'my-session';
const phone = '5511999999999';
const response = await fetch(
`https://api.wappfy.com.br/api/contacts/check-exists?sessionId=${sessionId}&phone=${phone}`
);
const data = await response.json();
if (data.exists && data.isInWhatsapp) {
console.log(`Number ${phone} is registered on WhatsApp!`);
console.log(`JID: ${data.jid}`);
} else {
console.log(`Number ${phone} is not on WhatsApp`);
}
import requests
session_id = 'my-session'
phone = '5511999999999'
response = requests.get(
'https://api.wappfy.com.br/api/contacts/check-exists',
params={
'sessionId': session_id,
'phone': phone
}
)
data = response.json()
if data.get('exists') and data.get('isInWhatsapp'):
print(f"Number {phone} is registered on WhatsApp!")
print(f"JID: {data['jid']}")
else:
print(f"Number {phone} is not on WhatsApp")
Authorizations
Your Wappfy API key (get it at dash.wappfy.com.br)
Query Parameters
The phone number to check
