Linhas telefônicas

Enviar novo documento

⚠️ Esta chamada é real: ela envia um novo documento de identidade para a verificação do workspace, substituindo o anterior, e pode decidir a verificação.

Substitui o documento da verificação atual e responde 200 com o estado. O corpo é JSON (Content-Type: application/json), não multipart: { "document": "data:…;base64,…" }, com as mesmas regras de arquivo de POST /v1/phone-lines/verification, e conta no mesmo limite de envios (10 por hora por workspace → 429 RATE_LIMITED). É aceito em dois estados:

PENDING_CONTACT — para substituir o documento que você enviou. Faça isso quando document.status for UNREADABLE ou UNCLEAR: não conseguimos ler do arquivo um número confiável, então envie uma foto mais nítida ou o PDF. Se você confirmar o último código sem substituí-lo, a verificação vai para análise manual (IN_REVIEW, reviewReason: "DOCUMENT_CHECK").
NEEDS_DOCUMENT — o revisor pediu outro documento (reviewNote pode dizer qual). Os códigos de contato já foram confirmados, então o novo documento leva a verificação direto a uma nova decisão, nesta mesma resposta.

Em qualquer outro estado, responde 409 VERIFICATION_WRONG_STATE; sem nenhuma verificação, 404 VERIFICATION_NOT_FOUND. Sem Idempotency-Key: um documento substitui o anterior. 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.

POST

phone-lines

verification

document

Enviar um novo documento

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/verification/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "document": "data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=="
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/verification/document"

payload = { "document": "data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: 'data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=='})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/verification/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/verification/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => 'data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=='
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/phone-lines/verification/document"

	payload := strings.NewReader("{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/verification/document")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/verification/document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

Isto substitui o documento da sua verificação de identidade real.

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Corpo

application/json

document

string

obrigatório

O arquivo do documento como data URI em base64: data:<tipo>;base64,<conteúdo>, codificado sem quebras de linha. Tipos: application/pdf, image/jpeg, image/png, image/webp; no máximo 10 MB de arquivo (cerca de 14 MB depois de codificado). Para CNPJ: cartão CNPJ, contrato social ou comprovante de inscrição. Para CPF: RG, CNH ou comprovante de inscrição no CPF, com o número legível.

Exemplo:

"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=="

Resposta

Documento substituído; o estado da verificação

status

enum<string>

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.

Opções disponíveis:

NONE,

PENDING_CONTACT,

IN_REVIEW,

APPROVED,

NEEDS_DOCUMENT,

REJECTED

canPurchase

boolean

Se POST /v1/phone-lines é permitido agora: true para APPROVED e IN_REVIEW.

verification

object | null

null para NONE.

Show child attributes

Enviar um novo documento

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/verification/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "document": "data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=="
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/verification/document"

payload = { "document": "data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: 'data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=='})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/verification/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/verification/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => 'data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg=='
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/phone-lines/verification/document"

	payload := strings.NewReader("{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/verification/document")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/verification/document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": \"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsOfCg==\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

Endpoints

Workspace

Enviar novo documento

Autorizações

Corpo

Resposta