Visão geral

A API idCerberus reúne serviços de onboarding digital, KYC, enriquecimento de dados, biometria, prevenção à fraude, análise de risco e compliance. A integração foi desenhada para permitir tanto fluxos completos de onboarding quanto consumo avulso de consultas por CPF ou CNPJ.

Modelos de integração

Modelo	Quando usar	Responsabilidade da sua aplicação
API	Quando o back-end da sua empresa vai consumir consultas diretamente	Autenticar, montar payloads, chamar endpoints e tratar responses
SDK	Quando a captura de dados e documentos acontece em aplicativo mobile	Gerar `tokenOnboarding`, entregar ao SDK e consultar resultado
Cliente Web	Quando o fluxo será feito via WebView, site responsivo ou QR Code	Direcionar o usuário ao fluxo e consumir o resultado processado

Se você está começando agora

Uma API é uma forma de um sistema conversar com outro. Na prática, você envia um request para uma URL e recebe um response com o resultado. Você pode testar os exemplos desta documentação de três formas:

Ferramenta	Para quem é indicada
Postman	Quem prefere preencher URL, headers e body em uma interface visual
PowerShell ou CMD	Quem está usando Windows e quer testar pelo terminal
Terminal do macOS ou Linux	Quem usa macOS, Linux ou ambiente de desenvolvimento Unix

O fluxo básico é sempre o mesmo:

Gerar token com client e secret.
Copiar o access_token retornado.
Enviar esse token no header Authorization.
Executar o endpoint ou serviço desejado.
Ler o objeto result e o status técnico em status.

Se você nunca executou uma chamada HTTP, comece pelo Quickstart.

Ambientes

A API possui ambientes separados para homologação e produção. Os endpoints são os mesmos nos dois ambientes; para trocar de ambiente, altere apenas a URL base. Método HTTP, headers e payload permanecem iguais. A escolha do ambiente é feita pela URL informada na chamada.

Ambiente	Base URL
Homologação	`https://backoffice-hml.idcerberus.com`
Produção	`https://backoffice.idcerberus.com`

Nos exemplos da documentação, {base_url} representa a URL do ambiente escolhido.

Variável	Valor
`base_url`	URL base de homologação ou produção
`gerar token`	`api/token-generate`
`service-external-url`	`api/service-api`
`report-url`	`api/onboarding/report`
`token-url`	`api/token-history-onboarding`

Endpoints principais

Operação	Endpoint
Gerar token de API	`POST /api/token-generate`
Consultar resultado de onboarding	`GET /api/onboarding/report/{tokenOnboarding}`
Baixar PDF do resultado	`GET /api/history-onboarding-report/{tokenOnboarding}`
Gerar `tokenOnboarding`	`POST /api/token-history-onboarding`
Executar serviço externo	`POST /api/service-api`
Consultar cliente	`GET /api/customer?documentKey={cpf-ou-cnpj}`
Alterar status de cliente	`POST /api/changeStatusOfCustomer`

Fluxo mínimo para testar

Gere um token em POST /api/token-generate.
Envie o token no header Authorization.
Escolha um serviço em Pessoa Física ou Pessoa Jurídica.
Chame POST /api/service-api com o campo service.
Leia status.code, status.message e os dados dentro de result.

Padrão dos serviços externos

Os serviços de pessoa física e pessoa jurídica são consumidos pelo mesmo endpoint técnico:

POST /api/service-api

O processamento executado é definido pelo campo service no body da requisição. Por exemplo:

{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}

Padrão de resposta

A maioria das consultas retorna:

{
  "result": {},
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Campo	Descrição
`result`	Dados de negócio retornados pela consulta
`status.code`	Código técnico do processamento
`status.message`	Mensagem técnica do processamento
`externalId`	Identificador externo da consulta, quando retornado

Próximos passos

Para autenticação, veja Autenticação.
Para onboarding via SDK, veja Onboarding via SDK.
Para catálogo de CPF, veja Serviços de Pessoa Física.
Para catálogo de CNPJ, veja Serviços de Pessoa Jurídica.
Para implementação endpoint a endpoint, use a API Reference.

Primeiros passos

Suporte e referência

Fluxos principais

POST /api/service-api

Pessoas

Empresas

Catálogo técnico

Visão geral

Visão geral

Modelos de integração

Se você está começando agora

Ambientes

Endpoints principais

Fluxo mínimo para testar

Padrão dos serviços externos

Padrão de resposta

Próximos passos

​Visão geral

​Modelos de integração

​Se você está começando agora

​Ambientes

​Endpoints principais

​Fluxo mínimo para testar

​Padrão dos serviços externos

​Padrão de resposta

​Próximos passos

Visão geral

Modelos de integração

Se você está começando agora

Ambientes

Endpoints principais

Fluxo mínimo para testar

Padrão dos serviços externos

Padrão de resposta

Próximos passos