Phone Lines

Send a new document

⚠️ This call is real: it uploads a new identity document to the workspace’s verification, replacing the previous one, and can decide the verification.

Replaces the document of the current verification and answers 200 with the state. The body is JSON (Content-Type: application/json), not multipart: { "document": "data:…;base64,…" }, the same file rules as POST /v1/phone-lines/verification, and it counts against the same submission limit (10 per hour per workspace → 429 RATE_LIMITED). Accepted in two states:

PENDING_CONTACT — to replace the document you sent. Do it when document.status is UNREADABLE or UNCLEAR: we could not read a number we trust from the file, so send a sharper photo or the PDF. If you confirm the last code without replacing it, the verification goes to manual review (IN_REVIEW, reviewReason: "DOCUMENT_CHECK").
NEEDS_DOCUMENT — the reviewer asked for another document (reviewNote may say which). The contact codes were already confirmed, so the new document takes the verification straight back to a decision, in this same response.

In any other state it answers 409 VERIFICATION_WRONG_STATE; with no verification, 404 VERIFICATION_NOT_FOUND. No Idempotency-Key: a document replaces the previous one. Requires a tenant-scoped key, like every /v1/phone-lines endpoint (a number-scoped key gets 403 NUMBER_SCOPE_NOT_ALLOWED). Permission phone_lines:purchase, the same as buying: with an OAuth/MCP token only the workspace OWNER may call it (403 PERMISSION_DENIED otherwise). It is the same verification as the dashboard’s (Phone lines → Buy phone lines): whichever you use, the other sees the result. The response is the verification state object, sent with Cache-Control: no-store; the document number and the contacts come back masked.

POST

phone-lines

verification

document

Send a new document

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

This replaces the document of your real identity verification.

Authorizations

x-api-key

string

header

required

Your ps_ API key

Body

application/json

document

string

required

The document file as a base64 data URI: data:<type>;base64,<content>, encoded without line breaks. Types: application/pdf, image/jpeg, image/png, image/webp; at most 10 MB of file (about 14 MB once encoded). For a CNPJ: the CNPJ card (Cartão CNPJ), the articles of incorporation or the registration proof. For a CPF: an ID card (RG), a driver license (CNH) or the CPF registration proof, with the number readable.

Example:

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

Response

Document replaced; the verification state

status

enum<string>

NONE (never started), PENDING_CONTACT (waiting for the contact codes and, if document.status says so, a better document), IN_REVIEW (finished, waiting for a person — purchase allowed), APPROVED (verified — purchase allowed), NEEDS_DOCUMENT (the reviewer asked for another document) or REJECTED (final — talk to support). The phone_line.verification_updated webhook uses the same values for the last four.

Available options:

NONE,

PENDING_CONTACT,

IN_REVIEW,

APPROVED,

NEEDS_DOCUMENT,

REJECTED

canPurchase

boolean

Whether POST /v1/phone-lines is allowed now: true for APPROVED and IN_REVIEW.

verification

object | null

null for NONE.

Show child attributes

Send a new document

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

Send a new document

Authorizations

Body

Response