API do Detectin
Consulte CPF e CNPJ a partir do sistema da sua empresa. A API usa o mesmo contrato, a mesma franquia e a mesma trilha de auditoria do painel.
Endereço base: https://detectin.argentrix.com.br/api/v1
Autenticação
O gestor da empresa cria as chaves em Gestão da empresa › API. Cada chave pertence a uma empresa, pode ser limitada a IPs e é revogada na hora. Envie em todas as chamadas:
Authorization: Bearer dtk_...
Guarde a chave como senha: ela aparece uma única vez. Use sempre HTTPS. Nunca coloque a chave em código que roda no navegador.
Consultar documento
POST /consultas
curl -X POST https://detectin.argentrix.com.br/api/v1/consultas \
-H "Authorization: Bearer $DETECTIN_KEY" \
-H "Content-Type: application/json" \
-d '{"documento": "11.444.777/0001-61"}'
| Campo | Tipo | Descrição |
|---|---|---|
documento | texto | CPF ou CNPJ, com ou sem pontuação. Obrigatório. Dígitos verificadores são conferidos antes de qualquer cobrança. |
tipo | cpf | cnpj | Opcional; detectado pelo documento. |
idade_maxima_dias | inteiro | Opcional. Se o dado guardado for mais antigo, reconsulta a fonte (conta como consulta nova). |
incluir_bruto | booleano | Inclui o retorno bruto das fontes, com dados de terceiros redigidos. |
A resposta traz o dossiê (entity, sinais, verificações e fontes com a data real de coleta), o identificador consulta_id e o bloco billing:
{
"consulta_id": "66f1c0...",
"envelope_version": 2,
"entity": { "document": {...}, "name": "...", ... },
"billing": {
"model": "contract",
"bucket": "included", // included | overage | repeat | own_api
"charged": true,
"period": "2026-09",
"note": "Descontada da franquia do mês."
}
}
Recuperar uma consulta
GET /consultas/{consulta_id} — devolve o dossiê exatamente como foi entregue. Sem custo.
Listar consultas
GET /consultas?pagina=1&por_pagina=50&desde=2026-09-01T00:00:00 — consultas da empresa (painel e API), com documento mascarado, data e forma de cobrança.
Uso da franquia
GET /uso e GET /status
{
"periodo": "2026-09",
"contrato_ativo": true,
"franquia": 2200,
"franquia_usada": 1432,
"franquia_restante": 768,
"excedente_usado": 0,
"excedente_limite": 300,
"repeticoes_sem_custo": 211,
"renova_em": "01/10/2026"
}
Como a cobrança funciona
- Cada documento novo desconta 1 da franquia do mês. Acabada a franquia, conta como excedente até o limite do contrato.
- O mesmo documento consultado de novo pela sua empresa em até 30 dias não tem custo.
- Recuperar uma consulta já feita (
GET /consultas/{id}) não tem custo. - Documento inválido é recusado antes de qualquer cobrança.
Erros
| Código | Quando |
|---|---|
| 401 | Chave ausente, inválida ou revogada. |
| 402 | Franquia e excedente do mês esgotados. |
| 403 | Contrato inativo, sem acesso à API, ou IP não autorizado para a chave. |
| 404 | Documento não encontrado na base, ou consulta inexistente. |
| 422 | Documento inválido. |
| 429 | Limite de requisições por minuto (veja Retry-After). |
| 502 / 503 | Fonte de dados indisponível ou capacidade do mês esgotada. Tente mais tarde. |
O corpo de erro é sempre {"detail": "mensagem em português"}. Toda resposta traz X-Request-ID — informe-o ao suporte.
Limites
60 requisições por minuto por chave. Precisa de mais? Fale com o suporte.