Quickstart

Este guia mostra o caminho mais simples para fazer a primeira chamada na API idCerberus. Ele foi escrito para quem ainda não tem familiaridade com API, terminal ou curl. Você pode testar de três formas:

Forma	Quando usar
Postman	Melhor opção para quem prefere interface visual
Windows PowerShell ou CMD	Bom para testar direto no Windows
Terminal do macOS ou Linux	Bom para quem usa terminal Unix

Se você nunca executou um curl, comece pelo Postman. Depois que a chamada funcionar, copie o mesmo padrão para o terminal ou para o código da aplicação.

Antes de começar

Você precisa ter:

client e secret da sua aplicação;
acesso ao ambiente de homologação ou produção;
um CPF ou CNPJ de teste;
permissão para consumir o produto desejado.

Os endpoints base são:

Ambiente	`{base_url}`
Homologação	`https://backoffice-hml.idcerberus.com`
Produção	`https://backoffice.idcerberus.com`

A chamada é a mesma nos dois ambientes. Para usar produção, mantenha método, headers e body iguais e troque apenas a URL.

Não misture ambientes. Token gerado em homologação deve ser usado com URL de homologação. Token gerado em produção deve ser usado com URL de produção.

1. Escolha onde vai testar

Postman

Abra o Postman.
Clique em New.
Escolha HTTP Request.
Selecione o método POST.
Cole a URL do ambiente desejado.
Vá na aba Headers e adicione Content-Type com valor application/json.
Vá na aba Body.
Escolha raw.
Selecione JSON.
Cole o body do exemplo.
Clique em Send.

Windows PowerShell

Abra o menu iniciar.
Pesquise por PowerShell.
Abra o PowerShell.
Cole o comando curl.exe do exemplo.
Pressione Enter.

No Windows, prefira curl.exe. O comando curl sozinho pode ser interpretado como outro comando interno do PowerShell.

Windows CMD

Abra o menu iniciar.
Pesquise por cmd.
Abra o Prompt de Comando.
Cole o comando em uma única linha ou use ^ para quebrar linhas.
Pressione Enter.

macOS ou Linux

Abra o Terminal.
Cole o comando curl do exemplo.
Pressione Enter.

Em macOS e Linux, o curl normalmente já vem instalado. Se o terminal informar que o comando não existe, instale o pacote curl pelo gerenciador do sistema.

2. Gere um token

O primeiro request gera um token JWT. Esse token será usado nas próximas chamadas protegidas. No Postman, configure assim:

Campo	Valor
Método	`POST`
URL HML	`https://backoffice-hml.idcerberus.com/api/token-generate`
URL produção	`https://backoffice.idcerberus.com/api/token-generate`
Header	`Content-Type: application/json`
Body	`raw` + `JSON`

Body:

{
  "client": "{client}",
  "secret": "{secret}"
}

HML

curl --location 'https://backoffice-hml.idcerberus.com/api/token-generate' \
  --header 'Content-Type: application/json' \
  --data '{
    "client": "{client}",
    "secret": "{secret}"
  }'

Produção

curl --location 'https://backoffice.idcerberus.com/api/token-generate' \
  --header 'Content-Type: application/json' \
  --data '{
    "client": "{client}",
    "secret": "{secret}"
  }'

Windows CMD

curl.exe --location "https://backoffice-hml.idcerberus.com/api/token-generate" ^
  --header "Content-Type: application/json" ^
  --data "{\"client\":\"{client}\",\"secret\":\"{secret}\"}"

Resposta esperada:

{
  "access_token": "{jwt_token}",
  "expires_in": "300"
}

Copie o valor de access_token. Ele será usado no próximo passo. No Postman, copie somente o conteúdo entre aspas. Exemplo:

{
  "access_token": "eyJhbGciOi...",
  "expires_in": "300"
}

Nesse caso, o token a ser usado no próximo passo é eyJhbGciOi....

3. Execute um serviço

Use o token retornado no header Authorization. No Postman, crie uma nova request:

Campo	Valor
Método	`POST`
URL HML	`https://backoffice-hml.idcerberus.com/api/service-api`
URL produção	`https://backoffice.idcerberus.com/api/service-api`
Header 1	`Authorization: Bearer {jwt_token}`
Header 2	`Content-Type: application/json`
Body	`raw` + `JSON`

HML

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'

Produção

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'

Windows CMD

curl.exe --location "https://backoffice-hml.idcerberus.com/api/service-api" ^
  --header "Authorization: Bearer {jwt_token}" ^
  --header "Content-Type: application/json" ^
  --data "{\"service\":\"SERVICE_PERSON_DATA_ENRICHMENT\",\"cpf\":\"cpf\"}"

Vai testar OCR? Use o guia OCR via Service API para montar o payload com image1, image2, documentType, base64 e exemplos de retorno. OCR precisa de imagem real; payload curto só valida autenticação e acesso.

Substitua:

Valor	O que colocar
`{jwt_token}`	Token retornado no passo anterior
`cpf`	CPF usado para teste
`SERVICE_PERSON_DATA_ENRICHMENT`	Código do serviço que deseja executar

Consulta CPF

Use quando quiser validar o fluxo com um service simples de pessoa física.

Consulta CNPJ

Use quando quiser validar o fluxo com um service simples de pessoa jurídica.

OCR com imagem

Use quando o body precisar de base64, imagem, URL ou documentType.

Catálogo de services

Use para navegar pelos grupos de produtos do POST /api/service-api.

4. Leia o resultado

A maior parte dos serviços retorna os dados em result e o status técnico em status.

{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "name": "NOME DA PESSOA"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Campo	Como interpretar
`result`	Dados retornados pelo serviço
`status.code`	Código técnico do processamento
`status.message`	Mensagem técnica da consulta
`externalId`	Identificador da consulta, quando retornado

5. Trate sucesso e falha

Use status.code para decidir o comportamento da sua aplicação.

Situação	Como tratar
`status.code` 200	Processamento concluído. Leia o objeto `result`.
`status.code` 400	Payload, parâmetro, permissão ou fonte externa pode ter falhado. Leia `status.message`.
Token expirado	Gere um novo token e repita a chamada.
Sem body JSON	Trate conforme o endpoint. O relatório de onboarding retorna PDF.

6. Próximo passo

Se você já sabe qual produto consumir, vá para a API Reference. Se ainda está desenhando o fluxo, use Escolha o serviço certo.

Primeiros passos

Suporte e referência

Fluxos principais

POST /api/service-api

Pessoas

Empresas

Catálogo técnico

Quickstart

Quickstart

Antes de começar

1. Escolha onde vai testar

Postman

Windows PowerShell

Windows CMD

macOS ou Linux

2. Gere um token

HML

Produção

Windows CMD

3. Execute um serviço

HML

Produção

Windows CMD

Consulta CPF

Consulta CNPJ

OCR com imagem

Catálogo de services

4. Leia o resultado

5. Trate sucesso e falha

6. Próximo passo

​Quickstart

​Antes de começar

​1. Escolha onde vai testar

​Postman

​Windows PowerShell

​Windows CMD

​macOS ou Linux

​2. Gere um token

​HML

​Produção

​Windows CMD

​3. Execute um serviço

​HML

​Produção

​Windows CMD

Consulta CPF

Consulta CNPJ

OCR com imagem

Catálogo de services

​4. Leia o resultado

​5. Trate sucesso e falha

​6. Próximo passo

Quickstart

Antes de começar

1. Escolha onde vai testar

Postman

Windows PowerShell

Windows CMD

macOS ou Linux

2. Gere um token

HML

Produção

Windows CMD

3. Execute um serviço

HML

Produção

Windows CMD

4. Leia o resultado

5. Trate sucesso e falha

6. Próximo passo