curl --request GET \
--url https://app.useqx.com/api/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/contacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/contacts/{id}', 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://app.useqx.com/api/v1/contacts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/contacts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/contacts/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/contacts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda",
"trade_name": "Exemplo",
"email": "fiscal@importadora.com.br",
"tax_id": "12345678000195",
"lookup_status": "completed",
"discarded": false,
"origin": "contact",
"created_at": "2026-09-25T10:30:00.000-03:00"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "O recurso não existe na organização da chave.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Ler um contato
Lê uma pessoa ou uma empresa da organização da chave. A chamada acha também o contato arquivado e o sócio que a consulta do CNPJ criou.
curl --request GET \
--url https://app.useqx.com/api/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/contacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/contacts/{id}', 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://app.useqx.com/api/v1/contacts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/contacts/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/contacts/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/contacts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda",
"trade_name": "Exemplo",
"email": "fiscal@importadora.com.br",
"tax_id": "12345678000195",
"lookup_status": "completed",
"discarded": false,
"origin": "contact",
"created_at": "2026-09-25T10:30:00.000-03:00"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "O recurso não existe na organização da chave.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Authorizations
A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.
Path Parameters
O id do contato. O id da pessoa começa com per_, e o id da empresa começa com com_.
Response
O contato.
O id do contato. O id da pessoa começa com per_, e o id da empresa começa com com_.
^(per|com)_[1-9][0-9]*$"com_12"
person para a pessoa e company para a empresa.
person, company O nome do contato. O valor é null até a consulta do CPF ou do CNPJ trazer o nome.
"Importadora Exemplo Ltda"
O nome fantasia da empresa. Na pessoa, o valor é null.
"Exemplo"
O e-mail do contato, em minúsculas.
"fiscal@importadora.com.br"
O CPF da pessoa ou o CNPJ da empresa, sem pontuação e com as letras em maiúscula. O valor é null na pessoa que espera a confirmação do CPF.
"12345678000195"
O andamento da consulta do CPF ou do CNPJ. not_enqueued: a consulta não começou. pending: a consulta está em curso. completed: a consulta terminou. failed: a consulta falhou. stale: os dados da consulta estão velhos. needs_review: a pessoa espera a confirmação do CPF.
not_enqueued, pending, completed, failed, stale, needs_review Com true, o contato está arquivado.
contact para o contato que a organização criou. shareholder para o sócio que a consulta do CNPJ criou.
contact, shareholder A data e a hora da criação, no fuso horário da organização.
"2026-09-25T10:30:00.000-03:00"