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

# Obter código de pareamento

> Alternativa ao QR no modo **UNOFFICIAL**: informe `phoneNumber` na query e receba um código alfanumérico (ex.: `FNPG5AYK`) para o usuário digitar no WhatsApp (Aparelhos conectados → Conectar com número de telefone). Use depois de criar a instância sem `pairingPhoneNumber`, ou para renovar o código. Escopo: **whatsapp:instances:list**.



## OpenAPI

````yaml /whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/pairing-code
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Envie mensagens WhatsApp e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar, listar, editar e cancelar mensagens
  - name: Instâncias
    description: >-
      Cadastre e gerencie os números de WhatsApp conectados — cada número é uma
      **instância** (o telefone por onde entram e saem as mensagens).
  - name: Grupos
    description: Grupos (só conexão não oficial)
  - name: Chamadas
    description: Ligar e falar no WhatsApp (conexão não oficial hoje; oficial em breve)
  - name: Sending pools
    description: Balanceamento de instâncias WhatsApp
paths:
  /v1/whatsapp/instances/{instanceId}/pairing-code:
    get:
      tags:
        - Instâncias
      summary: Obter código de pareamento
      description: >-
        Alternativa ao QR no modo **UNOFFICIAL**: informe `phoneNumber` na query
        e receba um código alfanumérico (ex.: `FNPG5AYK`) para o usuário digitar
        no WhatsApp (Aparelhos conectados → Conectar com número de telefone).
        Use depois de criar a instância sem `pairingPhoneNumber`, ou para
        renovar o código. Escopo: **whatsapp:instances:list**.
      operationId: ntfWa_getV1WhatsappInstancePairingCode
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
        - name: phoneNumber
          in: query
          required: true
          schema:
            type: string
            minLength: 10
            maxLength: 20
          description: >-
            Número internacional (E.164 / dígitos) do celular que vai confirmar
            o pareamento.
      responses:
        '200':
          description: Código de pareamento (ou null se já ACTIVE).
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ntfWa_GetV1WhatsappInstancePairingCodeResponse
              examples:
                pending:
                  summary: Código gerado
                  value:
                    success: true
                    data:
                      status: PENDING
                      method: pairing
                      pairingCode: FNPG5AYK
                      phoneNumber: '5511999999999'
                active:
                  summary: Já conectado
                  value:
                    success: true
                    data:
                      status: ACTIVE
                      method: pairing
                      pairingCode: null
                      phoneNumber: '5511999999999'
        '400':
          description: Instância oficial ou parâmetro inválido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '403':
          description: Escopo ou acesso à instância.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '404':
          description: Instância não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '429':
          description: Cooldown de reconexão ou excesso de tentativas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
components:
  schemas:
    ntfWa_GetV1WhatsappInstancePairingCodeResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            status:
              type: string
              description: PENDING, ACTIVE ou DISCONNECTED.
            method:
              type: string
              enum:
                - pairing
            pairingCode:
              type: string
              nullable: true
              description: Código alfanumérico para digitar no WhatsApp do celular.
            phoneNumber:
              type: string
              description: Número normalizado usado na solicitação.
      example:
        success: true
        data:
          status: string
          method: pairing
          pairingCode: string
          phoneNumber: string
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
      example:
        success: false
        error: string
        message: string
        code: string
        details:
          - field: string
            message: string
        note: string
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````