> ## 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.

# Verificar conta

> Obtém dados do perfil próprio ou de outro número / LID

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim (read-only)

## Descrição

Retorna os dados do perfil da própria conta conectada (foto, nome, status, JID, LID). Opcionalmente, consulta o perfil de **outro número** via `?number=`. Sem o parâmetro, retorna o perfil da própria instância.

## Exemplos

### Própria conta

Sem query param: retorna o perfil da própria instância conectada (foto, nome, status, JID e LID). Forma direta de validar quem está conectado naquela sessão.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name"), nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Outro número

Consulta o perfil público de um terceiro pelo número (`?number=5511988887777`). Útil para verificar se o número existe no WhatsApp e obter foto / nome / status visíveis ao público.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=5511988887777" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}?number=5511988887777`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}?number=5511988887777",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name")+"?number=5511988887777", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Por LID

Consulta o perfil usando um LID (`@lid`) em vez de número. Útil quando o evento de origem expõe apenas o LID anônimo (em comunidades / canais novos do WhatsApp), sem o telefone correspondente.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=52399087550579@lid" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}?number=52399087550579@lid`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}?number=52399087550579@lid",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name")+"?number=52399087550579@lid", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

Devolve `profile` com os dados do alvo: `profilePicture` (URL CDN do WhatsApp, **sempre** presente, vira `null` se a conta não tem foto ou o lookup deu timeout), `profileName` (push name ou business name), `profileStatus` (texto "Recados"), `phoneNumber` (só dígitos), `jid` (`<numero>@s.whatsapp.net`) e `lid` (formato `@lid`, quando disponível). Os campos exceto `profilePicture` usam `omitempty`, podem não aparecer se o WhatsApp não devolveu o dado.

```json 200 OK theme={null}
{
  "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"
  }
}
```

```json 200 OK (sem foto) theme={null}
{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": null,
    "profileName": "Cliente Teste",
    "phoneNumber": "5511988887777",
    "jid": "5511988887777@s.whatsapp.net"
  }
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

## Query

<ParamField query="number" type="string">
  Número (`5511999999999`, `+5511999999999`, `5511999999999@s.whatsapp.net`) ou LID (`52399087550579@lid`). Se omitido, retorna o perfil da própria instância.
</ParamField>

## Notas

<Note>
  * Para números BR (`55...`), o serviço tenta automaticamente variações com e sem o 9º dígito.
  * Sanitização automática de `+`, `-`, `(`, `)` e espaços: `(11) 99999-9999` vira `11999999999`.
  * `profilePicture` é o único campo que sempre aparece (pode ser `null`); os demais usam `omitempty`.
  * A URL da foto é temporária (CDN do WhatsApp). Se o lookup ultrapassar 10s, o campo vem `null`.
  * Para a própria conta, prefira `number=""`, passar o próprio número retorna dados "como outros te veem".
</Note>

## Erros

| HTTP | Mensagem                                         |
| ---- | ------------------------------------------------ |
| 400  | `Number not found or not registered on WhatsApp` |
| 400  | `invalid LID format`                             |
| 400  | `Instance is not connected to WhatsApp`          |
| 500  | `timeout ao buscar foto (>10s)`                  |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "Number not found or not registered on WhatsApp" }
}
```