> ## 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. # Confirmar código de contato > ⚠️ **Esta chamada é real**: ela confirma um código da verificação de identidade do workspace, e o último **decide** a verificação. Confirma o código de 6 dígitos recebido nesse canal e responde **200** com o estado. Quando era o último código exigido e o documento já foi enviado, a verificação é decidida nesta mesma resposta — `APPROVED`, ou `IN_REVIEW` quando uma pessoa precisa conferir (**os dois permitem comprar**, `canPurchase: true`) — e o evento de webhook `phone_line.verification_updated` é enviado. Um código **expira 10 minutos** depois de enviado (400 `CONTACT_CODE_EXPIRED`). Um código errado é 400 `CONTACT_CODE_INVALID` e conta como tentativa; depois de **5 tentativas erradas** o código é bloqueado (429 `CONTACT_CODE_TOO_MANY_ATTEMPTS`) — peça um novo com `…/contact/{channel}/send`. Um código só vale uma vez: repetir uma confirmação que já deu certo responde `CONTACT_CODE_INVALID` — nesse caso, leia o estado com `GET /v1/phone-lines/verification`. O único campo do corpo é `code`; o canal vai no caminho. 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. ## OpenAPI ````yaml openapi.pt.json POST /v1/phone-lines/verification/contact/{channel}/confirm 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}/confirm: post: tags: - Phone Lines summary: Confirmar um código de contato description: >- ⚠️ **Esta chamada é real**: ela confirma um código da verificação de identidade do workspace, e o último **decide** a verificação. Confirma o código de 6 dígitos recebido nesse canal e responde **200** com o estado. Quando era o último código exigido e o documento já foi enviado, a verificação é decidida nesta mesma resposta — `APPROVED`, ou `IN_REVIEW` quando uma pessoa precisa conferir (**os dois permitem comprar**, `canPurchase: true`) — e o evento de webhook `phone_line.verification_updated` é enviado. Um código **expira 10 minutos** depois de enviado (400 `CONTACT_CODE_EXPIRED`). Um código errado é 400 `CONTACT_CODE_INVALID` e conta como tentativa; depois de **5 tentativas erradas** o código é bloqueado (429 `CONTACT_CODE_TOO_MANY_ATTEMPTS`) — peça um novo com `…/contact/{channel}/send`. Um código só vale uma vez: repetir uma confirmação que já deu certo responde `CONTACT_CODE_INVALID` — nesse caso, leia o estado com `GET /v1/phone-lines/verification`. O único campo do corpo é `code`; o canal vai no caminho. 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_confirm 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`. requestBody: required: true content: application/json: schema: type: object required: - code additionalProperties: false properties: code: type: string description: O código de 6 dígitos recebido nesse canal. example: '482913' example: code: '482913' responses: '200': description: >- Código confirmado; o estado da verificação (com a decisão, quando era o último código) 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. examples: approved: summary: Último código — aprovada value: status: APPROVED canPurchase: true verification: id: cmg5k0v3r0000vf8example7k documentType: CNPJ documentNumber: '**.***.333/0001-**' legalName: ACME LTDA contact: email: a***@example.com whatsapp: +5511****0000 requiredChannels: - WHATSAPP - EMAIL confirmedChannels: - WHATSAPP - EMAIL pendingChannels: [] document: status: RECEIVED reviewReason: null reviewNote: null createdAt: '2026-10-01T13:55:02.000Z' updatedAt: '2026-10-01T13:57:31.000Z' inReview: summary: Último código — esperando uma pessoa (compra permitida) value: status: IN_REVIEW canPurchase: true verification: id: cmg5k0v3r0000vf8example7k documentType: CNPJ documentNumber: '**.***.333/0001-**' legalName: ACME LTDA contact: email: a***@example.com whatsapp: +5511****0000 requiredChannels: - WHATSAPP - EMAIL confirmedChannels: - WHATSAPP - EMAIL pendingChannels: [] document: status: RECEIVED reviewReason: DOCUMENT_CHECK reviewNote: null createdAt: '2026-10-01T13:55:02.000Z' updatedAt: '2026-10-01T14:20:12.000Z' onePending: summary: Um canal ainda pendente value: 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`), `INVALID_BODY` (não é um objeto JSON), `UNKNOWN_FIELDS` (qualquer campo além de `code`), `CONTACT_CODE_INVALID` (código errado — conta como tentativa —, nenhum código nesse canal, ou `code` não é uma string), `CONTACT_CODE_EXPIRED` (mais de 10 minutos) ou `CONTACT_CODE_NOT_REQUIRED` (o canal não está em `requiredChannels`). content: application/json: schema: type: object properties: error: type: string description: Frase em inglês e frase em português separadas por ` | `. code: type: string description: Código de erro estável — decida por ele, nunca pelo texto. details: type: object description: >- Só em erros de validação: `unknownFields` (array) ou `maxLength` (número). additionalProperties: true examples: invalid: summary: Código errado value: error: Wrong code. | Código incorreto. code: CONTACT_CODE_INVALID expired: summary: Código expirado value: error: >- This code has expired. Request a new one. | Este código expirou. Peça um novo. code: CONTACT_CODE_EXPIRED 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 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 unknownFields: summary: Campo além de code value: error: >- Unknown field(s): channel. This endpoint accepts only "code"; the channel goes in the path. | Campo(s) desconhecido(s): channel. Este endpoint aceita apenas "code"; o canal vai no caminho. code: UNKNOWN_FIELDS details: unknownFields: - channel '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 '429': description: >- `CONTACT_CODE_TOO_MANY_ATTEMPTS`: 5 tentativas erradas — peça um novo código com `…/contact/{channel}/send`. content: application/json: schema: type: object properties: error: type: string code: type: string example: error: >- Too many wrong attempts. Request a new code. | Tentativas erradas demais. Peça um novo código. code: CONTACT_CODE_TOO_MANY_ATTEMPTS '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 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.