Começar
Da chave de teste à primeira resposta, sem custo e sem falar com ninguém.
A API do NexusQuery reúne consultas a órgãos públicos, certidões, processos, dados cadastrais e validação de documentos numa única chave de API e num único formato de resposta. Você contrata só os produtos que usa e paga por consulta concluída.
Começo rápido
1. Crie uma chave de teste. No portal, em Chaves de API, crie uma chave do ambiente Teste. Ela começa com nxq_test_, responde com dados fictícios e nunca cobra.
2. Faça a primeira consulta. Guarde a chave numa variável de ambiente — nunca no código:
export NEXUSQUERY_CHAVE="cole aqui a chave de teste"
curl https://api.nexusquery.com.br/v1/antecedentes/consultas \
-H "Authorization: Bearer $NEXUSQUERY_CHAVE" \
-H "Content-Type: application/json" \
-d '{"cpf": "000.000.001-91", "referencia": "cadastro-4821"}'3. Leia a resposta.
{
"id": "req_01J9Z3K8W4M2Q7T5V6X8Y9A0BC",
"produto": "antecedentes",
"ambiente": "test",
"pessoa": "000.000.001-91",
"referencia": "cadastro-4821",
"codigo": "nada_consta",
"resultado": "Nada consta",
"cobrada": false,
"custo": "0.00",
"detalhe": {
"explicacao": "Certidão de antecedentes criminais da Polícia Federal: nada consta (resposta de teste).",
"certidao": { "status": "NADA CONSTA", "numero": "000000000000", "emitidaEm": "2026-09-14T10:00:00-03:00", "validaAte": "2026-12-13" }
},
"em": "2026-09-16T13:02:11Z"
}Decida pelo campo codigo — ele é estável e feito para máquina. resultado é o mesmo desfecho escrito para pessoas.
4. Vá para produção. Contrate o produto no portal, crie uma chave do ambiente Produção (nxq_live_) e troque a chave. A URL, o corpo e a resposta são os mesmos.
Boas práticas
- Envie
referenciasempre. É como você acha a consulta no histórico e casa o webhook com o seu cadastro. - Guarde o
idde toda resposta. É o que o suporte pede. - Decida por
codigo, nunca porresultadoou por texto dedetalhe. - Desfecho que não cobra não é "nada consta".
em_processamento: espere o webhook.sem_retornoeindisponivel: tente mais tarde.nao_emitida,pedido_recusadoedados_divergentes: confira os dados ou peça outro documento. - Leia
dadoseitenspelo nome do campo, não pela posição: campos novos podem aparecer, e campo sem valor não é enviado. - Use chaves separadas por sistema ou por cliente seu, cada uma só com os produtos que usa e com limite de gasto.
- Não repita
4xxnemem_processamento. Só429,502e503merecem nova tentativa.
Suporte
Dúvidas de integração, erro inesperado ou produto que precisa de um campo novo: contato@nexusquery.com.br. Envie o id da consulta (req_…) — com ele achamos tudo o que aconteceu, sem você mandar nenhum dado pessoal.