Skip to main content
GET
/
api
/
profile
/
getAccount
/
:instance
Check account
curl --request GET \
  --url https://api.example.com/api/profile/getAccount/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

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

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes (read-only)

​
Description

Returns profile data for the connected account itself (picture, name, status, JID, LID). Optionally, looks up the profile of another number via ?number=. Without the parameter, returns the profile of the instance itself.

​
Examples

​
Own account

Without the query parameter: returns the profile of the connected instance itself (picture, name, status, JID, and LID). A direct way to verify who is connected to that session. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name" \
  -H "token: $Token_Instance"

​
Another number

Looks up the public profile of a third party by number (?number=5511988887777). Useful for verifying that the number exists on WhatsApp and getting their publicly visible picture / name / status. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=5511988887777" \
  -H "token: $Token_Instance"

​
By LID

Looks up the profile using a LID (@lid) instead of a number. Useful when the source event only exposes the anonymous LID (in newer WhatsApp communities / channels), without the corresponding phone number. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=52399087550579@lid" \
  -H "token: $Token_Instance"

​
Success response

Returns profile with the target’s data: profilePicture (WhatsApp CDN URL, always present, becomes null if the account has no picture or the lookup timed out), profileName (push name or business name), profileStatus (“About” text), phoneNumber (digits only), jid (<number>@s.whatsapp.net), and lid (@lid format, when available). All fields except profilePicture use omitempty and may not appear if WhatsApp didn’t return that data.
200 OK
{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": "https://pps.whatsapp.net/...",
    "profileName": "João Silva",
    "profileStatus": "Disponível",
    "phoneNumber": "5511999999999",
    "jid": "5511999999999@s.whatsapp.net",
    "lid": "199789077627112@lid"
  }
}
200 OK (no picture)
{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": null,
    "profileName": "Cliente Teste",
    "phoneNumber": "5511988887777",
    "jid": "5511988887777@s.whatsapp.net"
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Query

​
number
string
Number (5511999999999, +5511999999999, 5511999999999@s.whatsapp.net) or LID (52399087550579@lid). If omitted, returns the profile of the instance itself.

​
Notes

  • For BR numbers (55...), the service automatically tries variations with and without the 9th digit.
  • Automatic sanitization of +, -, (, ), and spaces: (11) 99999-9999 becomes 11999999999.
  • profilePicture is the only field that always appears (may be null); the others use omitempty.
  • The picture URL is temporary (WhatsApp CDN). If the lookup exceeds 10s, the field comes back null.
  • For your own account, prefer number="", passing your own number returns data “as others see you”.

​
Errors

HTTPMessage
400Number not found or not registered on WhatsApp
400invalid LID format
400Instance is not connected to WhatsApp
500timeout ao buscar foto (>10s)
Envelope: 
{
  "success": false,
  "error": { "message": "Number not found or not registered on WhatsApp" }
}