Listar os pacotes
curl --request GET \
--url https://app.useqx.com/api/v1/packs \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/packs"
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/packs', 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/packs",
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/packs"
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/packs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/packs")
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{
"data": [
{
"id": "pck_12",
"name": "Importação marítima",
"kind": "operation",
"required_for": "pj",
"active": true,
"identification_mode": "any",
"requirements": [
{
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"required": true,
"identifier": true,
"accepts_many": true,
"position": 1
},
{
"document_type": {
"id": "dtp_32",
"name": "Bill of Lading (B/L)"
},
"required": true,
"identifier": true,
"accepts_many": false,
"position": 2
},
{
"document_type": {
"id": "dtp_33",
"name": "Romaneio de Carga (Packing List)"
},
"required": false,
"identifier": false,
"accepts_many": true,
"position": 3
}
]
},
{
"id": "pck_9",
"name": "Cadastro PJ",
"kind": "kyc",
"required_for": "pj",
"active": true,
"identification_mode": "any",
"requirements": [
{
"document_type": {
"id": "dtp_4",
"name": "Contrato Social"
},
"required": true,
"identifier": false,
"accepts_many": false,
"position": 1
},
{
"document_type": {
"id": "dtp_7",
"name": "Cartão CNPJ"
},
"required": true,
"identifier": false,
"accepts_many": false,
"position": 2
}
]
}
],
"has_more": false,
"next_cursor": null
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "O parâmetro limit tem um valor inválido.",
"code": "invalid_parameter"
}{
"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": "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"
}Pacotes
Listar os pacotes
Lista os pacotes da organização da chave, do mais novo ao mais antigo. A lista traz os pacotes ativos e os inativos. Cada pacote traz os requisitos na ordem do pacote.
GET
/
packs
Listar os pacotes
curl --request GET \
--url https://app.useqx.com/api/v1/packs \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/packs"
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/packs', 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/packs",
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/packs"
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/packs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/packs")
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{
"data": [
{
"id": "pck_12",
"name": "Importação marítima",
"kind": "operation",
"required_for": "pj",
"active": true,
"identification_mode": "any",
"requirements": [
{
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"required": true,
"identifier": true,
"accepts_many": true,
"position": 1
},
{
"document_type": {
"id": "dtp_32",
"name": "Bill of Lading (B/L)"
},
"required": true,
"identifier": true,
"accepts_many": false,
"position": 2
},
{
"document_type": {
"id": "dtp_33",
"name": "Romaneio de Carga (Packing List)"
},
"required": false,
"identifier": false,
"accepts_many": true,
"position": 3
}
]
},
{
"id": "pck_9",
"name": "Cadastro PJ",
"kind": "kyc",
"required_for": "pj",
"active": true,
"identification_mode": "any",
"requirements": [
{
"document_type": {
"id": "dtp_4",
"name": "Contrato Social"
},
"required": true,
"identifier": false,
"accepts_many": false,
"position": 1
},
{
"document_type": {
"id": "dtp_7",
"name": "Cartão CNPJ"
},
"required": true,
"identifier": false,
"accepts_many": false,
"position": 2
}
]
}
],
"has_more": false,
"next_cursor": null
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "O parâmetro limit tem um valor inválido.",
"code": "invalid_parameter"
}{
"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": "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_.
Query Parameters
A quantidade de itens da página, de 1 a 100. O padrão é 25.
Required range:
1 <= x <= 100O valor de next_cursor da página anterior. Sem este parâmetro, a lista começa no item mais novo.
Com true, a lista traz só os pacotes ativos. Com false, a lista traz só os inativos.
O tipo do pacote. O pacote kyc pede o cadastro do cliente. O pacote operation pede os documentos de uma operação.
Available options:
kyc, operation