Skip to main content
POST
/
chat
/
fetchProfile
/
:instanceName
curl --request POST \
  --url https://api.example.com/chat/fetchProfile/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "5511999999999"
  }'

{
  "wid": "[email protected]",
  "name": "John Doe",
  "status": "Available",
  "isBusiness": false,
  "profilePictureUrl": "https://example.com/profile-john.jpg"
}

​
Overview

You can fetch detailed profile information for any WhatsApp contact, including their status, profile picture, and business profile details if applicable.
This endpoint works for both individual contacts and business accounts.

​
Authentication

This endpoint requires authentication via the apikey header.
​
header.apikey
string
required
Your Evolution API key for authentication.

​
Path Parameters

​
path.instanceName
string
required
The name of your WhatsApp instance.

​
Request Body

​
number
string
required
The phone number in international format without the ’+’ sign (e.g., “5511999999999”).

​
Response

​
wid
string
WhatsApp ID of the contact.
​
name
string
Contact’s display name.
​
status
string
Contact’s WhatsApp status/about text.
​
isBusiness
boolean
Whether this is a business account.
​
profilePictureUrl
string
URL of the contact’s profile picture.
​
businessProfile
object
Business profile information (only present for business accounts).
curl --request POST \
  --url https://api.example.com/chat/fetchProfile/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "5511999999999"
  }'

{
  "wid": "[email protected]",
  "name": "John Doe",
  "status": "Available",
  "isBusiness": false,
  "profilePictureUrl": "https://example.com/profile-john.jpg"
}

​
Usage Notes

The contact’s status is their WhatsApp “About” text, which they can customize in their settings.
Use this endpoint to verify if a number is registered on WhatsApp before sending messages.
Business profile information is only available for WhatsApp Business accounts.

​
Fetch Profile Picture

To get only the profile picture URL: 
POST /chat/fetchProfilePictureUrl/:instanceName
Request body: 
{
  "number": "5511999999999"
}

​
Fetch Business Profile

To get detailed business profile information: 
POST /chat/fetchBusinessProfile/:instanceName
Request body: 
{
  "number": "5511888888888"
}

​
Check WhatsApp Number

To check if numbers are registered on WhatsApp: 
POST /chat/whatsappNumbers/:instanceName
Request body: 
{
  "numbers": ["5511999999999", "5511888888888"]
}
Returns an array indicating which numbers exist on WhatsApp.

Build docs developers (and LLMs) love

Get started for freeTalk to us