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

# Verificação de Número

## Introdução

Este endpoint permite verificar a existência de um destinatário em uma determinada instância do WhatsApp. A API retorna informações básicas sobre o destinatário, como o ID, se é uma conta comercial, o nome e a URL da foto de perfil. Esse endpoint é útil para garantir que o número fornecido está registrado e ativo na plataforma, antes de enviar mensagens ou realizar outras operações.

## Casos de Uso

* **Validação antes de envio de mensagens**: Antes de enviar uma mensagem a um destinatário, verifique se o número existe e está registrado no WhatsApp para evitar erros e falhas no envio.

* **Validação em formulários**: Utilize este endpoint para validar números de telefone inseridos por usuários em formulários. Antes de permitir que o usuário prossiga, a aplicação pode verificar se o número inserido está registrado no WhatsApp, garantindo que os dados fornecidos são válidos e que o destinatário é alcançável via WhatsApp.

## Pontos de Atenção

<Warning>
  O campo `name` nem sempre estará presente na resposta da API. Isso ocorre devido a uma limitação técnica onde a Zapster só consegue armazenar em cache o nome do contato se ele tiver conversado pelo menos uma vez com a instância. Se o contato nunca conversou, este campo estará ausente.
</Warning>

<Info>
  O campo `profile_picture` retornará `null` em dois casos: se o contato tiver configurado a foto de perfil como privada ou se não houver nenhuma foto de perfil atribuída.
</Info>


## OpenAPI

````yaml GET /wa/instances/{instance_id}/recipients/{recipient}
openapi: 3.1.0
info:
  title: Zapster API
  description: ''
  version: 1.0.0
servers:
  - url: https://api.zapsterapi.com/v1
    description: Produção
security: []
tags: []
paths:
  /wa/instances/{instance_id}/recipients/{recipient}:
    get:
      tags: []
      summary: Existência de Destinatário
      parameters:
        - name: instance_id
          in: path
          description: Obrigatório se `instance_id` não estiver presente no `body`.
          required: true
          example: ozj35qv418rpmlrb
          schema:
            type: string
        - name: recipient
          in: path
          description: Número do destinatário para verificação de existência.
          required: true
          example: '559912345678'
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID ou número do destinatário
                  is_business:
                    type: boolean
                    description: >-
                      Define se o `recipient` informado é um perfil do tipo
                      business ou normal.
                  name:
                    type: string
                    description: Nome presente no perfil do destinatário.
                  profile_picture:
                    type: string
                    format: uri
                    nullable: true
                    example: https://zapsterapi.s3.us-east-1.amazonaws.com/...
                    description: >-
                      Foto de perfil do destinatário. Se a recuperação da foto
                      não for possível, então o valor desse campo será `null`.
                required:
                  - id
                  - is_business
      deprecated: false
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````