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

# Enviar código de contato

> ⚠️ **Esta chamada é real**: ela **envia um código de verificação real** para o contato do titular nesse canal (uma mensagem de WhatsApp ou um e-mail).

Envia um novo código em um canal exigido da verificação atual e responde **200** com o estado. O novo código substitui o anterior. Sem corpo. Os primeiros códigos são enviados pelo próprio `POST /v1/phone-lines/verification`: chame este endpoint para um código que expirou (10 minutos), foi bloqueado (5 tentativas erradas) ou não chegou.

No máximo **um código por canal a cada 60 segundos**, contando o que o envio dos dados mandou (429 `CONTACT_CODE_COOLDOWN`). Só enquanto a verificação está em `PENDING_CONTACT` (409 `VERIFICATION_WRONG_STATE` depois disso), e só em um canal de `requiredChannels` (400 `CONTACT_CODE_NOT_REQUIRED`). 503 `SUPPLIER_UNAVAILABLE`: não foi possível colocar o código na fila de envio; nada conta para o intervalo de 60 segundos — tente de novo. Sem `Idempotency-Key`: um novo código é limitado pelo intervalo de 60 segundos. Exige uma chave **com escopo de tenant**, como todo endpoint `/v1/phone-lines` (uma chave com escopo de número recebe `403 NUMBER_SCOPE_NOT_ALLOWED`). Permissão `phone_lines:purchase`, a mesma da compra: com um token OAuth/MCP, só o **OWNER** do workspace pode chamar (`403 PERMISSION_DENIED` caso contrário). É a mesma verificação do painel (**Linhas** → **Comprar linhas**): o que você fizer por um caminho aparece no outro. A resposta é o objeto de estado da verificação, enviado com `Cache-Control: no-store`; o número do documento e os contatos voltam mascarados.

> [!NOTE]
>
> Isto envia um código real para o contato que você cadastrou na verificação.


## OpenAPI

````yaml openapi.pt.json POST /v1/phone-lines/verification/contact/{channel}/send
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/phone-lines/verification/contact/{channel}/send:
    post:
      tags:
        - Phone Lines
      summary: Enviar um novo código de contato
      description: >-
        ⚠️ **Esta chamada é real**: ela **envia um código de verificação real**
        para o contato do titular nesse canal (uma mensagem de WhatsApp ou um
        e-mail).


        Envia um novo código em um canal exigido da verificação atual e responde
        **200** com o estado. O novo código substitui o anterior. Sem corpo. Os
        primeiros códigos são enviados pelo próprio `POST
        /v1/phone-lines/verification`: chame este endpoint para um código que
        expirou (10 minutos), foi bloqueado (5 tentativas erradas) ou não
        chegou.


        No máximo **um código por canal a cada 60 segundos**, contando o que o
        envio dos dados mandou (429 `CONTACT_CODE_COOLDOWN`). Só enquanto a
        verificação está em `PENDING_CONTACT` (409 `VERIFICATION_WRONG_STATE`
        depois disso), e só em um canal de `requiredChannels` (400
        `CONTACT_CODE_NOT_REQUIRED`). 503 `SUPPLIER_UNAVAILABLE`: não foi
        possível colocar o código na fila de envio; nada conta para o intervalo
        de 60 segundos — tente de novo. Sem `Idempotency-Key`: um novo código é
        limitado pelo intervalo de 60 segundos. Exige uma chave **com escopo de
        tenant**, como todo endpoint `/v1/phone-lines` (uma chave com escopo de
        número recebe `403 NUMBER_SCOPE_NOT_ALLOWED`). Permissão
        `phone_lines:purchase`, a mesma da compra: com um token OAuth/MCP, só o
        **OWNER** do workspace pode chamar (`403 PERMISSION_DENIED` caso
        contrário). É a mesma verificação do painel (**Linhas** → **Comprar
        linhas**): o que você fizer por um caminho aparece no outro. A resposta
        é o objeto de estado da verificação, enviado com `Cache-Control:
        no-store`; o número do documento e os contatos voltam mascarados.
      operationId: post_phone_lines_verification_contact_channel_send
      parameters:
        - name: channel
          in: path
          required: true
          schema:
            type: string
            enum:
              - whatsapp
              - email
          example: email
          description: >-
            O canal de contato, **em minúsculas**: `whatsapp` ou `email`.
            Precisa estar em `verification.contact.requiredChannels` (lá em
            maiúsculas). Qualquer outro valor → 400 `INVALID_CONTACT_CHANNEL`.
      responses:
        '200':
          description: Novo código enviado; o estado da verificação
          headers:
            Cache-Control:
              description: Sempre `no-store`.
              schema:
                type: string
                enum:
                  - no-store
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - NONE
                      - PENDING_CONTACT
                      - IN_REVIEW
                      - APPROVED
                      - NEEDS_DOCUMENT
                      - REJECTED
                    description: >-
                      `NONE` (nunca iniciada), `PENDING_CONTACT` (esperando os
                      códigos de contato e, se `document.status` indicar, um
                      documento melhor), `IN_REVIEW` (concluída, esperando uma
                      pessoa conferir — compra permitida), `APPROVED`
                      (verificada — compra permitida), `NEEDS_DOCUMENT` (o
                      revisor pediu outro documento) ou `REJECTED` (definitivo —
                      fale com o suporte). O webhook
                      `phone_line.verification_updated` usa os mesmos valores
                      para os quatro últimos.
                  canPurchase:
                    type: boolean
                    description: >-
                      Se `POST /v1/phone-lines` é permitido agora: `true` para
                      `APPROVED` e `IN_REVIEW`.
                  verification:
                    type: object
                    nullable: true
                    description: '`null` para `NONE`.'
                    properties:
                      id:
                        type: string
                        description: >-
                          Identifica a verificação — é o `verificationId` do
                          evento de webhook, e o que o suporte vai pedir.
                      documentType:
                        type: string
                        enum:
                          - CNPJ
                          - CPF
                      documentNumber:
                        type: string
                        description: >-
                          **Mascarado**: `**.***.333/0001-**` (CNPJ) ou
                          `***.456.789-**` (CPF). O número completo nunca é
                          retornado.
                      legalName:
                        type: string
                        nullable: true
                        description: >-
                          A razão social na Receita (CNPJ). `null` para CPF, e
                          quando a Receita não pôde ser consultada.
                      contact:
                        type: object
                        properties:
                          email:
                            type: string
                            description: >-
                              O e-mail de contato, mascarado
                              (`a***@example.com`).
                          whatsapp:
                            type: string
                            nullable: true
                            description: >-
                              O WhatsApp de contato, mascarado
                              (`+5511****0000`).
                          requiredChannels:
                            type: array
                            items:
                              type: string
                              enum:
                                - WHATSAPP
                                - EMAIL
                            description: >-
                              `WHATSAPP` e/ou `EMAIL`: os códigos de que esta
                              verificação precisa. Fica congelada quando a
                              verificação começa. Pela API, `EMAIL` é sempre
                              exigido.
                          confirmedChannels:
                            type: array
                            items:
                              type: string
                              enum:
                                - WHATSAPP
                                - EMAIL
                            description: Os canais exigidos já confirmados.
                          pendingChannels:
                            type: array
                            items:
                              type: string
                              enum:
                                - WHATSAPP
                                - EMAIL
                            description: Os canais exigidos que ainda esperam o código.
                      document:
                        type: object
                        properties:
                          status:
                            type: string
                            enum:
                              - RECEIVED
                              - UNREADABLE
                              - UNCLEAR
                              - REQUESTED
                              - MISSING
                            description: >-
                              `RECEIVED` (o documento foi recebido),
                              `UNREADABLE` (não encontramos nenhum número no
                              arquivo), `UNCLEAR` (encontramos números, mas
                              nenhum em que pudéssemos confiar), `REQUESTED` (o
                              revisor pediu outro documento) ou `MISSING` (ainda
                              sem documento). Nos quatro últimos, envie um novo
                              documento com `POST
                              /v1/phone-lines/verification/document`.
                      reviewReason:
                        type: string
                        nullable: true
                        enum:
                          - REGISTRY_UNAVAILABLE
                          - DOCUMENT_CHECK
                          - null
                        description: >-
                          Só em `IN_REVIEW`: `REGISTRY_UNAVAILABLE` (não foi
                          possível consultar a Receita) ou `DOCUMENT_CHECK` (o
                          documento precisa ser conferido). `null` nos outros
                          casos.
                      reviewNote:
                        type: string
                        nullable: true
                        description: >-
                          A mensagem do revisor, só em `REJECTED` e
                          `NEEDS_DOCUMENT`. `null` nos outros casos — e pode ser
                          `null` nesses também.
                      createdAt:
                        type: string
                        format: date-time
                        description: ISO 8601 — quando esta verificação foi enviada.
                      updatedAt:
                        type: string
                        format: date-time
                        description: ISO 8601 — a última mudança dela.
              example:
                status: PENDING_CONTACT
                canPurchase: false
                verification:
                  id: cmg5k0v3r0000vf8example7k
                  documentType: CNPJ
                  documentNumber: '**.***.333/0001-**'
                  legalName: ACME LTDA
                  contact:
                    email: a***@example.com
                    whatsapp: +5511****0000
                    requiredChannels:
                      - WHATSAPP
                      - EMAIL
                    confirmedChannels:
                      - WHATSAPP
                    pendingChannels:
                      - EMAIL
                  document:
                    status: RECEIVED
                  reviewReason: null
                  reviewNote: null
                  createdAt: '2026-10-01T13:55:02.000Z'
                  updatedAt: '2026-10-01T13:56:40.000Z'
        '400':
          description: >-
            `INVALID_CONTACT_CHANNEL`: `{channel}` não é `whatsapp` nem `email`.
            `CONTACT_CODE_NOT_REQUIRED`: o canal não está em `requiredChannels`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              examples:
                invalidChannel:
                  summary: Canal desconhecido
                  value:
                    error: >-
                      The channel in the path must be "whatsapp" or "email". | O
                      canal no caminho deve ser "whatsapp" ou "email".
                    code: INVALID_CONTACT_CHANNEL
                notRequired:
                  summary: Canal não exigido
                  value:
                    error: >-
                      This channel does not need a code. | Este canal não
                      precisa de código.
                    code: CONTACT_CODE_NOT_REQUIRED
        '401':
          description: >-
            Header `x-api-key` / `x-api-key-id` (ou token OAuth Bearer) ausente
            ou inválido. Este corpo não traz `code`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Invalid API key
        '403':
          description: >-
            Chave com escopo de número ou grant OAuth por número
            (`NUMBER_SCOPE_NOT_ALLOWED` — use a chave com escopo de tenant);
            token OAuth/MCP de um usuário que não é o OWNER do workspace
            (`PERMISSION_DENIED`) ou que não é mais membro ativo
            (`WORKSPACE_MEMBERSHIP_REQUIRED`); workspace arquivado
            (`WORKSPACE_ARCHIVED`). Os erros de escopo e de papel trazem um
            `error` só em inglês.. `TENANT_REQUIRED`: credencial sem workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              examples:
                numberScope:
                  summary: Chave com escopo de número
                  value:
                    error: This endpoint requires a tenant-scoped API key
                    code: NUMBER_SCOPE_NOT_ALLOWED
                permission:
                  summary: Usuário OAuth/MCP não é o OWNER
                  value:
                    error: >-
                      Your workspace role does not allow this action
                      (phone_lines:purchase).
                    code: PERMISSION_DENIED
                membership:
                  summary: Usuário OAuth/MCP não é mais membro ativo
                  value:
                    error: >-
                      The user behind this token is not an active member of this
                      workspace.
                    code: WORKSPACE_MEMBERSHIP_REQUIRED
                archived:
                  summary: Workspace arquivado
                  value:
                    error: >-
                      This workspace has been archived and its API is closed. |
                      Este workspace foi arquivado e sua API está encerrada.
                    code: WORKSPACE_ARCHIVED
                tenantRequired:
                  summary: Credencial sem workspace
                  value:
                    error: This credential is not bound to a workspace.
                    code: TENANT_REQUIRED
        '404':
          description: '`VERIFICATION_NOT_FOUND`: nada foi enviado neste workspace.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Verification not found. | Verificação não encontrada.
                code: VERIFICATION_NOT_FOUND
        '409':
          description: >-
            `VERIFICATION_WRONG_STATE`: a verificação não está mais em
            `PENDING_CONTACT`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  The verification is not in a state that allows this. | A
                  verificação não está em um estado que permita isso.
                code: VERIFICATION_WRONG_STATE
        '429':
          description: >-
            `CONTACT_CODE_COOLDOWN`: um código foi enviado nesse canal há menos
            de 60 segundos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Wait a moment before requesting another code. | Aguarde um
                  pouco antes de pedir outro código.
                code: CONTACT_CODE_COOLDOWN
        '500':
          description: Falha inesperada. Tente de novo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unexpected error. | Erro inesperado.
                code: INTERNAL_ERROR
        '503':
          description: >-
            `SUPPLIER_UNAVAILABLE`: não foi possível colocar o código na fila de
            envio. Nada conta para o intervalo de 60 segundos — tente de novo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Phone lines are temporarily unavailable. Try again in a few
                  minutes. | As linhas estão temporariamente indisponíveis.
                  Tente de novo em alguns minutos.
                code: SUPPLIER_UNAVAILABLE
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)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.