> ## Documentation Index
> Fetch the complete documentation index at: https://docs.d-api.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter informações do contato

> Dados de um contato, com foto e perfil WhatsApp Business.

Retorna os dados de um contato: nomes, `username`, se a conta é Business
(`isBusiness`) ou API Oficial (`isOfficial`), recado (`status`) e foto
(`avatar`). O `POST /api/v1/contacts/getuser` devolve a mesma resposta, com
os parâmetros no body.

## Perfil WhatsApp Business

Quando o contato é uma conta business (app WhatsApp Business ou API Oficial),
a resposta traz `data.businessProfile` com o perfil comercial público: descrição,
e-mail, endereço, sites, localização, categorias, horário de atendimento, contas
vinculadas do Instagram e do Facebook, serviços oferecidos e capa.

O perfil vem **por padrão**. Ele custa uma consulta a mais ao WhatsApp (até 10 s);
se você não precisa dele, desligue com `business=false` (query) no `GET` ou
`"business": false` (body) no `POST`.

> [!NOTE]
>
> `businessProfile` só existe para contas business e quando a consulta dá certo.
> Em contato pessoal, com `business=false` ou se o WhatsApp não responder a tempo,
> a chave **não vem** — o resto do contato chega normalmente. Trate o campo como
> opcional.

```json theme={null}
{
  "success": true,
  "commandId": "b7e2c1d4-5f60-4a8b-9c3d-1e2f3a4b5c6d",
  "data": {
    "jid": "5511988887777@s.whatsapp.net",
    "phone": "5511988887777",
    "lid": "163896103039140@lid",
    "contactName": "Minha Empresa",
    "pushName": "Minha Empresa",
    "username": "",
    "isBusiness": true,
    "isOfficial": false,
    "isOnWhatsApp": true,
    "status": "Atendimento de segunda a sábado",
    "avatar": "https://s3.us-east-005.backblazeb2.com/d-api-media/avatars/5511988887777.jpg",
    "businessProfile": {
      "description": "Agência de marketing digital",
      "email": "contato@minhaempresa.com.br",
      "address": "Avenida Paulista, 1000, São Paulo SP",
      "websites": ["https://minhaempresa.com.br", "https://loja.minhaempresa.com.br/"],
      "location": { "latitude": -23.5632, "longitude": -46.6543 },
      "categories": [{ "id": "123377808095874", "name": "Agência de marketing" }],
      "businessHours": {
        "timezone": "America/Sao_Paulo",
        "days": [
          { "dayOfWeek": "mon", "mode": "specific_hours", "openTime": "08:00", "closeTime": "12:00" },
          { "dayOfWeek": "mon", "mode": "specific_hours", "openTime": "13:30", "closeTime": "18:00" },
          { "dayOfWeek": "sat", "mode": "appointment_only", "openTime": "", "closeTime": "" }
        ]
      },
      "instagram": {
        "handle": "minhaempresa",
        "followers": 1494,
        "url": "https://www.instagram.com/minhaempresa/"
      },
      "facebook": {
        "id": "1132445806627829",
        "name": "Minha Empresa",
        "likes": 17,
        "url": "https://www.facebook.com/1132445806627829"
      },
      "offerings": [
        {
          "category": "Opções de pagamento e estacionamento",
          "items": [{ "id": "business_pix_accepted", "name": "Aceitamos Pix", "offered": true }]
        }
      ],
      "coverPhotoUrl": "https://media.cdn.whatsapp.net/v/t61.24694-24/...",
      "commerceExperience": "catalog",
      "cartEnabled": true,
      "accountType": "smb",
      "verificationLevel": "unknown",
      "automatedType": "unknown",
      "memberSince": "2023-07-03T19:35:10Z",
      "memberSinceText": "Empresa cadastrada desde julho, 2023."
    }
  },
  "timestamp": "2026-11-05T22:10:00.000Z"
}
```

### Campos de `businessProfile`

**description** `string`

Descrição do negócio

**email** `string`

E-mail público

**address** `string`

Endereço

**websites** `string[]`

Sites cadastrados (lista vazia quando não há). Algumas empresas colocam o link
do Instagram aqui em vez de vincular a conta.

**location** `object | null`

`{ latitude, longitude }` do local fixado no perfil, ou `null`

**categories** `object[]`

Categorias do negócio: `{ id, name }`

**businessHours** `object`

**Campos de businessHours**

**timezone** `string`

Fuso horário do horário de atendimento (ex: `America/Sao_Paulo`)

**days** `object[]`

Uma entrada por faixa de horário. Turno partido (ex: manhã e tarde) gera
**duas entradas no mesmo dia**.

**Campos de days**

**dayOfWeek** `string`

`mon` | `tue` | `wed` | `thu` | `fri` | `sat` | `sun`

**mode** `string`

`specific_hours` (horário definido) | `open_24h` (24 horas) |
`appointment_only` (só com agendamento)

**openTime** `string`

Abertura em `HH:MM`. Vazio quando `mode` não é `specific_hours`

**closeTime** `string`

Fechamento em `HH:MM`. Vazio quando `mode` não é `specific_hours`

**instagram** `object | null`

Conta do Instagram vinculada: `{ handle, followers, url }`, ou `null`

**facebook** `object | null`

Página do Facebook vinculada: `{ id, name, likes, url }`, ou `null`

**offerings** `object[]`

Serviços e comodidades marcados no perfil, agrupados por categoria:
`{ category, items: [{ id, name, offered }] }`

**coverPhotoUrl** `string`

Foto de capa. É um link assinado do CDN do WhatsApp que **expira** — baixe a
imagem se precisar guardá-la.

**commerceExperience** `string`

`catalog` | `shop` | `none`

**cartEnabled** `boolean`

Se o carrinho de compras está ativo

**accountType** `string`

`smb` (app WhatsApp Business) | `ent` (API / conta hospedada)

**verificationLevel** `string`

Nível de verificação informado pelo WhatsApp

**automatedType** `string`

Tipo de automação informado pelo WhatsApp

**memberSince** `string`

Data de cadastro da empresa em RFC 3339, ou vazio quando o WhatsApp não informa

**memberSinceText** `string`

O mesmo dado em texto, como o WhatsApp exibe


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/contacts/{phone}
openapi: 3.1.0
info:
  title: D-API - Infraestrutura WhatsApp Completa
  description: >-
    Solução escalável e robusta para gestores de automação, SaaS e usuários
    finais que precisam de uma integração WhatsApp confiável. Oferece múltiplas
    instâncias simultâneas, webhooks em tempo real, dashboard intuitivo e API
    REST documentada com 99.9% de uptime e latência inferior a 30ms.
  version: 1.2.1
  contact:
    name: Suporte D-API
    email: suporte@d-api.cloud
    url: https://d-api.cloud
servers:
  - url: https://api.d-api.cloud
    description: Produção
security:
  - ApiKeyAuth: []
tags:
  - name: Início
    description: Endpoints base
  - name: Sessões
    description: Endpoints para gerenciamento de sessões
  - name: Mensagens
    description: Endpoints para envio de mensagens
  - name: Cloud API
    description: >-
      WhatsApp API Oficial (Meta Cloud API): conexão manual, gestão de templates
      (listar/criar/excluir) e envio de templates.
  - name: Ligações URA
    description: >-
      Disparo de ligações de voz (URA): individual ou em massa, com áudio ou
      fluxo IVR.
  - name: SMS
    description: 'Envio de SMS: individual ou em massa.'
  - name: Comandos
    description: >-
      Consulta de comandos assíncronos (async: true) pelo commandId retornado no
      enfileiramento.
paths:
  /api/v1/contacts/{phone}:
    get:
      tags:
        - Contacts
      summary: Obter informações do usuário
      description: >-
        Obtém os dados de um contato. Campos: jid, phone, lid, contactName (nome
        salvo na sua agenda), pushName (nome que o contato publica: perfil,
        negócio ou nome verificado), username (@ do WhatsApp), isBusiness (conta
        WhatsApp Business no celular), isOfficial (conta hospedada na Meta, ou
        seja, API Oficial), isOnWhatsApp, status e avatar (URL persistida em
        S3). Número fora do WhatsApp volta como { phone, isOnWhatsApp: false }.
        Para contas business vem businessProfile: description, email, address,
        websites, location, categories, businessHours (timezone + days com
        openTime/closeTime em HH:MM), instagram { handle, followers, url },
        facebook { id, name, likes, url }, offerings, coverPhotoUrl (link
        temporário), commerceExperience, cartEnabled, accountType (smb = app
        Business, ent = API), verificationLevel, automatedType, memberSince e
        memberSinceText. avatar=false pula a busca da foto; force=true ignora o
        cache de avatar; preview=true traz a foto em baixa resolução;
        business=false pula o perfil business.
      operationId: getApiV1ContactsByPhone
      parameters:
        - schema:
            type: string
          in: path
          name: phone
          required: true
        - schema:
            minLength: 1
            type: string
          in: query
          name: sessionId
          required: true
        - schema:
            anyOf:
              - type: boolean
              - type: string
          in: query
          name: async
          required: false
        - schema:
            type: string
          in: query
          name: avatar
          required: false
        - schema:
            type: string
          in: query
          name: force
          required: false
        - schema:
            type: string
          in: query
          name: preview
          required: false
        - schema:
            type: string
          in: query
          name: business
          required: false
      responses:
        '200':
          description: Resposta bem-sucedida
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'API Key para autenticação. Formato: <API_KEY>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.