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": "Bad Request",
"status": 400,
"detail": "The API could not read the call. Check the shape and the encoding of the path and the query, the JSON of the body and the headers.",
"code": "malformed_request"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The call did not include a valid API key. Send the key in the Authorization header, in the format Bearer <key>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "The subscription of the organization is blocked. Settle the payment in QX to use the API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "The free plan does not include the API. Subscribe to a paid plan in QX to use the API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "The resource does not exist in the key's organization.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The key went over a per-minute limit. Wait for the seconds in the Retry-After header and call again.",
"code": "rate_limited"
}Read a contact
Reads a person or a company of the key’s organization. The call also finds an archived contact and a shareholder that the CNPJ lookup created.
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": "Bad Request",
"status": 400,
"detail": "The API could not read the call. Check the shape and the encoding of the path and the query, the JSON of the body and the headers.",
"code": "malformed_request"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "The call did not include a valid API key. Send the key in the Authorization header, in the format Bearer <key>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "The subscription of the organization is blocked. Settle the payment in QX to use the API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "The free plan does not include the API. Subscribe to a paid plan in QX to use the API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "The resource does not exist in the key's organization.",
"code": "not_found"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "The key went over a per-minute limit. Wait for the seconds in the Retry-After header and call again.",
"code": "rate_limited"
}Authorizations
The API key of the organization, in the Authorization: Bearer <key> header. The key starts with qx_.
Path Parameters
The id of the contact. A person id starts with per_, and a company id starts with com_.
Response
The contact.
The id of the contact. A person id starts with per_, and a company id starts with com_.
^(per|com)_[1-9][0-9]*$"com_12"
person for a person and company for a company.
person, company The name of the contact. The value is null until the CPF or CNPJ lookup returns the name.
"Importadora Exemplo Ltda"
The trade name of the company. On a person, the value is null.
"Exemplo"
The email of the contact, in lowercase.
"fiscal@importadora.com.br"
The CPF of the person or the CNPJ of the company, without punctuation and with uppercase letters. The value is null on a person who waits for the CPF confirmation.
"12345678000195"
The progress of the CPF or CNPJ lookup. not_enqueued: the lookup did not start. pending: the lookup is in progress. completed: the lookup ended. failed: the lookup failed. stale: the lookup data is old. needs_review: the person waits for the CPF confirmation.
not_enqueued, pending, completed, failed, stale, needs_review With true, the contact is archived.
contact for a contact that the organization created. shareholder for a shareholder that the CNPJ lookup created.
contact, shareholder The date and the time of the creation, in the time zone of the organization.
"2026-09-25T10:30:00.000-03:00"