API idCerberus
Integre consultas de CPF, CNPJ, OCR, biometria, risco, compliance e onboarding digital em um fluxo único de API. Esta documentação foi organizada para dois momentos: testar rápido em homologação e implementar com segurança em produção.Testar em 5 minutos
Configure token, ambiente e primeira chamada no Postman sem escrever código.
Receitas de teste
Copie fluxos prontos para CPF, CNPJ, OCR, Face Index, risco PJ e score PF.
Executar um service
Entenda o contrato do
POST /api/service-api e copie payloads prontos.OCR e imagem
Veja como testar CNH, RG, cartão CNPJ, comprovante de endereço e documentos com base64.
Catálogo de services
Pesquise por alias, documento, categoria, campo ou objetivo de negócio.
Busca rápida
Encontre services por CPF, CNPJ, OCR, Face Index, erro, campo obrigatório ou alias.
Services por caso de uso
Escolha o service certo a partir do que você precisa validar ou consultar.
Erros comuns
Diagnóstico rápido para token, acesso, payload, imagem, retorno vazio e falha externa.
Caminho mais curto
1
Gere um token
Use
POST /api/token-generate com client e secret do produto.2
Escolha o service
Abra o índice de services ou a API Reference e copie o alias correto.
3
Monte o payload
Envie
service e os campos obrigatórios do produto, como cpf, cnpj, image1, image2, documentType ou key.4
Execute em HML
Chame
POST https://backoffice-hml.idcerberus.com/api/service-api com Authorization: Bearer {jwt_token}.5
Leia o resultado
Use
result como retorno de negócio e status.message, onboardingStatus e externalId para diagnóstico.Mais usados
Modelos de integração
Endpoints essenciais
Ambientes
Exemplo rápido
Gere um token:Padrão de resposta
A maior parte dos services retorna os dados úteis emresult e o status técnico em status.
O campo
service define qual produto será executado dentro de POST /api/service-api. Os demais campos mudam conforme a consulta escolhida.Próximos passos
- Para testar no Postman, veja Postman do zero.
- Para copiar fluxos completos, veja Receitas prontas.
- Para OCR, base64 e imagens, veja OCR via Service API.
- Para escolher o service certo, veja Services por caso de uso.
- Para diagnosticar falhas, veja Erros comuns de integração.