> ## 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.

# Remote pairing (connection link)

> Generates a link so another person connects their own number. provider=PILOT_STATUS (default) requires name + number and returns a QR pairing link; provider=META returns a hosted Embedded Signup link (the person picks the number inside the Facebook dialog, no name/number).



## OpenAPI

````yaml openapi.json POST /v1/numbers/remote-pairing
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `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: Remote pairing (connection link)
      description: >-
        Generates a link so another person connects their own number.
        provider=PILOT_STATUS (default) requires name + number and returns a QR
        pairing link; provider=META returns a hosted Embedded Signup link (the
        person picks the number inside the Facebook dialog, no name/number).
      operationId: post_numbers_remote-pairing
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                  description: Link kind (default PILOT_STATUS).
                  example: PILOT_STATUS
                name:
                  type: string
                  description: Required for PILOT_STATUS; ignored for META.
                  example: Cliente Acme
                number:
                  type: string
                  description: Required for PILOT_STATUS; ignored for META.
                  example: '5511988887777'
                sendViaWhatsApp:
                  type: boolean
                  description: Send the link over WhatsApp (PILOT_STATUS). Default false.
                  example: 'false'
                redirectUrl:
                  type: string
                  description: Redirect URL after completion (META).
                  example: https://app.acme.com/done
                externalRef:
                  type: string
                  description: Optional external reference for correlation (META).
                  example: customer-42
                linkToApiKey:
                  type: boolean
                  description: >-
                    Link the resulting number to the calling API key (default
                    true).
                  example: 'true'
            example:
              name: Cliente Acme
              number: '5511988887777'
      responses:
        '201':
          description: PILOT_STATUS link
          content:
            application/json:
              example:
                provider: PILOT_STATUS
                remotePairingToken: rp_01HZX...
                remotePairingUrl: https://pilotstatus.com.br/connect/rp_01HZX...
                numberId: num_01HZX...
        '400':
          description: Invalid payload or parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Rate limit exceeded
          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: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````