@tekhnoai/fides
v0.1.1
Published
SDK oficial da Fides — dados cadastrais e compliance de CNPJs brasileiros (QSA, sanções CEIS/CNEP dos sócios, score)
Maintainers
Readme
@tekhnoai/fides
SDK JavaScript/TypeScript oficial da Fides — dados cadastrais e sinais de compliance de qualquer CNPJ brasileiro em uma chamada.
Zero dependências. Usa fetch nativo (Node 18+, Deno, Bun, browsers).
npm install @tekhnoai/fidesUso
import Fides from "@tekhnoai/fides";
const fides = new Fides("fds_sua_chave"); // pegue a sua em fides.api.br
// Ficha completa: cadastro, endereço, CNAEs, Simples/MEI, quadro societário
const ficha = await fides.cnpj("54977486000222");
console.log(ficha.razao_social);
// Sanções CEIS/CNEP da empresa E dos sócios
const sancoes = await fides.sancoes("54977486000222");
if (sancoes.alerta) console.log("⚠️ sanção vigente encontrada");
// Score de risco 0–100 com cada sinal explicado
const { score, risco, sinais } = await fides.score("54977486000222");
// Consumo do mês (não gasta franquia)
const uso = await fides.usage();
console.log(`${uso.usadas}/${uso.limite_mensal} consultas`);Métodos
| Método | Endpoint | Plano |
| -------------------------------- | ------------------------------- | ----- |
| fides.cnpj(cnpj) | ficha completa | todos |
| fides.sancoes(cnpj) | sanções da empresa e sócios | todos |
| fides.score(cnpj) | score de risco explicado | todos |
| fides.usage() | consumo do mês | todos |
| fides.batch(cnpjs) | até 1.000 CNPJs por chamada | pro+ |
| fides.buscaSocios(nome, limit) | busca reversa pessoa → empresas | scale |
Tratamento de erros
Erros da API viram FidesError com o status HTTP e helpers:
import Fides, { FidesError } from "@tekhnoai/fides";
try {
await fides.cnpj("00000000000000");
} catch (e) {
if (e instanceof FidesError) {
if (e.isNotFound) console.log("CNPJ não encontrado");
if (e.isRateLimited) console.log("limite do plano atingido");
console.log(e.status, e.apiMessage);
}
}Opções
new Fides("fds_...", {
baseUrl: "https://fides.api.br", // padrão
fetch: customFetch, // injeta seu próprio fetch (proxy, testes)
});Autenticação
Pegue sua chave gratuita (50 consultas/mês, só email) em fides.api.br — tem playground sem cadastro pra testar antes.
Links
- Documentação e playground: https://fides.api.br/docs
- Comparação honesta com alternativas: https://fides.api.br/comparativo
- SDK Go:
go get github.com/Tekhno-AI/fides/sdk/fides
Licença
MIT — uma API Tekhno.
