Skip to main content
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>'
{
  "exists": true,
  "jid": "5511999999999@s.whatsapp.net",
  "isInWhatsapp": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This endpoint checks if a specific phone number is registered and active on WhatsApp. Useful for validating numbers before sending messages.

​
Query Parameters

​
sessionId
string
required
Authenticated session ID
​
phone
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 successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found

​
Usage Example

curl -X GET "https://api.wappfy.com.br/api/contacts/check-exists?sessionId=my-session&phone=5511999999999"

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Query Parameters

​
phone
string
required

The phone number to check

Response

200 - application/json
​
numberExists
boolean
required
​
chatId
string
Example:

"Chat id for the phone number. Undefined if the number does not exist"