Saltar al contenido principal
GET
/
api
/
profile
/
getAccount
/
:instance
Consultar cuenta
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 o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí (solo lectura)

​
Descripción

Devuelve los datos de perfil de la propia cuenta conectada (foto, nombre, estado, JID, LID). Opcionalmente, consulta el perfil de otro número vía ?number=. Sin el parámetro, devuelve el perfil de la propia instancia.

​
Ejemplos

​
Cuenta propia

Sin el parámetro de query: devuelve el perfil de la instancia conectada (foto, nombre, estado, JID y LID). Una forma directa de verificar quién está conectado en esa sesión. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name" \
  -H "token: $Token_Instance"

​
Otro número

Consulta el perfil público de un tercero por número (?number=5511988887777). Útil para verificar que el número existe en WhatsApp y obtener su foto / nombre / estado visibles públicamente. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=5511988887777" \
  -H "token: $Token_Instance"

​
Por LID

Consulta el perfil usando un LID (@lid) en lugar de un número. Útil cuando el evento de origen solo expone el LID anónimo (en comunidades / canales más recientes de WhatsApp), sin el número telefónico correspondiente. 
curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=52399087550579@lid" \
  -H "token: $Token_Instance"

​
Respuesta exitosa

Devuelve profile con los datos del destino: profilePicture (URL del CDN de WhatsApp, siempre presente, queda en null si la cuenta no tiene foto o si la consulta excedió el tiempo), profileName (push name o nombre comercial), profileStatus (texto “Acerca de”), phoneNumber (solo dígitos), jid (<número>@s.whatsapp.net) y lid (formato @lid, cuando está disponible). Todos los campos excepto profilePicture usan omitempty y pueden no aparecer si WhatsApp no devolvió ese dato.
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 (sin foto)
{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": null,
    "profileName": "Cliente Teste",
    "phoneNumber": "5511988887777",
    "jid": "5511988887777@s.whatsapp.net"
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Query

​
number
string
Número (5511999999999, +5511999999999, 5511999999999@s.whatsapp.net) o LID (52399087550579@lid). Si se omite, devuelve el perfil de la propia instancia.

​
Notas

  • Para números BR (55...), el servicio prueba automáticamente variaciones con y sin el noveno dígito.
  • Saneamiento automático de +, -, (, ) y espacios: (11) 99999-9999 se vuelve 11999999999.
  • profilePicture es el único campo que siempre aparece (puede ser null); los demás usan omitempty.
  • La URL de la foto es temporal (CDN de WhatsApp). Si la búsqueda supera 10s, el campo regresa null.
  • Para tu propia cuenta, prefiere number="", pasar tu propio número devuelve los datos “como otros te ven”.

​
Errores

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