Guias
O que vale para todas as APIs. Leia na ordem ou vá direto ao que precisa.
- 01ComeçarDa chave de teste à primeira resposta, sem custo e sem falar com ninguém.
- 02AutenticaçãoComo a chave vai na chamada, onde guardar e o que cada chave libera.
- 03Ambiente de testesToda chave tem gêmea de teste: mesmo formato de resposta, sem cobrança e sem consultar o órgão.
- 04Fazer uma consultaA rota, os tipos de campo, os formatos aceitos, o PDF da certidão e o tempo de resposta.
- 05Ler a respostaO envelope que toda consulta devolve, os códigos de resultado, o objeto detalhe e quando há cobrança.
- 06ErrosTodo erro segue a RFC 9457. O que cada um significa, o que fazer e quando repetir a chamada.
- 07LimitesRequisições por minuto, gasto por dia, tamanho do corpo e os limites das fontes.
- 08WebhooksEventos, entrega, novas tentativas e como validar a assinatura.
- 09Privacidade e LGPDO que fica guardado de cada consulta, por quanto tempo, e o que só existe na resposta.
- Identidade e assinaturaBiometria facial com o NexusID e assinatura eletrônica de documentos com o NexusSign.2 APIs
- CertidõesCertidões e negativas por CPF ou CNPJ: antecedentes criminais, débitos federais e estaduais, trabalhistas, ambientais e eleitorais.24 APIs
- Processos judiciaisAções na Justiça Federal, Estadual, do Trabalho e Militar, processos administrativos e protestos em cartório.7 APIs
- Dados da pessoaCadastro do CPF, local de votação e trajetória profissional e escolar.18 APIs
- Dados da empresaCadastro do CNPJ, inscrição estadual e municipal, Simples Nacional, comércio exterior e acordos sindicais.29 APIs
- Financeiro e riscoScore de crédito do Banco Central, indicadores de risco, probabilidade de negativação e sanções administrativas.10 APIs
- VeículosPlaca, multas, veículos da pessoa e registro de transportador.4 APIs
- Saúde e conselhosInscrição de médicos, certidões do CRM, certificados de suporte de vida e conselhos de classe.6 APIs
- Produtos e notasNotas fiscais, conhecimentos de transporte, ficha técnica, imagens e classificação NCM.5 APIs
- EndereçosEndereço, município e empresas pelo CEP.8 APIs
- Documentos por fotoLeitura e validação de documentos por imagem ou PDF.2 APIs
- Trabalhista (eSocial)O que a própria empresa enviou ao eSocial — encargos (FGTS, INSS, IRRF) e tabelas —, consultado em tempo real com o certificado A1 da empresa.10 APIs