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

# Verificar se um número está no WhatsApp



## OpenAPI

````yaml /openapi/escrybe.pt.yaml get /api/v2/whatsapp-check-number
openapi: 3.1.0
info:
  title: API Escrybe
  version: 1.0.0
  description: >-
    REST API da plataforma Escrybe — envie cartas físicas, cartas registradas,

    telegramas e e-Carta pelos Correios, dispare e-mails registrados
    juridicamente

    e envie mensagens de WhatsApp com carimbo de tempo certificado.



    ## Autenticação


    Toda conta possui um **`securityToken`** pessoal (disponível no painel em

    *Minhas configurações → Acesso a API*). Três produtos o utilizam de formas

    diferentes:



    | Produto | Esquema | Como |

    |---------|---------|------|

    | Cartas / Telegrama / e-Carta, E-mail Registrado, Recibos | Token de API |
    Envie `userSecurityToken` como parâmetro (query/body) ou `securityToken`
    como header |

    | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)`
    |



    > As rotas de **consulta** de carta e e-mail (`get`, `balance`, `download`,

    > `delete`) recebem o token como o primeiro segmento de **caminho** da URL —

    > ex.: `/api/v2/get/{securityToken}/{job_id}`.



    ## Envelopes de resposta


    A maioria dos endpoints responde com o envelope padrão

    `{"status": <código http>, "status_message": "...", "data": ...}` — isso
    cobre

    Cartas/Telegrama, E-mail Registrado e os endpoints de mensagens e remetentes
    de

    WhatsApp. Os endpoints de **modelos** de WhatsApp (e a sincronização de
    modelos)

    usam `{"code": <código http>, "status": "success|error", "message": "...",

    "data": ..., "request_id": "..."}`; o endpoint de logo usa o mesmo formato
    sem

    `request_id`. Consulte o schema de cada endpoint.



    Uma requisição aceita retorna HTTP `200` com o payload de sucesso; problemas
    de

    validação retornam `400`, credenciais inválidas `401` e acesso negado `403`.

    Métodos HTTP não suportados retornam `405`, tentativas repetidas de

    autenticação falhas retornam `429` e os endpoints de carta e e-mail retornam

    `503` durante janelas de manutenção.
  contact:
    name: Suporte Escrybe
    url: https://escrybe.com.br
servers:
  - url: https://app.escrybe.com.br
    description: Produção
  - url: https://homolog.escrybe.com.br
    description: Homologação
security:
  - securityTokenQuery: []
tags:
  - name: Letters & Telegram
    description: Crie e gerencie pedidos de carta, telegrama e e-Carta (Correios).
  - name: Account & Favorites
    description: Saldo da conta, contatos salvos e logo do remetente.
  - name: Registered E-mail
    description: Envie e acompanhe e-mails registrados juridicamente.
  - name: WhatsApp Messages
    description: Envie mensagens de WhatsApp e baixe atestações com carimbo de tempo.
  - name: WhatsApp Senders
    description: Gerencie números do WhatsApp Business (remetentes).
  - name: WhatsApp Templates
    description: Crie, sincronize e gerencie modelos de mensagem do WhatsApp.
  - name: Receipts
    description: Baixe recibos legais de qualquer pedido.
paths:
  /api/v2/whatsapp-check-number:
    get:
      tags:
        - Account & Favorites
      summary: Verificar se um número está no WhatsApp
      operationId: checkWhatsappNumber
      parameters:
        - name: phone
          in: query
          required: true
          schema:
            type: string
          description: Número de telefone; normalizado para E.164 no servidor.
      responses:
        '200':
          description: Resultado da verificação
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  exists:
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - invalid_format
                      - not_on_whatsapp
                    nullable: true
                  name:
                    type: string
                    nullable: true
                  profile_picture_url:
                    type: string
                    nullable: true
                  verification_unavailable:
                    type: boolean
                    nullable: true
                  auth_failure:
                    type: boolean
                    nullable: true
                    description: >-
                      Presente junto de verification_unavailable quando a
                      verificação falhou por autenticação no provedor.
                  message:
                    type: string
                    nullable: true
        '400':
          $ref: '#/components/responses/FavoritesBadRequest'
        '401':
          $ref: '#/components/responses/FavoritesUnauthorized'
components:
  responses:
    FavoritesBadRequest:
      description: Requisição inválida
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
    FavoritesUnauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
          example:
            success: false
            message: Não autorizado
  securitySchemes:
    securityTokenQuery:
      type: apiKey
      in: query
      name: userSecurityToken
      description: >-
        Seu token de segurança, enviado como parâmetro `userSecurityToken`
        (query ou form).

````