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

# Pareamento remoto (link de conexão)

> Gera um link para que outra pessoa conecte o próprio número. provider=PILOT_STATUS (padrão) exige name + number e devolve um link de pareamento por QR; provider=META devolve um link de Embedded Signup hospedado (a pessoa escolhe o número dentro do diálogo do Facebook, sem name/number).



## OpenAPI

````yaml openapi.pt.json POST /v1/numbers/remote-pairing
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/numbers/remote-pairing:
    post:
      tags:
        - Numbers
      summary: Pareamento remoto (link de conexão)
      description: >-
        Gera um link para que outra pessoa conecte o próprio número.
        provider=PILOT_STATUS (padrão) exige name + number e devolve um link de
        pareamento por QR; provider=META devolve um link de Embedded Signup
        hospedado (a pessoa escolhe o número dentro do diálogo do Facebook, sem
        name/number).
      operationId: post_numbers_remote-pairing
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                  description: Tipo de link (padrão PILOT_STATUS).
                  example: PILOT_STATUS
                name:
                  type: string
                  description: Obrigatório para PILOT_STATUS; ignorado para META.
                  example: Cliente Acme
                number:
                  type: string
                  description: Obrigatório para PILOT_STATUS; ignorado para META.
                  example: '5511988887777'
                sendViaWhatsApp:
                  type: boolean
                  description: Enviar o link por WhatsApp (PILOT_STATUS). Padrão false.
                  example: 'false'
                redirectUrl:
                  type: string
                  description: URL de redirecionamento após concluir (META).
                  example: https://app.acme.com/done
                externalRef:
                  type: string
                  description: Referência externa opcional para correlação (META).
                  example: customer-42
                linkToApiKey:
                  type: boolean
                  description: >-
                    Vincular o número resultante à API key chamadora (padrão
                    true).
                  example: 'true'
            example:
              name: Cliente Acme
              number: '5511988887777'
      responses:
        '201':
          description: Link PILOT_STATUS
          content:
            application/json:
              example:
                provider: PILOT_STATUS
                remotePairingToken: rp_01HZX...
                remotePairingUrl: https://pilotstatus.com.br/connect/rp_01HZX...
                numberId: num_01HZX...
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````