Phone Lines

Confirm contact code

⚠️ This call is real: it confirms a code of the workspace’s identity verification, and the last one decides the verification.

Confirms the 6-digit code received on that channel and answers 200 with the state. When it was the last required code and the document is in, the verification is decided in this same response — APPROVED, or IN_REVIEW when a person needs to look at it (both let you buy, canPurchase: true) — and the phone_line.verification_updated webhook event goes out.

A code expires 10 minutes after it was sent (400 CONTACT_CODE_EXPIRED). A wrong code is 400 CONTACT_CODE_INVALID and counts as an attempt; after 5 wrong attempts the code is locked (429 CONTACT_CODE_TOO_MANY_ATTEMPTS) — send a new one with …/contact/{channel}/send. A code is used once: retrying a confirm that already succeeded answers CONTACT_CODE_INVALID — read the state with GET /v1/phone-lines/verification instead. The only body field is code; the channel goes in the path. 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

contact

{channel}

confirm

Confirm a contact code

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "482913"
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm"

payload = { "code": "482913" }
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({code: '482913'})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm', 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/contact/{channel}/confirm",
  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([
    'code' => '482913'
  ]),
  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/contact/{channel}/confirm"

	payload := strings.NewReader("{\n  \"code\": \"482913\"\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/contact/{channel}/confirm")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"482913\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm")

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  \"code\": \"482913\"\n}"

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

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

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

channel

enum<string>

required

The contact channel, lowercase: whatsapp or email. It must be in verification.contact.requiredChannels (there in upper case). Anything else → 400 INVALID_CONTACT_CHANNEL.

Available options:

whatsapp,

email

Body

application/json

code

string

required

The 6-digit code received on that channel.

Example:

"482913"

Response

Code confirmed; the verification state (with the decision when it was the last code)

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

Confirm a contact code

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "code": "482913"
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm"

payload = { "code": "482913" }
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({code: '482913'})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm', 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/contact/{channel}/confirm",
  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([
    'code' => '482913'
  ]),
  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/contact/{channel}/confirm"

	payload := strings.NewReader("{\n  \"code\": \"482913\"\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/contact/{channel}/confirm")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"482913\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/verification/contact/{channel}/confirm")

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  \"code\": \"482913\"\n}"

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

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

Endpoints

Workspace

Confirm contact code

Authorizations

Path Parameters

Body

Response