Como executar um service

Esta página explica o fluxo padrão para executar qualquer produto documentado no API Reference.

A maior parte das consultas usa o endpoint POST /api/service-api. O campo service define qual produto será executado.

Antes de executar a chamada, confirme qual service está liberado no produto do cliente. O campo service deve receber exatamente o valor público exibido no catálogo.

Na prática: copie o valor de Service no card ou no accordion do produto e envie esse valor no body da requisição. A documentação não expõe aliases internos de integração.

Passo a passo

Escolha o ambiente

Ambiente	Base URL	Quando usar
Homologação	`https://backoffice-hml.idcerberus.com`	Testes, validações e desenvolvimento.
Produção	`https://backoffice.idcerberus.com`	Uso real, depois da liberação do cliente.

Gere o token

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

Use o valor retornado em access_token no header Authorization das próximas chamadas.

Escolha o service

Use os catálogos de pessoa física e pessoa jurídica para copiar o valor exato do campo service.

Monte o body

O body sempre precisa ter service. Os outros campos dependem do produto escolhido.

{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf"
}

Execute a consulta

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

Interprete o retorno

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

result: dados retornados pelo produto.
status.code: código do processamento.
status.message: mensagem resumida do processamento.
externalId: identificador externo da consulta, quando retornado.

Erros comuns

Situação	Como corrigir
Token ausente, expirado ou inválido	Gere um novo token e envie `Authorization: Bearer {jwt_token}`.
Campo `service` escrito errado	Copie o service pelo catálogo do API Reference.
Produto usa alias curto	Confirme no produto qual alias está liberado e envie esse valor no campo `service`.
CPF, CNPJ, imagem ou parâmetro obrigatório ausente	Confira a seção de campos do service escolhido.
Serviço de documento, OCR ou biometria retornou erro de parâmetro	Envie imagem/base64, URL ou `key` real. Payloads curtos servem apenas para testar autenticação e liberação do produto.
Produto não liberado para o cliente	Confirme a liberação comercial/técnica antes de executar em produção.
Retorno sem dados no `result`	Confirme se o documento consultado possui informação disponível para aquele produto.

Catálogo de services

Endpoints da API

Como executar um service

Como executar um service

Passo a passo

Erros comuns

​Como executar um service

​Passo a passo

​Erros comuns

Como executar um service

Passo a passo

Erros comuns