Services de pessoa jurídica

Catálogo explícito dos services de pessoa jurídica disponíveis via API, com campos esperados e exemplos de request. Todos os services usam POST /api/service-api; o produto executado é definido pelo campo service no body.

Use exatamente o valor exibido em Service. Não envie alias interno nem nome de integração.

Antes de testar

Contrato base

Veja token, headers, body padrão, result, status e externalId.

Postman do zero

Configure HML, gere token e execute POST /api/service-api com um payload real.

OCR de cartão CNPJ

Payload, imagem esperada, retorno limpo e diagnóstico de erro para cartão CNPJ.

Fluxos prontos

Exemplos completos para CNPJ, risco, cadastro e OCR.

Como usar esta página

Escolha a família

Use os cards abaixo para localizar o grupo certo de services.

Abra o service

No catálogo completo, abra o accordion do service e copie o body de exemplo.

Leia o retorno

Use result como contrato público e preserve status, onboardingStatus e externalId.

Como interpretar qualquer retorno

Dados úteis

Leia primeiro o objeto result. Ele concentra os campos de negócio que o cliente deve consumir.

Status técnico

Use status.code e status.message para entender se a chamada processou, recusou ou falhou.

Rastreio

Guarde externalId em testes, suporte e auditoria. Ele é o identificador mais prático da consulta.

Contrato limpo

Não dependa de metadados internos. A integração deve mapear somente os campos públicos documentados.

Famílias de services

Biometria e documentos

1 service: SERVICE_OCR_CNPJ_CARD.

Contatos, sites e relacionamentos

13 services: SERVICE_OWNERS_LAWSUITS_DISTRIBUTION, SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ, SERVICE_DOMAINS_CNPJ e mais 10.

Dados cadastrais e Receita Federal

7 services: SERVICE_PGMEI, SERVICE_RFB_PJ_ON_DEMAND, SERVICE_REGISTRATION_DATA_CNPJ e mais 4.

Dados eleitorais e PEP

4 services: SERVICE_ELECTORAL_DONORS_CNPJ, SERVICE_ELECTORAL_PROVIDERS_CNPJ, SERVICE_ECONOMIC_GROUP_KYC_COMPANY e mais 1.

Jurídico, certidões e protestos

4 services: SERVICE_LABOR_LAWSUITS, SERVICE_PROTEST_PJ, SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY e mais 1.

KYC, compliance e exposição

2 services: SERVICE_COMPLIANCE_BET_PJ, SERVICE_COMPLIANCE_BET.

Outros services

19 services: SERVICE_SYNDICATE_AGREEMENTS, SERVICE_ONLINE_ADS, SERVICE_REPUTATIONS_AND_REVIEWS e mais 16.

Risco, crédito e dívidas

8 services: SERVICE_STATE_DEBT_CERTIFICATE_COMPANY, SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY, SERVICE_ACTIVE_DEBT_PJ e mais 5.

Catálogo completo

Abra um service para ver quando usar, campos obrigatórios, body, curl e response resumido.

OCR de cartão CNPJ

Service: SERVICE_OCR_CNPJ_CARDQuando usar: Use para extrair dados de documentos enviados em base64 ou por URL.O que retorna: Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível.

Entrada

Campos obrigatórios: service, image1.

Resultado

Principais campos em result: cnpj, docType, genericOcr.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, image1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Guia de OCR

Para payloads prontos, qualidade de imagem e diagnóstico de erro, consulte OCR via Service API.

Payload mínimo

{
  "service": "SERVICE_OCR_CNPJ_CARD",
  "image1": "BASE64_DO_CARTAO_CNPJ"
}

Retorno limpo esperado

{
  "result": {
    "cnpj": "cnpj",
    "docType": "CNPJ_CARD",
    "genericOcr": "texto extraído do cartão CNPJ"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Erro comum

{
  "result": {},
  "status": {
    "code": 400,
    "message": "CNPJ não encontrado no cartão CNPJ"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OCR_CNPJ_CARD",
  "image1": "base64"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.docType`	Tipo de documento identificado no processamento.
`result.genericOcr`	Texto bruto extraído do documento por OCR.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "docType": "CNPJ_CARD",
    "genericOcr": "texto extraído do cartão CNPJ"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível.

Distribuição de Processos dos Sócios

Service: SERVICE_OWNERS_LAWSUITS_DISTRIBUTIONQuando usar: Use para consultar certidões, processos ou informações jurídicas da empresa.O que retorna: Retorna dados agregados sobre a distribuição de processos judiciais nos quais os sócios da empresa consultada estão envolvidos, com estatísticas por período e papel na ação.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, companyOwnersLawsuitsTotalOwners, companyOwnersLawsuitsMaxPerOwner, companyOwnersLawsuitsAvgPerOwner, companyOwnersLawsuitsMinPerOwner, companyOwnersLawsuitsAsAuthor e mais 13.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.companyOwnersLawsuitsTotalOwners`	Quantidade de sócios que a empresa possui.
`result.companyOwnersLawsuitsMaxPerOwner`	Quantidade máxima de processos que um dos sócios possui.
`result.companyOwnersLawsuitsAvgPerOwner`	Média de processos por sócio.
`result.companyOwnersLawsuitsMinPerOwner`	Quantidade mínima de processos que um dos sócios possui.
`result.companyOwnersLawsuitsAsAuthor`	Quantidade de processos em que os sócios figuram como autores.
`result.companyOwnersLawsuitsAsDefendant`	Quantidade de processos em que os sócios figuram como réus.
`result.companyOwnersLawsuitsAsOther`	Quantidade de processos em que os sócios participam em outra categoria.
`result.companyOwnersLawsuitsTotal`	Total de processos judiciais envolvendo os sócios da empresa.
`result.companyOwnersLawsuitsRelatedToLawyers`	Indica se algum sócio possui relação com advogados nos processos encontrados.
`result.companyOwnersLawsuitsRelatedToJudges`	Indica se algum sócio possui relação com juízes nos processos encontrados.
`result.companyOwnersLawsuitsFirstDate`	Data do processo mais antigo encontrado para os sócios.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "companyOwnersLawsuitsTotalOwners": 2,
    "companyOwnersLawsuitsMaxPerOwner": 3,
    "companyOwnersLawsuitsAvgPerOwner": 1.5,
    "companyOwnersLawsuitsMinPerOwner": 0,
    "companyOwnersLawsuitsAsAuthor": 1,
    "companyOwnersLawsuitsAsDefendant": 2,
    "companyOwnersLawsuitsAsOther": 0,
    "companyOwnersLawsuitsTotal": 3,
    "companyOwnersLawsuitsRelatedToLawyers": false,
    "companyOwnersLawsuitsRelatedToJudges": false,
    "companyOwnersLawsuitsFirstDate": "2015-01-01",
    "companyOwnersLawsuitsLastDate": "2026-01-01",
    "companyOwnersLawsuitsLast30Days": 0,
    "companyOwnersLawsuitsLast90Days": 0,
    "companyOwnersLawsuitsLast180Days": 0,
    "companyOwnersLawsuitsLast365Days": 1,
    "companyOwnersLawsuitsSummary": "Sócios com 3 processos judiciais encontrados",
    "companyOwnersLawsuitsDistribution": {}
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados agregados sobre a distribuição de processos judiciais nos quais os sócios da empresa consultada estão envolvidos, com estatísticas por período e papel na ação.

Doações eleitorais dos sócios

Service: SERVICE_OWNERS_ELECTORAL_DONORS_CNPJQuando usar: Use para consultar informações eleitorais relacionadas à empresa.O que retorna: Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, ownersDonations.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.ownersDonations`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "ownersDonations": [
      {
        "ownerName": "Nome do sócio",
        "year": 2024,
        "recipient": "Candidato",
        "amount": "300.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais.

Domínios CNPJ

Service: SERVICE_DOMAINS_CNPJQuando usar: Use para consultar dados de sites vinculados à empresa.O que retorna: Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalDomains, domains.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DOMAINS_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalDomains`	Campo retornado no objeto result para consumo do cliente.
`result.domains`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "empresa.com.br",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis.

Endereços estendidos

Service: SERVICE_ADDRESSES_EXTENDED_CNPJQuando usar: Use para consultar ou validar endereços associados ao documento.O que retorna: Retorna a lista completa de endereços do CNPJ em result.addresses (logradouro, número, complemento, bairro, cidade, UF, país, CEP, tipo, se está ativo e se é o principal), além de um resumo agregado em result.addressesExtendedTotal* com totais e datas da primeira/última passagem confirmada.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, addresses, addressesExtendedTotal, addressesExtendedTotalActive, addressesExtendedTotalWork, addressesExtendedTotalPersonal e mais 5.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ADDRESSES_EXTENDED_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.addresses`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.
`result.addressesExtendedTotal`	Quantidade total de endereços encontrados para a empresa.
`result.addressesExtendedTotalActive`	Quantidade de endereços atualmente marcados como ativos.
`result.addressesExtendedTotalWork`	Quantidade de endereços do tipo comercial.
`result.addressesExtendedTotalPersonal`	Quantidade de endereços do tipo residencial.
`result.addressesExtendedTotalUnique`	Quantidade de endereços únicos, sem duplicidade.
`result.addressesExtendedTotalPassages`	Quantidade total de passagens (confirmações) registradas entre os endereços encontrados.
`result.addressesExtendedTotalBadPassages`	Quantidade de passagens sinalizadas como inconsistentes entre os endereços encontrados.
`result.addressesExtendedOldestPassageDate`	Data da passagem mais antiga registrada entre os endereços encontrados.
`result.addressesExtendedNewestPassageDate`	Data da passagem mais recente registrada entre os endereços encontrados.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "addresses": [
      {
        "address": "Av Exemplo",
        "number": "1000",
        "complement": "Sala 10",
        "neighborhood": "Centro",
        "city": "Sao Paulo",
        "state": "SP",
        "country": "Brasil",
        "zipcode": "01001000",
        "addressType": "COMMERCIAL",
        "isActive": "true",
        "isMainForEntity": "true",
        "priority": "1",
        "lastValidationDate": "2026-05-12"
      }
    ],
    "addressesExtendedTotal": 1,
    "addressesExtendedTotalActive": 1,
    "addressesExtendedTotalWork": 1,
    "addressesExtendedTotalPersonal": 0,
    "addressesExtendedTotalUnique": 1,
    "addressesExtendedTotalPassages": 7,
    "addressesExtendedTotalBadPassages": 0,
    "addressesExtendedOldestPassageDate": "2018-02-10",
    "addressesExtendedNewestPassageDate": "2026-05-12"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a lista completa de endereços do CNPJ em result.addresses (logradouro, número, complemento, bairro, cidade, UF, país, CEP, tipo, se está ativo e se é o principal), além de um resumo agregado em result.addressesExtendedTotal* com totais e datas da primeira/última passagem confirmada.

Exposição e perfil na mídia dos sócios

Service: SERVICE_MEDIA_PROFILE_EXPOSURE_PJQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à empresa.O que retorna: Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, mediaMentions, exposureLevel.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.mediaMentions`	Notícias, exposição em mídia ou indicadores públicos associados ao documento.
`result.exposureLevel`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "mediaMentions": [
      {
        "title": "Noticia encontrada",
        "source": "Fonte",
        "sentiment": "NEUTRAL"
      }
    ],
    "exposureLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

KYC e compliance dos sócios

Service: SERVICE_COMPANY_KYC_OWNERSQuando usar: Use para executar checagens de KYC e compliance da empresa.O que retorna: Retorna um resumo agregado de KYC/compliance da empresa (totalCurrentPep, totalCurrentSanctioned, averageSanctionsPerOwner, pepPercentage) e o detalhamento individual de cada sócio em result.kycOwners/companyOwners/peopleOwners, incluindo sanctionsHistory (histórico completo), highConfidenceSanctionsHistory (apenas sanções com matchRate acima de 90) e pepHistories.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalCurrentPep, totalHistoricallyPEP, totalCurrentSanctioned, totalHistoricallySanctioned, averageSanctionsPerOwner e mais 7.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPANY_KYC_OWNERS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalCurrentPep`	Quantidade de sócios atualmente classificados como Pessoa Politicamente Exposta.
`result.totalHistoricallyPEP`	Quantidade de sócios que já foram Pessoa Politicamente Exposta em algum momento, mesmo que não sejam atualmente.
`result.totalCurrentSanctioned`	Quantidade de sócios com sanção atualmente ativa.
`result.totalHistoricallySanctioned`	Quantidade de sócios que já possuíram alguma sanção, mesmo que não estejam sancionados atualmente.
`result.averageSanctionsPerOwner`	Média de sanções por sócio, arredondada para o número inteiro mais próximo.
`result.averageSanctionsPerOwnerExact`	Média exata de sanções por sócio, sem arredondamento.
`result.pepPercentage`	Percentual de sócios classificados como Pessoa Politicamente Exposta.
`result.ownerMaxSanctions`	Maior quantidade de sanções encontrada entre os sócios.
`result.ownerMinSanctions`	Menor quantidade de sanções encontrada entre os sócios.
`result.activeOwners`	Lista de CPFs ou CNPJs dos sócios atualmente ativos no quadro societário.
`result.inactiveOwners`	Lista de CPFs ou CNPJs dos sócios que não fazem mais parte do quadro societário.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalCurrentPep": 1,
    "totalHistoricallyPEP": 1,
    "totalCurrentSanctioned": 1,
    "totalHistoricallySanctioned": 1,
    "averageSanctionsPerOwner": 1,
    "averageSanctionsPerOwnerExact": 0.5,
    "pepPercentage": 50,
    "ownerMaxSanctions": 1,
    "ownerMinSanctions": 0,
    "activeOwners": [
      "11122233344",
      "55566677788"
    ],
    "inactiveOwners": [],
    "kycOwners": [
      {
        "cpf": "11122233344",
        "isPep": true,
        "isCurrentlySanctioned": true,
        "wasPreviouslySanctioned": true,
        "firstSanctionDate": "2021-03-15",
        "lastSanctionDate": "2024-08-02",
        "firstPepOccurrenceDate": "2019-01-10",
        "lastPepOccurrenceDate": "2024-08-02",
        "sanctionsHistory": [
          {
            "source": "interpol",
            "type": "RED_NOTICE",
            "standardizedSanctionType": "INTERNATIONAL_ALERT",
            "matchRate": 96,
            "details": {
              "Charge": "Fraud",
              "IssuingCountry": "Brazil"
            },
            "normalizedDetails": {
              "acusacao": "Fraude",
              "paisEmissor": "Brasil"
            },
            "startDate": "2021-03-15",
            "endDate": null,
            "isCurrentlyPresentOnSource": true
          }
        ],
        "highConfidenceSanctionsHistory": [
          {
            "source": "interpol",
            "type": "RED_NOTICE",
            "standardizedSanctionType": "INTERNATIONAL_ALERT",
            "matchRate": 96,
            "details": {
              "Charge": "Fraud",
              "IssuingCountry": "Brazil"
            },
            "normalizedDetails": {
              "acusacao": "Fraude",
              "paisEmissor": "Brasil"
            },
            "startDate": "2021-03-15",
            "endDate": null,
            "isCurrentlyPresentOnSource": true
          }
        ],
        "pepHistories": [
          {
            "level": "FEDERAL",
            "jobTitle": "Secretario",
            "department": "Ministerio Exemplo",
            "startDate": "2019-01-10",
            "endDate": null
          }
        ],
        "isCurrentlyElectoralDonor": false,
        "isHistoricalElectoralDonor": true,
        "totalElectoralDonations": 2,
        "totalElectoralDonationAmount": 15000
      },
      {
        "cpf": "55566677788",
        "isPep": false,
        "isCurrentlySanctioned": false,
        "wasPreviouslySanctioned": false,
        "sanctionsHistory": [],
        "highConfidenceSanctionsHistory": [],
        "pepHistories": []
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna um resumo agregado de KYC/compliance da empresa (totalCurrentPep, totalCurrentSanctioned, averageSanctionsPerOwner, pepPercentage) e o detalhamento individual de cada sócio em result.kycOwners/companyOwners/peopleOwners, incluindo sanctionsHistory (histórico completo), highConfidenceSanctionsHistory (apenas sanções com matchRate acima de 90) e pepHistories.

Processos jurídicos dos sócios

Service: SERVICE_JURIDICAL_PROCESSES_PJ_OWNERSQuando usar: Use para consultar certidões, processos ou informações jurídicas da empresa.O que retorna: Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, ownersProcesses.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.ownersProcesses`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "ownersProcesses": [
      {
        "ownerName": "Nome do sócio",
        "totalProcesses": 1,
        "processes": []
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas.

Receita Federal - QSA

Service: SERVICE_RF_QSAQuando usar: Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.O que retorna: Retorna o quadro societário-administrativo (QSA) do CNPJ informado, com dados cadastrais da matriz (porte, capital, CNAE, natureza jurídica, situação cadastral) e a lista de sócios e administradores.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, qsaCompanyType, qsaCompanySize, qsaCapital, qsaCapitalValue, qsaCnae e mais 10.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RF_QSA",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.qsaCompanyType`	Indica se o CNPJ consultado é MATRIZ ou FILIAL.
`result.qsaCompanySize`	Porte da empresa conforme classificação da Receita Federal.
`result.qsaCapital`	Valor do capital social da empresa.
`result.qsaCapitalValue`	Valor numérico do capital social da empresa, extraído do campo Capital Social para uso em regras e comparações.
`result.qsaCnae`	Código da atividade econômica principal.
`result.qsaMainEconomicActivity`	Descrição da atividade econômica principal.
`result.qsaSecondaryActivity`	Descrição das atividades econômicas secundárias.
`result.qsaLegalNatureCode`	Código da natureza jurídica da empresa.
`result.qsaLegalNature`	Descrição da natureza jurídica da empresa.
`result.qsaIrsStatus`	Situação cadastral da empresa na Receita Federal.
`result.qsaIsActive`	Indica se a situação cadastral do CNPJ é ATIVA, derivado do campo Situação Cadastral.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "qsaCompanyType": "MATRIZ",
    "qsaCompanySize": "DEMAIS",
    "qsaCapital": "DEZ MIL REAIS",
    "qsaCapitalValue": "10000.00",
    "qsaCnae": "62.09-1-00",
    "qsaMainEconomicActivity": "SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO",
    "qsaSecondaryActivity": "DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA",
    "qsaLegalNatureCode": "2062",
    "qsaLegalNature": "SOCIEDADE EMPRESARIA LIMITADA",
    "qsaIrsStatus": "ATIVA",
    "qsaIsActive": "true",
    "qsaStatusDate": "2018-04-04",
    "qsaPartnersCount": 1,
    "qsaSummary": "Empresa ativa com 1 sócio encontrado no QSA",
    "qsaPartners": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o quadro societário-administrativo (QSA) do CNPJ informado, com dados cadastrais da matriz (porte, capital, CNAE, natureza jurídica, situação cadastral) e a lista de sócios e administradores.

Relacionamentos da empresa

Service: SERVICE_COMPANY_RELATIONSHIPQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à empresa.O que retorna: Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, owners, relatedCompanies.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPANY_RELATIONSHIP",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.owners`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.
`result.relatedCompanies`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "owners": [
      {
        "name": "Nome do sócio",
        "document": "cpf",
        "share": "50%"
      }
    ],
    "relatedCompanies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados.

Relacionamentos do Grupo Econômico

Service: SERVICE_ECONOMIC_GROUP_RELATIONSHIPSQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à empresa.O que retorna: Retorna as entidades (pessoas e empresas) que integram o mesmo grupo econômico do CNPJ consultado, com relacionamentos atuais, históricos e estatísticas agregadas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalEconomicGroupRelationships, economicGroupRelationshipsSummary, economicGroupRelationships, economicGroupCurrentRelationships, economicGroupHistoricalRelationships e mais 1.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalEconomicGroupRelationships`	Quantidade de relacionamentos do grupo econômico encontrados.
`result.economicGroupRelationshipsSummary`	Resumo da consulta de relacionamentos do grupo econômico.
`result.economicGroupRelationships`	Lista estruturada de relacionamentos do grupo econômico usada para renderização em tabela.
`result.economicGroupCurrentRelationships`	Lista estruturada dos relacionamentos atualmente vigentes do grupo econômico.
`result.economicGroupHistoricalRelationships`	Lista estruturada dos relacionamentos históricos (encerrados) do grupo econômico.
`result.economicGroupRelationshipsStats`	Estatísticas consolidadas dos relacionamentos do grupo econômico.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalEconomicGroupRelationships": 3,
    "economicGroupRelationshipsSummary": "Empresa possui 3 relacionamentos de grupo econômico",
    "economicGroupRelationships": [],
    "economicGroupCurrentRelationships": [],
    "economicGroupHistoricalRelationships": [],
    "economicGroupRelationshipsStats": {}
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna as entidades (pessoas e empresas) que integram o mesmo grupo econômico do CNPJ consultado, com relacionamentos atuais, históricos e estatísticas agregadas.

Sócios de primeiro nível

Service: SERVICE_FIRST_LEVEL_PARTNERQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à empresa.O que retorna: Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, partners.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FIRST_LEVEL_PARTNER",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.partners`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "partners": [
      {
        "name": "Nome do sócio",
        "document": "cpf",
        "level": 1,
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ.

Sócios na Receita Federal

Service: SERVICE_COMPANY_RFB_OWNERSQuando usar: Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.O que retorna: Retorna o quadro societario na Receita Federal, com nome dos sócios, documentos mascarados, qualificação, participação e data de entrada quando disponível.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, owners.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPANY_RFB_OWNERS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.owners`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "owners": [
      {
        "name": "Nome do sócio",
        "qualification": "SOCIO-ADMINISTRADOR",
        "entryDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o quadro societario na Receita Federal, com nome dos sócios, documentos mascarados, qualificação, participação e data de entrada quando disponível.

Telefones

Service: SERVICE_PHONES_EXTENDED_COMPANYQuando usar: Use para consultar, validar ou enriquecer dados de telefone.O que retorna: Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, phonesExtendedCompanyTotal, phonesExtendedCompanyTotalActive, phonesExtendedCompanySummary, phonesExtendedCompanyStats, phonesExtendedCompany.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PHONES_EXTENDED_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.phonesExtendedCompanyTotal`	Quantidade total de telefones encontrados para a empresa.
`result.phonesExtendedCompanyTotalActive`	Quantidade de telefones ativos encontrados para a empresa.
`result.phonesExtendedCompanySummary`	Resumo da consulta de Telefones.
`result.phonesExtendedCompanyStats`	Estatísticas consolidadas dos telefones encontrados.
`result.phonesExtendedCompany`	Lista estruturada dos telefones encontrados, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "phonesExtendedCompanyTotal": 2,
    "phonesExtendedCompanyTotalActive": 1,
    "phonesExtendedCompanySummary": "Empresa com 2 telefones encontrados, 1 ativo",
    "phonesExtendedCompanyStats": [],
    "phonesExtendedCompany": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem.

Arrecadação Simples Nacional - MEI

Service: SERVICE_PGMEIQuando usar: Use este service quando precisar executar a consulta “Arrecadação Simples Nacional - MEI” via API.O que retorna: Retorna o Documento de Arrecadação do Simples Nacional (DAS) para Microempreendedores Individuais (MEI), com situação, ano de referência, guias pendentes e histórico mensal de arrecadação.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, pgmeiStatus, pgmeiReferenceYear, pgmeiPendingGuides, pgmeiSummary, pgmeiGuides.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PGMEI",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.pgmeiStatus`	Situação do MEI perante o Simples Nacional no ano de referência mais recente.
`result.pgmeiReferenceYear`	Ano de referência mais recente encontrado na consulta de arrecadação MEI.
`result.pgmeiPendingGuides`	Quantidade de guias de arrecadação do MEI ainda não quitadas.
`result.pgmeiSummary`	Resumo da consulta de Arrecadação Simples Nacional - MEI.
`result.pgmeiGuides`	Lista estruturada das guias mensais de arrecadação do MEI usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "pgmeiStatus": "Optante",
    "pgmeiReferenceYear": "2026",
    "pgmeiPendingGuides": 0,
    "pgmeiSummary": "MEI optante e regular no ano de referência",
    "pgmeiGuides": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o Documento de Arrecadação do Simples Nacional (DAS) para Microempreendedores Individuais (MEI), com situação, ano de referência, guias pendentes e histórico mensal de arrecadação.

CNPJ na Receita Federal on-demand

Service: SERVICE_RFB_PJ_ON_DEMANDQuando usar: Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.O que retorna: Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, officialName, status, openingDate, mainActivity.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RFB_PJ_ON_DEMAND",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.officialName`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.openingDate`	Data retornada pela consulta, conforme o contexto do service.
`result.mainActivity`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço.

Dados cadastrais de CNPJ

Service: SERVICE_REGISTRATION_DATA_CNPJQuando usar: Use este service quando precisar executar a consulta “Dados cadastrais de CNPJ” via API.O que retorna: Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, officialName, tradeName, status, openingDate.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.officialName`	Campo retornado no objeto result para consumo do cliente.
`result.tradeName`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.openingDate`	Data retornada pela consulta, conforme o contexto do service.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "tradeName": "EMPRESA EXEMPLO",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis.

DAS MEI na Receita

Service: SERVICE_DAS_MEIQuando usar: Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.O que retorna: Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, meiStatus, periods.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DAS_MEI",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.meiStatus`	Campo retornado no objeto result para consumo do cliente.
`result.periods`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "meiStatus": "ACTIVE",
    "periods": [
      {
        "period": "2026-01",
        "paid": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis.

Enriquecimento de dados

Service: SERVICE_CORPORATE_DATA_ENRICHMENTQuando usar: Use para complementar dados cadastrais da empresa a partir do documento informado.O que retorna: Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, officialName, tradeName, status, mainActivity.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CORPORATE_DATA_ENRICHMENT",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.officialName`	Campo retornado no objeto result para consumo do cliente.
`result.tradeName`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.mainActivity`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "tradeName": "EMPRESA EXEMPLO",
    "status": "ATIVA",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço.

SINTEGRA

Service: SERVICE_SINTEGRA_CONSULTATIONQuando usar: Use este service quando precisar executar a consulta “SINTEGRA” via API.O que retorna: Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, stateRegistration, state, status, regime.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

uf

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: uf

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_SINTEGRA_CONSULTATION",
  "cnpj": "cnpj",
  "uf": "uf (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SINTEGRA_CONSULTATION",
  "cnpj": "cnpj",
  "uf": "uf (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SINTEGRA_CONSULTATION",
  "cnpj": "cnpj",
  "uf": "uf (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.
`uf`	Não	UF usada para limitar a consulta estadual ou jurídica.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.stateRegistration`	Campo retornado no objeto result para consumo do cliente.
`result.state`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.regime`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "stateRegistration": "000000000",
    "state": "SP",
    "status": "HABILITADO",
    "regime": "NORMAL"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta.

Status do CNPJ na Receita Federal

Service: SERVICE_RFB_PJQuando usar: Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.O que retorna: Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, officialName, status, openingDate, mainActivity.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RFB_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.officialName`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.openingDate`	Data retornada pela consulta, conforme o contexto do service.
`result.mainActivity`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço.

Doações eleitorais

Service: SERVICE_ELECTORAL_DONORS_CNPJQuando usar: Use para consultar informações eleitorais relacionadas à empresa.O que retorna: Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, donations.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ELECTORAL_DONORS_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.donations`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "1000.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Fornecedores eleitorais

Service: SERVICE_ELECTORAL_PROVIDERS_CNPJQuando usar: Use para consultar informações eleitorais relacionadas à empresa.O que retorna: Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, campos.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CNPJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.campos`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "2500.00",
        "serviceType": "Servico"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço.

KYC e Compliance do Grupo Econômico

Service: SERVICE_ECONOMIC_GROUP_KYC_COMPANYQuando usar: Use para executar checagens de KYC e compliance da empresa.O que retorna: Retorna indicadores agregados de KYC e compliance regulatório do grupo econômico completo do CNPJ informado, incluindo exposição política (PEP) e sanções.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, economicGroupKycSummary, economicGroupTotalCurrentPep, economicGroupTotalHistoricalPep, economicGroupTotalCurrentSanctioned, economicGroupTotalHistoricalSanctioned e mais 1.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.economicGroupKycSummary`	Resumo da consulta de KYC e Compliance do Grupo Econômico.
`result.economicGroupTotalCurrentPep`	Quantidade de entidades do grupo econômico atualmente classificadas como Pessoa Politicamente Exposta.
`result.economicGroupTotalHistoricalPep`	Quantidade de entidades do grupo econômico com histórico de exposição política.
`result.economicGroupTotalCurrentSanctioned`	Quantidade de entidades do grupo econômico atualmente sancionadas em listas restritivas.
`result.economicGroupTotalHistoricalSanctioned`	Quantidade de entidades do grupo econômico com histórico de sanções em listas restritivas.
`result.economicGroupAverageSanctions`	Média de sanções encontradas por empresa do grupo econômico consultado.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "economicGroupKycSummary": "Consulta realizada",
    "economicGroupTotalCurrentPep": "0",
    "economicGroupTotalHistoricalPep": "1",
    "economicGroupTotalCurrentSanctioned": "0",
    "economicGroupTotalHistoricalSanctioned": "0",
    "economicGroupAverageSanctions": "0"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicadores agregados de KYC e compliance regulatório do grupo econômico completo do CNPJ informado, incluindo exposição política (PEP) e sanções.

KYC e Compliance dos Funcionários

Service: SERVICE_EMPLOYEES_KYCQuando usar: Use para executar checagens de KYC e compliance da empresa.O que retorna: Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, employeesKycTotalEmployees, employeesKycCurrentlyPepCount, employeesKycCurrentlySanctionedCount, employeesKycPreviouslySanctionedCount, employeesKycFlaggedCount e mais 2.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_EMPLOYEES_KYC",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.employeesKycTotalEmployees`	Quantidade total de funcionários com dados de KYC e Compliance retornados.
`result.employeesKycCurrentlyPepCount`	Quantidade de funcionários atualmente classificados como Pessoa Politicamente Exposta.
`result.employeesKycCurrentlySanctionedCount`	Quantidade de funcionários com sanção atualmente ativa.
`result.employeesKycPreviouslySanctionedCount`	Quantidade de funcionários que já possuíram alguma sanção.
`result.employeesKycFlaggedCount`	Quantidade de funcionários distintos sinalizados como PEP ou com alguma sanção.
`result.employeesKycSummary`	Resumo da consulta de KYC e Compliance dos Funcionários.
`result.employeesKycFlagged`	Lista estruturada dos funcionários classificados como PEP ou com sanções encontradas, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "employeesKycTotalEmployees": 5,
    "employeesKycCurrentlyPepCount": 0,
    "employeesKycCurrentlySanctionedCount": 0,
    "employeesKycPreviouslySanctionedCount": 0,
    "employeesKycFlaggedCount": 0,
    "employeesKycSummary": "Nenhum funcionário sinalizado como PEP ou sancionado",
    "employeesKycFlagged": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais.

Ações Trabalhistas

Service: SERVICE_LABOR_LAWSUITSQuando usar: Use para consultar certidões, processos ou informações jurídicas da empresa.O que retorna: Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, laborLawsuitsStatus, laborLawsuitsProtocol, laborLawsuitsCertificateNumber, laborLawsuitsIssuedDate, laborLawsuitsContent e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_LABOR_LAWSUITS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.laborLawsuitsStatus`	Status simplificado da certidão de Ações Trabalhistas emitida.
`result.laborLawsuitsProtocol`	Número de protocolo da certidão emitida.
`result.laborLawsuitsCertificateNumber`	Número da certidão de Ações Trabalhistas emitida.
`result.laborLawsuitsIssuedDate`	Data de emissão da certidão de Ações Trabalhistas.
`result.laborLawsuitsContent`	Conteúdo textual da certidão de Ações Trabalhistas retornado pela fonte.
`result.laborLawsuitsProcessesCount`	Quantidade de processos trabalhistas encontrados na certidão.
`result.laborLawsuitsSummary`	Resumo da consulta de Ações Trabalhistas.
`result.laborLawsuitsProcesses`	Lista estruturada dos processos trabalhistas encontrados, com número e vara, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "laborLawsuitsStatus": "NADA CONSTA",
    "laborLawsuitsProtocol": "2026000000000",
    "laborLawsuitsCertificateNumber": "00000000/2026",
    "laborLawsuitsIssuedDate": "2026-08-01",
    "laborLawsuitsContent": "Certifica-se que nada consta em nome da empresa quanto a ações trabalhistas",
    "laborLawsuitsProcessesCount": 0,
    "laborLawsuitsSummary": "Nada consta de ações trabalhistas",
    "laborLawsuitsProcesses": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.

Certidão negativa de protesto

Service: SERVICE_PROTEST_PJQuando usar: Use para consultar protestos associados ao documento da empresa.O que retorna: Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, hasProtests, notaryOffices, protests.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PROTEST_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.hasProtests`	Campo retornado no objeto result para consumo do cliente.
`result.notaryOffices`	Campo retornado no objeto result para consumo do cliente.
`result.protests`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "hasProtests": false,
    "notaryOffices": [],
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas.

Distribuição de Processos Judiciais

Service: SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANYQuando usar: Use para consultar certidões, processos ou informações jurídicas da empresa.O que retorna: Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, companyLawsuitsTotal, companyLawsuitsFirstDate, companyLawsuitsLastDate, companyLawsuitsLast30Days, companyLawsuitsLast90Days e mais 4.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.companyLawsuitsTotal`	Total de processos judiciais da empresa.
`result.companyLawsuitsFirstDate`	Data do processo mais antigo encontrado para a empresa.
`result.companyLawsuitsLastDate`	Data do processo mais recente encontrado para a empresa.
`result.companyLawsuitsLast30Days`	Quantidade de processos da empresa iniciados nos últimos 30 dias.
`result.companyLawsuitsLast90Days`	Quantidade de processos da empresa iniciados nos últimos 90 dias.
`result.companyLawsuitsLast180Days`	Quantidade de processos da empresa iniciados nos últimos 180 dias.
`result.companyLawsuitsLast365Days`	Quantidade de processos da empresa iniciados nos últimos 365 dias.
`result.companyLawsuitsSummary`	Resumo da consulta de Distribuição de Processos Judiciais.
`result.companyLawsuitsDistribution`	Distribuições agregadas dos processos da empresa por tipo, tribunal, status, estado, papel da parte e assunto, usada para renderização em tabela/gráfico.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "companyLawsuitsTotal": 5,
    "companyLawsuitsFirstDate": "2016-03-10",
    "companyLawsuitsLastDate": "2026-02-20",
    "companyLawsuitsLast30Days": 0,
    "companyLawsuitsLast90Days": 1,
    "companyLawsuitsLast180Days": 1,
    "companyLawsuitsLast365Days": 2,
    "companyLawsuitsSummary": "Empresa com 5 processos judiciais encontrados",
    "companyLawsuitsDistribution": {}
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período.

Processos jurídicos

Service: SERVICE_JURIDICAL_PROCESSES_PJQuando usar: Use para consultar certidões, processos ou informações jurídicas da empresa.O que retorna: Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalProcesses, processes.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_JURIDICAL_PROCESSES_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalProcesses`	Campo retornado no objeto result para consumo do cliente.
`result.processes`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalProcesses": 1,
    "processes": [
      {
        "court": "TJSP",
        "processNumber": "0000000-00.0000.0.00.0000",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis.

Compliance de casas de apostas

Service: SERVICE_COMPLIANCE_BET_PJQuando usar: Use para executar checagens de KYC e compliance da empresa.O que retorna: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, hasBettingExposure, indicators, riskLevel.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPLIANCE_BET_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.hasBettingExposure`	Campo retornado no objeto result para consumo do cliente.
`result.indicators`	Campo retornado no objeto result para consumo do cliente.
`result.riskLevel`	Indicador de risco retornado pelo produto.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "hasBettingExposure": true,
    "indicators": [
      "atividade relacionada"
    ],
    "riskLevel": "MEDIUM"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Compliance de casas de apostas (alias curto)

Service: SERVICE_COMPLIANCE_BETQuando usar: Use para executar checagens de KYC e compliance da empresa.O que retorna: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, hasBettingExposure, indicators, riskLevel.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPLIANCE_BET",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.hasBettingExposure`	Campo retornado no objeto result para consumo do cliente.
`result.indicators`	Campo retornado no objeto result para consumo do cliente.
`result.riskLevel`	Indicador de risco retornado pelo produto.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "hasBettingExposure": true,
    "indicators": [
      "atividade relacionada"
    ],
    "riskLevel": "MEDIUM"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Acordos Sindicais

Service: SERVICE_SYNDICATE_AGREEMENTSQuando usar: Use este service quando precisar executar a consulta “Acordos Sindicais” via API.O que retorna: Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, syndicateAgreementsTotal, syndicateAgreementsTotalActive, syndicateAgreementsSummary, syndicateAgreementsStats, syndicateAgreements.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_SYNDICATE_AGREEMENTS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.syndicateAgreementsTotal`	Quantidade total de acordos sindicais encontrados, ativos ou não.
`result.syndicateAgreementsTotalActive`	Quantidade de acordos sindicais ativos atualmente.
`result.syndicateAgreementsSummary`	Resumo da consulta de Acordos Sindicais.
`result.syndicateAgreementsStats`	Estatísticas consolidadas dos acordos sindicais encontrados.
`result.syndicateAgreements`	Lista estruturada dos acordos sindicais encontrados, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "syndicateAgreementsTotal": 1,
    "syndicateAgreementsTotalActive": 1,
    "syndicateAgreementsSummary": "Empresa com 1 acordo sindical ativo",
    "syndicateAgreementsStats": [],
    "syndicateAgreements": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento.

Anúncios Online

Service: SERVICE_ONLINE_ADSQuando usar: Use este service quando precisar executar a consulta “Anúncios Online” via API.O que retorna: Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, onlineAdsTotalPhones, onlineAdsSummary, onlineAds.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ONLINE_ADS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.onlineAdsTotalPhones`	Quantidade de telefones vinculados a anúncios online encontrados.
`result.onlineAdsSummary`	Resumo da consulta de Anúncios Online.
`result.onlineAds`	Lista estruturada dos anúncios online encontrados por telefone usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "onlineAdsTotalPhones": 0,
    "onlineAdsSummary": "Nenhum anúncio online encontrado",
    "onlineAds": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone.

Avaliações e Reputação

Service: SERVICE_REPUTATIONS_AND_REVIEWSQuando usar: Use este service quando precisar executar a consulta “Avaliações e Reputação” via API.O que retorna: Retorna a reputação da empresa em diferentes plataformas de avaliação de serviços, com visão consolidada, detalhamento por fonte e histórico de evolução.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalReputationSources, reputationSummary, reputationAndReviews, reputationSummaryDetails, reputationSummaryByDataSources.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_REPUTATIONS_AND_REVIEWS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalReputationSources`	Quantidade de plataformas de avaliação com dados de reputação encontrados.
`result.reputationSummary`	Resumo da consulta de avaliações e reputação.
`result.reputationAndReviews`	Lista estruturada de avaliações e reputação por fonte usada para renderização em tabela.
`result.reputationSummaryDetails`	Estatísticas consolidadas de avaliações e reputação (totais por período, notas unificadas, melhores e piores notas).
`result.reputationSummaryByDataSources`	Resumo textual de reputação por combinação de fonte e empresa.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalReputationSources": 2,
    "reputationSummary": "Empresa possui avaliações em 2 plataformas",
    "reputationAndReviews": [],
    "reputationSummaryDetails": {},
    "reputationSummaryByDataSources": {}
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a reputação da empresa em diferentes plataformas de avaliação de serviços, com visão consolidada, detalhamento por fonte e histórico de evolução.

Beneficiários Finais

Service: SERVICE_ULTIMATE_BENEFICIAL_OWNERSQuando usar: Use este service quando precisar executar a consulta “Beneficiários Finais” via API.O que retorna: Retorna os beneficiários finais da empresa pelo CNPJ informado, com percentual de participação acumulado, inclusive por cadeias indiretas, conforme limiar legal de 25%.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, uboSummary, uboTotalCompaniesInGroup, uboTotalPeopleInGroup, uboNumberOfOwners, uboBeneficialOwners e mais 1.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.uboSummary`	Resumo da consulta de Beneficiários Finais.
`result.uboTotalCompaniesInGroup`	Quantidade de empresas identificadas no grupo econômico.
`result.uboTotalPeopleInGroup`	Quantidade de pessoas identificadas no grupo econômico.
`result.uboNumberOfOwners`	Quantidade de sócios beneficiários finais identificados.
`result.uboBeneficialOwners`	Lista consolidada dos beneficiários finais, com percentual de participação agregado, usada para renderização em tabela.
`result.uboParticipations`	Lista achatada das participações societárias do grupo econômico, incluindo os níveis indiretos, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "uboSummary": "Consulta realizada",
    "uboTotalCompaniesInGroup": 3,
    "uboTotalPeopleInGroup": 5,
    "uboNumberOfOwners": 2,
    "uboBeneficialOwners": [
      {
        "name": "NOME DO BENEFICIARIO",
        "document": "00000000000",
        "accumulatedPercentage": 45.5
      }
    ],
    "uboParticipations": [
      {
        "ownerDocument": "00000000000",
        "ownerName": "NOME DO BENEFICIARIO",
        "ownedDocument": "cnpj",
        "percentage": 45.5,
        "level": 1
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna os beneficiários finais da empresa pelo CNPJ informado, com percentual de participação acumulado, inclusive por cadeias indiretas, conforme limiar legal de 25%.

Categoria Comercial

Service: SERVICE_MERCHANT_CATEGORY_DATAQuando usar: Use este service quando precisar executar a consulta “Categoria Comercial” via API.O que retorna: Retorna a categorização da empresa de acordo com o MCC (Merchant Category Code), por associação direta com a Abecs ou inferido pelo CNAE.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, merchantCategoryHasDirectAssociation, merchantCategoryHasMultipleCodes, merchantCategorySummary, merchantCategoryCategories, merchantCategoryCnaeCategories.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_MERCHANT_CATEGORY_DATA",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.merchantCategoryHasDirectAssociation`	Indica se a categoria comercial foi obtida por associação direta do CNPJ com a fonte Abecs.
`result.merchantCategoryHasMultipleCodes`	Indica se foram retornados múltiplos códigos comerciais (MCC) para a empresa.
`result.merchantCategorySummary`	Resumo da consulta de Categoria Comercial.
`result.merchantCategoryCategories`	Lista estruturada das categorias comerciais (MCC) associadas diretamente à empresa.
`result.merchantCategoryCnaeCategories`	Lista estruturada das categorias comerciais (MCC) associadas aos códigos CNAE da empresa.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "merchantCategoryHasDirectAssociation": "false",
    "merchantCategoryHasMultipleCodes": "false",
    "merchantCategorySummary": "Categoria comercial inferida pelo CNAE",
    "merchantCategoryCategories": [],
    "merchantCategoryCnaeCategories": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a categorização da empresa de acordo com o MCC (Merchant Category Code), por associação direta com a Abecs ou inferido pelo CNAE.

Certidão Negativa CNJ

Service: SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANYQuando usar: Use este service quando precisar executar a consulta “Certidão Negativa CNJ” via API.O que retorna: Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, cnjSummary, cnjBaseStatus, cnjClearance, cnjIssueDate, cnjCertificateUrl.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.cnjSummary`	Resumo da consulta de Certidão Negativa CNJ.
`result.cnjBaseStatus`	Status simplificado da certidão de condenações cíveis do CNJ.
`result.cnjClearance`	Indica se não há condenações por improbidade administrativa junto ao CNJ.
`result.cnjIssueDate`	Data de emissão da certidão de condenações cíveis do CNJ.
`result.cnjCertificateUrl`	Link para o arquivo da certidão de condenações cíveis do CNJ.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "cnjSummary": "Consulta realizada",
    "cnjBaseStatus": "NEGATIVA",
    "cnjClearance": "Sim",
    "cnjIssueDate": "2026-08-01",
    "cnjCertificateUrl": "https://example.com/certidão-cnj.pdf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade.

Certidão Negativa Correcional CGU

Service: SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANYQuando usar: Use este service quando precisar executar a consulta “Certidão Negativa Correcional CGU” via API.O que retorna: Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, cguSummary, cguBaseStatus, cguClearance, cguValidUntil, cguIssueDate e mais 1.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.cguSummary`	Resumo da consulta de Certidão Negativa Correcional CGU.
`result.cguBaseStatus`	Status simplificado da certidão correcional da CGU.
`result.cguClearance`	Indica se não há registros restritivos junto à CGU.
`result.cguValidUntil`	Data de validade da certidão correcional da CGU.
`result.cguIssueDate`	Data de emissão da certidão correcional da CGU.
`result.cguCertificateUrl`	Link para o arquivo da certidão correcional da CGU.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "cguSummary": "Consulta realizada",
    "cguBaseStatus": "NEGATIVA",
    "cguClearance": "Sim",
    "cguValidUntil": "2027-08-01",
    "cguIssueDate": "2026-08-01",
    "cguCertificateUrl": "https://example.com/certidão-cgu.pdf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM.

Cota de PCD

Service: SERVICE_PCD_COMPANYQuando usar: Use este service quando precisar executar a consulta “Cota de PCD” via API.O que retorna: Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, pcdSummary, pcdBaseStatus, pcdExpeditionDate, pcdCertificateUrl, pcdContent.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PCD_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.pcdSummary`	Resumo da consulta de Cota de PCD.
`result.pcdBaseStatus`	Status do cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados.
`result.pcdExpeditionDate`	Data de emissão da certidão de cota de PCD.
`result.pcdCertificateUrl`	Link para o arquivo da certidão de cota de PCD.
`result.pcdContent`	Texto integral da certidão de cota de PCD.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "pcdSummary": "Consulta realizada",
    "pcdBaseStatus": "EM CONFORMIDADE",
    "pcdExpeditionDate": "2026-08-01",
    "pcdCertificateUrl": "https://example.com/certidão-pcd.pdf",
    "pcdContent": "Texto integral da certidão de cota de PCD"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado.

Dados de Fundos de Investimento

Service: SERVICE_INVESTMENT_FUND_DATAQuando usar: Use este service quando precisar executar a consulta “Dados de Fundos de Investimento” via API.O que retorna: Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalMovimentations, investmentFundDataSummary, investmentFundData.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_INVESTMENT_FUND_DATA",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalMovimentations`	Quantidade de movimentações diárias encontradas para o fundo de investimento.
`result.investmentFundDataSummary`	Resumo da consulta de dados de fundos de investimento.
`result.investmentFundData`	Dados estruturados do fundo de investimento usados para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalMovimentations": 0,
    "investmentFundDataSummary": "Nenhuma movimentação de fundo de investimento encontrada",
    "investmentFundData": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM.

Evolução da Empresa

Service: SERVICE_COMPANY_EVOLUTIONQuando usar: Use este service quando precisar executar a consulta “Evolução da Empresa” via API.O que retorna: Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, companyEvolutionSummary, companyEvolutionStats.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_COMPANY_EVOLUTION",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.companyEvolutionSummary`	Resumo da consulta de Evolução da Empresa.
`result.companyEvolutionStats`	Estatísticas consolidadas da evolução de capital, funcionários, filiais e sócios da empresa ao longo do tempo.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "companyEvolutionSummary": "Empresa com tendência de crescimento estável",
    "companyEvolutionStats": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.

FGTS

Service: SERVICE_FGTSQuando usar: Use este service quando precisar executar a consulta “FGTS” via API.O que retorna: Retorna a certidão de regularidade do empregador perante o FGTS, com status, número e validade da certidão e conteúdo textual emitido.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, fgtsStatus, fgtsCertificateNumber, fgtsCertificateValidity, fgtsCertificateText, fgtsSummary e mais 1.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FGTS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.fgtsStatus`	Situação simplificada da certidão de regularidade do FGTS emitida.
`result.fgtsCertificateNumber`	Número identificador da certidão de regularidade do FGTS emitida.
`result.fgtsCertificateValidity`	Período de validade da certidão de regularidade do FGTS atual.
`result.fgtsCertificateText`	Conteúdo textual da certidão de regularidade do FGTS emitida.
`result.fgtsSummary`	Resumo da consulta de Regularidade do FGTS.
`result.fgtsDetails`	Lista estruturada com os detalhes da certidão de FGTS usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "fgtsStatus": "REGULAR",
    "fgtsCertificateNumber": "2026000000000000",
    "fgtsCertificateValidity": "01/08/2026 a 29/08/2026",
    "fgtsCertificateText": "Certificado que a empresa encontra-se em situação regular perante o FGTS",
    "fgtsSummary": "Empresa regular perante o FGTS",
    "fgtsDetails": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão de regularidade do empregador perante o FGTS, com status, número e validade da certidão e conteúdo textual emitido.

Flags Negativos PJ

Service: SERVICE_QUOD_CREDIT_RISK_COMPANYQuando usar: Use este service quando precisar executar a consulta “Flags Negativos PJ” via API.O que retorna: Retorna flags negativos de crédito de pessoa jurídica pelo CNPJ informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, riskLevel, riskClassification, hasRestrictions, negativeFlagsCount, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_QUOD_CREDIT_RISK_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.hasRestrictions`	Indica se foram retornadas restrições de crédito.
`result.negativeFlagsCount`	Quantidade de flags negativos retornados na consulta.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "hasRestrictions": false,
    "negativeFlagsCount": 0,
    "creditBureauSummary": "Nenhum flag negativo encontrado",
    "creditBureauDetails": {},
    "origin": "Quod",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna flags negativos de crédito de pessoa jurídica pelo CNPJ informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

Histórico de Dados Básicos

Service: SERVICE_HISTORY_BASIC_DATAQuando usar: Use este service quando precisar executar a consulta “Histórico de Dados Básicos” via API.O que retorna: Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, historyBasicDataCurrentName, historyBasicDataAge, historyBasicDataTotalChanges, historyBasicDataSummary, historyBasicDataStats e mais 5.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_HISTORY_BASIC_DATA",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.historyBasicDataCurrentName`	Nome atual da empresa na Receita Federal.
`result.historyBasicDataAge`	Idade atual da empresa em anos.
`result.historyBasicDataTotalChanges`	Quantidade total de alterações cadastrais encontradas no histórico.
`result.historyBasicDataSummary`	Resumo da consulta de Histórico de Dados Básicos.
`result.historyBasicDataStats`	Estatísticas consolidadas das alterações cadastrais encontradas.
`result.historyBasicDataNameHistory`	Lista estruturada do histórico de alterações de nome da empresa.
`result.historyBasicDataTaxRegimeHistory`	Lista estruturada do histórico de alterações de regime tributário.
`result.historyBasicDataTaxIdStatusHistory`	Lista estruturada do histórico de alterações de situação cadastral na Receita Federal.
`result.historyBasicDataCnaeHistory`	Lista estruturada do histórico de alterações de CNAE.
`result.historyBasicDataCapitalHistory`	Lista estruturada do histórico de alterações de capital social.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "historyBasicDataCurrentName": "EMPRESA EXEMPLO LTDA",
    "historyBasicDataAge": 6,
    "historyBasicDataTotalChanges": 2,
    "historyBasicDataSummary": "Empresa com 2 alterações cadastrais encontradas",
    "historyBasicDataStats": [],
    "historyBasicDataNameHistory": [],
    "historyBasicDataTaxRegimeHistory": [],
    "historyBasicDataTaxIdStatusHistory": [],
    "historyBasicDataCnaeHistory": [],
    "historyBasicDataCapitalHistory": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.

Influência do Quadro Societário

Service: SERVICE_OWNERS_INFLUENCEQuando usar: Use este service quando precisar executar a consulta “Influência do Quadro Societário” via API.O que retorna: Retorna o nível de influência inferido do quadro societário da empresa, considerando exposição na mídia, envolvimento político e histórico de processos dos sócios.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, influenceScore, ownersInfluenceSummary, ownersInfluence.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OWNERS_INFLUENCE",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.influenceScore`	Score de influência do quadro societário da empresa.
`result.ownersInfluenceSummary`	Resumo da consulta de influência do quadro societário.
`result.ownersInfluence`	Dados estruturados de influência do quadro societário usados para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "influenceScore": 0,
    "ownersInfluenceSummary": "Baixa influência do quadro societário",
    "ownersInfluence": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o nível de influência inferido do quadro societário da empresa, considerando exposição na mídia, envolvimento político e histórico de processos dos sócios.

Marketplaces

Service: SERVICE_MARKETPLACE_DATAQuando usar: Use este service quando precisar executar a consulta “Marketplaces” via API.O que retorna: Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalMarketplacesUsed, totalStoresOperated, marketplaceWithMostProducts, marketplaceWithBestRating, totalProductsListed e mais 2.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_MARKETPLACE_DATA",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalMarketplacesUsed`	Quantidade de marketplaces onde a empresa vende seus produtos.
`result.totalStoresOperated`	Quantidade total de lojas operadas nos diferentes marketplaces.
`result.marketplaceWithMostProducts`	Nome do marketplace com a maior quantidade de produtos.
`result.marketplaceWithBestRating`	Nome do marketplace onde a empresa tem a melhor avaliação.
`result.totalProductsListed`	Quantidade total de produtos listados nos marketplaces.
`result.marketplaceSummary`	Resumo da consulta de Marketplaces.
`result.marketplaceDetails`	Lista estruturada com os detalhes da presença da empresa em cada marketplace usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalMarketplacesUsed": 1,
    "totalStoresOperated": 1,
    "marketplaceWithMostProducts": "Mercado Livre",
    "marketplaceWithBestRating": "Mercado Livre",
    "totalProductsListed": 0,
    "marketplaceSummary": "Empresa presente em 1 marketplace",
    "marketplaceDetails": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação.

Obras Civis

Service: SERVICE_CIVIL_CONSTRUCTIONQuando usar: Use este service quando precisar executar a consulta “Obras Civis” via API.O que retorna: Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO).

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalCivilConstructionRecords, totalActiveCivilConstructionRecords, civilConstructionSummary, civilConstructionRecords.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CIVIL_CONSTRUCTION",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalCivilConstructionRecords`	Quantidade total de obras civis encontradas para o CNPJ.
`result.totalActiveCivilConstructionRecords`	Quantidade de obras civis ativas encontradas para o CNPJ.
`result.civilConstructionSummary`	Resumo da consulta de Obras Civis.
`result.civilConstructionRecords`	Lista estruturada das obras civis encontradas, conforme o Cadastro Nacional de Obras (CNO), usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalCivilConstructionRecords": 2,
    "totalActiveCivilConstructionRecords": 1,
    "civilConstructionSummary": "Consulta realizada",
    "civilConstructionRecords": [
      {
        "cno": "00000000000",
        "status": "ATIVA",
        "address": "RUA EXEMPLO, 100",
        "startDate": "2025-01-01"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO).

Optante pelo Simples Nacional

Service: SERVICE_SIMPLES_COMPANYQuando usar: Use este service quando precisar executar a consulta “Optante pelo Simples Nacional” via API.O que retorna: Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, simplesSummary, simplesOfficialName, simplesNationalStatus, simplesMeiStatus, simplesCertificateUrl.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_SIMPLES_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.simplesSummary`	Resumo da consulta de Optante pelo Simples Nacional.
`result.simplesOfficialName`	Nome oficial da empresa retornado pela Receita Federal.
`result.simplesNationalStatus`	Situação da empresa como optante pelo Simples Nacional.
`result.simplesMeiStatus`	Situação da empresa como optante pelo SIMEI.
`result.simplesCertificateUrl`	Link para o comprovante de Optante pelo Simples Nacional.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "simplesSummary": "Consulta realizada",
    "simplesOfficialName": "NOME OFICIAL DA EMPRESA",
    "simplesNationalStatus": "OPTANTE",
    "simplesMeiStatus": "NAO OPTANTE",
    "simplesCertificateUrl": "https://example.com/comprovante-simples.pdf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado.

Percentual de Participação Societária

Service: SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANYQuando usar: Use este service quando precisar executar a consulta “Percentual de Participação Societária” via API.O que retorna: Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, numberOfOwners, numberOfPeopleAsOwners, numberOfCompaniesAsOwners, hasMajorityStakeHolder, averageParticipationPercentage e mais 6.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.numberOfOwners`	Número total de sócios da empresa.
`result.numberOfPeopleAsOwners`	Número de sócios pessoa física da empresa.
`result.numberOfCompaniesAsOwners`	Número de sócios pessoa jurídica da empresa.
`result.hasMajorityStakeHolder`	Indica se a empresa possui sócio majoritário.
`result.averageParticipationPercentage`	Percentual médio de participação societária entre os sócios da empresa.
`result.maxParticipationPercentage`	Maior percentual de participação societária entre os sócios da empresa.
`result.minParticipationPercentage`	Menor percentual de participação societária entre os sócios da empresa.
`result.firstOwnerEntryDate`	Data de entrada do sócio mais antigo da empresa.
`result.lastOwnerEntryDate`	Data de entrada do sócio mais recente da empresa.
`result.ownerParticipationSummary`	Resumo da consulta de percentual de participação societária.
`result.ownerParticipations`	Lista estruturada de cada participação societária, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "numberOfOwners": 2,
    "numberOfPeopleAsOwners": 1,
    "numberOfCompaniesAsOwners": 1,
    "hasMajorityStakeHolder": true,
    "averageParticipationPercentage": 50,
    "maxParticipationPercentage": 70,
    "minParticipationPercentage": 30,
    "firstOwnerEntryDate": "2015-03-01",
    "lastOwnerEntryDate": "2022-06-15",
    "ownerParticipationSummary": "Consulta realizada",
    "ownerParticipations": [
      {
        "ownerDocument": "00000000000",
        "ownerName": "NOME DO SOCIO",
        "percentage": 70
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.

Projetos Públicos

Service: SERVICE_PUBLIC_PROJECTSQuando usar: Use este service quando precisar executar a consulta “Projetos Públicos” via API.O que retorna: Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalPublicProjects, publicProjectsSummary, publicProjects.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PUBLIC_PROJECTS",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalPublicProjects`	Quantidade total de projetos com financiamento público encontrados.
`result.publicProjectsSummary`	Resumo da consulta de Projetos Públicos.
`result.publicProjects`	Lista estruturada dos projetos com financiamento público encontrados, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalPublicProjects": 1,
    "publicProjectsSummary": "Consulta realizada",
    "publicProjects": [
      {
        "source": "BNDES",
        "modality": "FINANCIAMENTO",
        "contractedValue": 500000,
        "disbursedValue": 250000,
        "contractDate": "2025-01-10"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado.

Certidão Negativa de Débitos Estaduais

Service: SERVICE_STATE_DEBT_CERTIFICATE_COMPANYQuando usar: Use para consultar débitos ou dívidas associadas à empresa.O que retorna: Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, stateDebtSummary, stateDebtBaseStatus, stateDebtClearance, stateDebtState, stateDebtRegistration e mais 2.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.stateDebtSummary`	Resumo da consulta de Certidão Negativa de Débitos Estaduais.
`result.stateDebtBaseStatus`	Status simplificado da certidão de débitos estaduais.
`result.stateDebtClearance`	Indica se não há débitos estaduais associados à empresa.
`result.stateDebtState`	Unidade federativa (UF) a que se refere a certidão de débitos estaduais.
`result.stateDebtRegistration`	Situação cadastral estadual (CAD/ICMS) da empresa.
`result.stateDebtValidUntil`	Data de validade da certidão de débitos estaduais.
`result.stateDebtCertificateUrl`	Link para o arquivo da certidão de débitos estaduais.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "stateDebtSummary": "Consulta realizada",
    "stateDebtBaseStatus": "NEGATIVA",
    "stateDebtClearance": "Sim",
    "stateDebtState": "SP",
    "stateDebtRegistration": "000.000.000.000",
    "stateDebtValidUntil": "2027-08-01",
    "stateDebtCertificateUrl": "https://example.com/certidão-débitos-estaduais.pdf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados.

Dados Restritivos PJ

Service: SERVICE_BOAVISTA_CREDIT_SCORE_COMPANYQuando usar: Use para avaliar risco, score ou propensão associada à empresa.O que retorna: Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, score, hasRestrictions, restrictionCount, creditBureauSummary, creditBureauDetails e mais 2.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.hasRestrictions`	Indica se foram retornadas restrições de crédito.
`result.restrictionCount`	Quantidade de restrições retornadas na consulta.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "score": 720,
    "hasRestrictions": false,
    "restrictionCount": 0,
    "creditBureauSummary": "Nenhuma restrição de crédito encontrada",
    "creditBureauDetails": {},
    "origin": "Boa Vista",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas.

Débitos ativos

Service: SERVICE_ACTIVE_DEBT_PJQuando usar: Use para consultar débitos ou dívidas associadas à empresa.O que retorna: Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalDebts, totalValue, debts.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ACTIVE_DEBT_PJ",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalDebts`	Campo retornado no objeto result para consumo do cliente.
`result.totalValue`	Valor monetário, estimativa ou montante retornado pela consulta.
`result.debts`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalDebts": 1,
    "totalValue": "9800.00",
    "debts": [
      {
        "source": "PGFN",
        "value": "9800.00",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta.

Débitos com a PGFN

Service: SERVICE_PGFN_COMPANYQuando usar: Use para consultar débitos ou dívidas associadas à empresa.O que retorna: Retorna a certidão de débitos relativos a créditos tributários federais e à dívida ativa da união junto à PGFN, pelo CNPJ informado.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, pgfnSummary, pgfnBaseStatus, pgfnClearance, pgfnEmissionDate, pgfnCertificateUrl.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PGFN_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.pgfnSummary`	Resumo da consulta de Débitos com a PGFN.
`result.pgfnBaseStatus`	Status simplificado da certidão de débitos junto à PGFN.
`result.pgfnClearance`	Indica se não há pendências junto à Procuradoria-Geral da Fazenda Nacional.
`result.pgfnEmissionDate`	Data de emissão da certidão de débitos junto à PGFN.
`result.pgfnCertificateUrl`	Link para o arquivo da certidão de débitos junto à PGFN.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "pgfnSummary": "Consulta realizada",
    "pgfnBaseStatus": "NEGATIVA",
    "pgfnClearance": "Sim",
    "pgfnEmissionDate": "2026-08-01",
    "pgfnCertificateUrl": "https://example.com/certidão-pgfn.pdf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a certidão de débitos relativos a créditos tributários federais e à dívida ativa da união junto à PGFN, pelo CNPJ informado.

Risco de crédito

Service: SERVICE_CREDIT_RISK_COMPANYQuando usar: Use para avaliar risco, score ou propensão associada à empresa.O que retorna: Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, creditRisk.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CREDIT_RISK_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.creditRisk`	Indicador de risco retornado pelo produto.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "creditRisk": {
      "status": "APPROVED",
      "score": "720",
      "rating": "B",
      "expectedDefault": "MEDIUM",
      "legalProcess": false
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis.

Score de Crédito Multidados PJ

Service: SERVICE_BOAVISTA_ONE_SCORE_COMPANYQuando usar: Use para avaliar risco, score ou propensão associada à empresa.O que retorna: Retorna score de crédito multidados de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.reasonCodes`	Motivos, códigos ou fatores retornados para explicar o score.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "score": 700,
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "reasonCodes": [
      "Bom histórico de pagamentos"
    ],
    "creditBureauSummary": "Score de crédito multidados acima da média do setor",
    "creditBureauDetails": {},
    "origin": "Boa Vista",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito multidados de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Score de Crédito PJ

Service: SERVICE_QUOD_CREDIT_SCORE_COMPANYQuando usar: Use para avaliar risco, score ou propensão associada à empresa.O que retorna: Retorna score de crédito de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_QUOD_CREDIT_SCORE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.reasonCodes`	Motivos, códigos ou fatores retornados para explicar o score.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "score": 650,
    "riskLevel": "MEDIO",
    "riskClassification": "B",
    "reasonCodes": [
      "Tempo de mercado",
      "Capital social baixo"
    ],
    "creditBureauSummary": "Score de crédito dentro da média do setor",
    "creditBureauDetails": {},
    "origin": "Quod",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Score de Crédito Quantum PJ

Service: SERVICE_QUANTUM_CUSTOM_SCORE_COMPANYQuando usar: Use para avaliar risco, score ou propensão associada à empresa.O que retorna: Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, score, creditBureauSummary, creditBureauDetails, origin, queryDate.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY",
  "cnpj": "cnpj"
}

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

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

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "score": 690,
    "creditBureauSummary": "Score de crédito dentro da média do setor",
    "creditBureauDetails": {},
    "origin": "Quantum",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito.

Checklist antes de abrir chamado

Acesso

Confirme se o token pertence ao produto certo e se o service está ativo para API.

Payload

Confirme o valor exato de service e os campos obrigatórios listados no accordion.

Ambiente

Valide se a chamada foi feita em HML ou produção com o token do mesmo ambiente.

Evidência

Separe body sem dados sensíveis, horário, ambiente, status.message e externalId.

Padrões de erro

Os exemplos abaixo mostram formatos comuns. A mensagem pode variar conforme validação, produto e ambiente.

Token ausente ou inválido

{
  "status": {
    "code": 401,
    "message": "Unauthorized"
  }
}

Parâmetro obrigatório ausente

{
  "status": {
    "code": 400,
    "message": "Required field is missing or invalid"
  }
}

Service não liberado ou indisponível

{
  "status": {
    "code": 403,
    "message": "Service unavailable or not enabled for this client"
  }
}

​Antes de testar

Contrato base

Postman do zero

OCR de cartão CNPJ

Fluxos prontos

​Como usar esta página

​Como interpretar qualquer retorno

Dados úteis

Status técnico

Rastreio

Contrato limpo

​Famílias de services

Biometria e documentos

Contatos, sites e relacionamentos

Dados cadastrais e Receita Federal

Dados eleitorais e PEP

Jurídico, certidões e protestos

KYC, compliance e exposição

Outros services

Risco, crédito e dívidas

​Catálogo completo

Entrada

Resultado

Status da chamada

Campos opcionais

​Guia de OCR

​Payload mínimo

​Retorno limpo esperado

​Erro comum

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

Antes de testar

Como usar esta página

Como interpretar qualquer retorno

Famílias de services

Catálogo completo

Guia de OCR

Payload mínimo

Retorno limpo esperado

Erro comum

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result