# idCerberus API Docs - conteúdo completo para LLM

Este arquivo consolida os guias e a referência da API idCerberus em texto simples para uso por LLMs, agentes e assistentes de desenvolvimento.

Base URLs:

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

## Regras para assistentes de IA

- Use a documentação como fonte principal e não invente endpoints, parâmetros ou services.
- Para consultas externas, use `POST /api/service-api` e selecione o produto pelo campo `service`.
- Use `Authorization: Bearer {jwt_token}` em chamadas protegidas.
- Use homologação para testes e produção somente quando o usuário pedir explicitamente.
- Nunca exponha tokens, secrets, CPFs, CNPJs ou imagens reais em exemplos.
- Para OCR, use base64 puro em `image1`/`image2` e não inclua prefixo `data:image/...;base64,`.
- Não use `fieldsOutput`, campos nulos ou metadados internos como contrato público; use `result`.
- Se um service não aparecer no catálogo, informe que ele precisa ser confirmado antes de documentar ou integrar.

## Como escolher o arquivo certo

| Necessidade | Use |
| --- | --- |
| Entender a estrutura da documentação | https://api-docs.idcerberus.com/llms.txt |
| Gerar integração, curl ou escolher service | https://api-docs.idcerberus.com/llms-small.txt |
| Consultar payloads e responses por service | https://api-docs.idcerberus.com/llms-api-reference.txt |
| Buscar service em um índice leve | https://api-docs.idcerberus.com/services-catalog.min.json |
| Fazer busca estruturada por automação | https://api-docs.idcerberus.com/services-catalog.json |
| Configurar MCP ou agente com recursos estruturados | https://api-docs.idcerberus.com/mcp-manifest.json |
| Responder com todo o contexto da documentação | https://api-docs.idcerberus.com/llms-full.txt |

## Uso como base para MCP e agentes

Estes arquivos podem ser usados como fonte de contexto para um MCP da documentação. O MCP deve consultar a documentação, não executar chamadas na API idCerberus.

### Ordem recomendada de leitura

1. Leia `llms.txt` como manifesto inicial da documentação.
2. Use `services-catalog.min.json` para busca rápida por service, nome, categoria, campo e tag.
3. Use `services-catalog.json` quando precisar do contrato completo do service.
4. Use `mcp-manifest.json` para listar recursos, ferramentas sugeridas, regras de segurança e ordem de leitura.
5. Use `llms-api-reference.txt` para payloads, responses resumidos e exemplos por service.
6. Use `examples/*.curl` quando a resposta precisar de um curl pronto.
7. Use `llms-full.txt` apenas quando a pergunta exigir contexto completo dos guias, API Reference e OpenAPI.

### Recursos que um MCP pode expor

| Recurso | Uso no MCP |
| --- | --- |
| https://api-docs.idcerberus.com/llms.txt | Manifesto, regras, URLs principais e atalhos. |
| https://api-docs.idcerberus.com/llms-small.txt | Contexto curto para gerar integração, curl e explicação. |
| https://api-docs.idcerberus.com/llms-api-reference.txt | Payloads, responses e exemplos por service. |
| https://api-docs.idcerberus.com/llms-full.txt | Contexto completo para perguntas amplas. |
| https://api-docs.idcerberus.com/services-catalog.min.json | Índice leve para busca rápida por service, categoria, tag e campos. |
| https://api-docs.idcerberus.com/services-catalog.json | Busca estruturada e filtros por service/categoria/campo. |
| https://api-docs.idcerberus.com/mcp-manifest.json | Manifesto com recursos, ferramentas sugeridas, regras e ordem de leitura. |
| https://api-docs.idcerberus.com/examples/*.curl | Exemplos prontos para copiar e testar. |

### Regras para o MCP

- Operar como fonte somente leitura da documentação.
- Não chamar HML, produção, banco ou endpoints idCerberus.
- Não solicitar nem armazenar `client`, `secret`, JWT, CPF, CNPJ ou imagem real.
- Usar homologação como ambiente padrão quando gerar exemplos.
- Se o service não existir no catálogo, responder que precisa ser confirmado antes de integrar.
- Preferir `result` como contrato público; não usar `fieldsOutput` ou metadados internos.

## Contrato base do POST /api/service-api

- Endpoint de homologação: `POST https://backoffice-hml.idcerberus.com/api/service-api`.
- Endpoint de produção: `POST https://backoffice.idcerberus.com/api/service-api`.
- Header obrigatório: `Authorization: Bearer {jwt_token}`.
- Header recomendado: `Content-Type: application/json`.
- Campo obrigatório no body: `service`.
- O alias enviado em `service` deve ser o alias configurado no produto do cliente.
- Leia dados públicos em `result`; não trate `fieldsOutput` ou metadados internos como contrato público.
- Preserve `status`, `onboardingStatus` e `externalId` ao explicar respostas.

## Aliases importantes de chamada

Use o service público liberado no produto no campo `service`.

| Service |
| --- |
| `SERVICE_DIGITAL_DOCUMENTOSCOPY` |
| `SERVICE_DOCUMENTOSCOPY` |
| `SERVICE_EMAIL_VALIDATION1` |
| `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` |
| `SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ` |
| `economic_relationships` |

## Atalhos de services mais usados

| Caso | Service | Campos principais | Guia/API |
| --- | --- | --- | --- |
| CPF na Receita Federal | `SERVICE_RFB_PF` | `cpf`, `dataDeNascimento` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RFB_PF |
| CNPJ na Receita Federal | `SERVICE_RFB_PJ` | `cnpj` | https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RFB_PJ |
| OCR React | `SERVICE_OCR` | `documentType`, `image1`, `image2` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR |
| OCR cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | `image1` | https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OCR_CNPJ_CARD |
| OCR comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | `image1` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR_PROOF_OF_ADDRESS |
| Face Index | `SERVICE_FACE_INDEX` | `image1` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FACE_INDEX |
| Risco de crédito PJ | `SERVICE_CREDIT_RISK_COMPANY` | `cnpj` | https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CREDIT_RISK_COMPANY |
| Score de crédito PF | `SERVICE_CREDIT_SCORE` | `cpf` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CREDIT_SCORE |
| Processos jurídicos PJ | `SERVICE_JURIDICAL_PROCESSES_PJ` | `cnpj` | https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_JURIDICAL_PROCESSES_PJ |
| Benefícios sociais familiares | `SERVICE_FAMILY_SOCIAL_BENEFITS` | `cpf` | https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FAMILY_SOCIAL_BENEFITS |

## Notas rápidas para OCR e imagem

- OCR usa imagem do documento, não selfie.
- Face, FaceMatch e Face Index usam selfie/rosto, não foto de RG ou CNH.
- `image1` deve receber base64 puro, sem prefixo `data:image/...;base64,`.
- RG normalmente usa frente e verso: `image1` e `image2`.
- CNH usa `SERVICE_OCR`, `documentType: CNH` e `image1`.
- Cartão CNPJ usa `SERVICE_OCR_CNPJ_CARD` e `image1`.
- Comprovante de endereço usa `SERVICE_OCR_PROOF_OF_ADDRESS` e `image1`.
- Emancipação usa `SERVICE_OCR_EMANCIPATION`; o documento varia e o sucesso depende de OCR com texto útil.
- Se a imagem estiver ausente, ilegível ou for do tipo errado, espere `REFUSED` com mensagem clara, não invente sucesso.

## Diagnóstico rápido de erro

| Sintoma | Interpretação provável | Ação recomendada |
| --- | --- | --- |
| `401 Unauthorized` | Token ausente, expirado ou inválido. | Gerar novo token em `/api/token-generate`. |
| `Don't have access to the service` | Produto sem service ativo/API habilitada ou alias errado. | Conferir configuração do produto e alias de chamada. |
| Imagem ausente | Payload não enviou `image1`, `image2`, URL ou `key` esperado. | Conferir o OCR chamado e montar o JSON novamente. |
| `result: {}` | Consulta processou, mas não retornou dado útil. | Validar imagem, massa, configuração do produto e tipo correto do service. |
| `onboardingStatus: ERROR` | Falha técnica , storage, processamento externo ou processamento. | Usar `externalId`, horário e ambiente para investigar. |
| Campo esperado ausente | O campo pode não existir no documento/base ou não ter sido extraído. | Não inventar valor; explicar que o retorno traz apenas dados disponíveis. |

---

# Mapa da documentação

URL: https://api-docs.idcerberus.com/guides/mapa-da-documentacao
Fonte: guides/mapa-da-documentacao.mdx
Descrição: Encontre rapidamente o melhor caminho dentro da documentação idCerberus

# Mapa da documentação

Use esta página quando não souber por onde começar. Ela indica o caminho mais
curto de acordo com o seu objetivo.


    Gere token, execute um service e entenda o formato básico da resposta.


    Monte payloads com `image1`, `image2`, `documentType` e base64.


    Encontre o código `service` certo antes de montar o body.


    Copie requests, responses e exemplos por endpoint.


## Por perfil

| Perfil | Comece por | Depois vá para |
| --- | --- | --- |
| Dev integrando a API | [Quickstart](/guides/quickstart) | [Primeira consulta CPF](/guides/primeira-consulta-cpf) ou [Primeira consulta CNPJ](/guides/primeira-consulta-cnpj) |
| QA ou homologação | [Ambientes](/guides/ambientes) | [Status e erros](/guides/status-e-erros) e [Troubleshooting](/guides/troubleshooting) |
| Produto ou negócio | [Visão geral](/guides/visao-geral) | [Escolha o serviço certo](/guides/escolha-o-servico-certo) |
| Mobile ou SDK | [Onboarding via SDK](/guides/onboarding-sdk) | API Reference de onboarding |
| Dev consultando contrato | [API Reference](/api-reference/autorização/gerar-token-de-api) | Endpoint ou exemplo do serviço desejado |

## Por objetivo

| Quero... | Página indicada |
| --- | --- |
| Testar a API pela primeira vez | [Quickstart](/guides/quickstart) |
| Entender HML e produção | [Ambientes](/guides/ambientes) |
| Gerar token | [Autenticação](/guides/autenticacao) |
| Consultar CPF | [Primeira consulta CPF](/guides/primeira-consulta-cpf) |
| Consultar CNPJ | [Primeira consulta CNPJ](/guides/primeira-consulta-cnpj) |
| Escolher um código `service` | [Escolha o serviço certo](/guides/escolha-o-servico-certo) |
| Testar OCR com imagem ou base64 | [OCR via Service API](/guides/service-api/sobre-ocr-service-api) |
| Usar Postman | [Postman do zero](/guides/postman-do-zero) |
| Resolver erro | [Troubleshooting](/guides/troubleshooting) |
| Ir para produção | [Boas práticas de integração](/guides/boas-praticas-integracao) |
| Entender termos técnicos | [Glossário](/guides/glossario) |
| Copiar request e response | [API Reference](/api-reference/autorização/gerar-token-de-api) |

## Caminho recomendado


    Entenda o fluxo básico: gerar token, executar serviço e ler resposta.


    Escolha CPF ou CNPJ e execute o exemplo completo.


    Use a página de escolha de serviço para encontrar o código `service`.
    Se o teste envolver documento, imagem ou base64, abra também o guia de OCR.


    Abra a API Reference para copiar request, response e schemas.


    Revise boas práticas, ambientes, tratamento de erros e troubleshooting.

---

# Busca rápida

URL: https://api-docs.idcerberus.com/guides/busca-rapida
Fonte: guides/busca-rapida.mdx
Descrição: Encontre services, payloads, guias e exemplos usando termos comuns, aliases e casos de uso

# Busca rápida

Use esta página quando não souber exatamente onde procurar. Ela concentra os termos que mais ajudam a busca da documentação a encontrar o guia certo, o service correto ou um exemplo pronto.

## Como pesquisar melhor


    Pesquise por `cpf`, `receita`, `score`, `risco`, `telefone`, `email`, `benefícios`, `processos`, `face` ou `SERVICE_RFB_PF`.


    Pesquise por `cnpj`, `receita`, `risco de crédito`, `sócios`, `domínios`, `cartão CNPJ`, `compliance` ou `SERVICE_RFB_PJ`.


    Pesquise por `ocr`, `base64`, `image1`, `image2`, `CNH`, `RG`, `cartão CNPJ`, `comprovante de endereço` ou `emancipação`.


    Pesquise por `Don't have access`, `ERROR`, `REFUSED`, `externalId`, `payload`, `imagem ausente`, `result vazio` ou `status.message`.


## Consultas comuns

| Quero encontrar | Pesquise por | Página recomendada |
| --- | --- | --- |
| Gerar token | `token`, `client`, `secret`, `Authorization` | [Autenticação](/guides/autenticacao) |
| Executar service | `POST /api/service-api`, `service`, `payload`, `result` | [Como executar um service](/api-reference/como-executar-service) |
| Descobrir alias | `alias`, `callingAlias`, `services`, `catálogo` | [Índice de services](/guides/indice-de-services) |
| Escolher service por objetivo | `caso de uso`, `qual service`, `CPF`, `CNPJ`, `OCR` | [Services por caso de uso](/api-reference/services-por-caso-de-uso) |
| Testar no Postman | `Postman`, `HML`, `curl`, `jwt_token` | [Postman do zero](/guides/postman-do-zero) |
| Diagnosticar erro | `status.code`, `status.message`, `onboardingStatus`, `externalId` | [Erros comuns](/guides/erros-comuns-integracao) |

## OCR e imagem

| Documento ou cenário | Termos bons para busca | Service principal |
| --- | --- | --- |
| CNH | `CNH`, `OCR CNH`, `documentType CNH`, `image1` | `SERVICE_OCR` |
| RG frente e verso | `RG`, `OCR RG`, `image1 image2`, `frente verso` | `SERVICE_OCR` |
| Cartão CNPJ | `cartão CNPJ`, `OCR CNPJ card`, `SERVICE_OCR_CNPJ_CARD` | `SERVICE_OCR_CNPJ_CARD` |
| Comprovante de endereço | `comprovante`, `endereço`, `conta`, `fatura`, `SERVICE_OCR_PROOF_OF_ADDRESS` | `SERVICE_OCR_PROOF_OF_ADDRESS` |
| Emancipação | `emancipação`, `cartório`, `declaração`, `certidão`, `SERVICE_OCR_EMANCIPATION` | `SERVICE_OCR_EMANCIPATION` |

## Biometria e face

| Cenário | Termos bons para busca | Service principal |
| --- | --- | --- |
| Busca de face na base | `Face Index`, `selfie`, `rosto`, `busca facial`, `SERVICE_FACE_INDEX` | `SERVICE_FACE_INDEX` |
| Comparar duas faces | `FaceMatch`, `comparação facial`, `image1 image2` | `SERVICE_FACE_MATCH` |
| Validação facial | `FaceMatch`, `selfie`, `rosto`, `SERVICE_FACE_MATCH` | `SERVICE_FACE_MATCH` |

## CPF

| Objetivo | Termos bons para busca |
| --- | --- |
| Dados cadastrais | `CPF`, `Receita Federal`, `RFB PF`, `dados cadastrais`, `SERVICE_RFB_PF` |
| Score de crédito | `score`, `crédito`, `motor de score`, `SERVICE_CREDIT_SCORE` |
| Benefícios sociais | `benefícios sociais`, `Bolsa Família`, `assistência social` |
| Processos e risco | `processos`, `antecedentes`, `protesto`, `compliance`, `jurídico` |
| Contato | `telefone`, `email`, `histórico`, `validação de contato` |

## CNPJ

| Objetivo | Termos bons para busca |
| --- | --- |
| Dados cadastrais | `CNPJ`, `Receita Federal`, `RFB PJ`, `registration data`, `SERVICE_RFB_PJ` |
| Risco de crédito | `risco de crédito`, `credit risk`, `score PJ`, `SERVICE_CREDIT_RISK_COMPANY` |
| Sócios | `sócios`, `QSA`, `owners`, `relationship`, `Receita Federal` |
| Domínios | `domínios`, `domains`, `site`, `SERVICE_DOMAINS_CNPJ` |
| Compliance | `compliance`, `bet`, `processos`, `jurídico`, `sanções` |

## Perguntas prontas para a busca

Você pode pesquisar frases inteiras:

- `Como chamar SERVICE_OCR no /api/service-api?`
- `Qual payload para OCR de RG frente e verso?`
- `Como testar SERVICE_FACE_INDEX em HML?`
- `Don't have access to the service`
- `Por que result veio vazio?`
- `Qual service usar para risco de crédito PJ?`
- `Como consultar cartão CNPJ por OCR?`
- `Quais campos obrigatórios de SERVICE_CREDIT_RISK_COMPANY?`

## Se a busca não achar

1. Pesquise pelo alias completo, por exemplo `SERVICE_OCR`.
2. Pesquise pelo documento ou dado, por exemplo `CNH`, `CNPJ`, `score`, `telefone`.
3. Pesquise pelo problema, por exemplo `imagem ausente`, `result vazio`, `sem acesso`.
4. Abra o [índice de services](/guides/indice-de-services) e use `Ctrl + F`.
5. Se ainda não aparecer, confirme se o service já está documentado ou liberado para API.

---

# Quickstart

URL: https://api-docs.idcerberus.com/guides/quickstart
Fonte: guides/quickstart.mdx
Descrição: Faça sua primeira chamada na API idCerberus com Postman, Windows, macOS ou Linux

# Quickstart

Este guia mostra o caminho mais simples para fazer a primeira chamada na API
idCerberus. Ele foi escrito para quem ainda não tem familiaridade com API,
terminal ou `curl`.

Você pode testar de três formas:

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

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

## Antes de começar

Você precisa ter:

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

Os endpoints base são:

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

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

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

## 1. Escolha onde vai testar

### Postman

1. Abra o Postman.
2. Clique em **New**.
3. Escolha **HTTP Request**.
4. Selecione o método `POST`.
5. Cole a URL do ambiente desejado.
6. Vá na aba **Headers** e adicione `Content-Type` com valor `application/json`.
7. Vá na aba **Body**.
8. Escolha **raw**.
9. Selecione **JSON**.
10. Cole o body do exemplo.
11. Clique em **Send**.

### Windows PowerShell

1. Abra o menu iniciar.
2. Pesquise por `PowerShell`.
3. Abra o PowerShell.
4. Cole o comando `curl.exe` do exemplo.
5. Pressione **Enter**.

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

### Windows CMD

1. Abra o menu iniciar.
2. Pesquise por `cmd`.
3. Abra o Prompt de Comando.
4. Cole o comando em uma única linha ou use `^` para quebrar linhas.
5. Pressione **Enter**.

### macOS ou Linux

1. Abra o Terminal.
2. Cole o comando `curl` do exemplo.
3. Pressione **Enter**.

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

## 2. Gere um token

O primeiro request gera um token JWT. Esse token será usado nas próximas chamadas
protegidas.

No Postman, configure assim:

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

Body:

```json
{
  "client": "{client}",
  "secret": "{secret}"
}
```

### HML

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

### Produção

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

### Windows CMD

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

Resposta esperada:

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

Copie o valor de `access_token`. Ele será usado no próximo passo.

No Postman, copie somente o conteúdo entre aspas. Exemplo:

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

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

## 3. Execute um serviço

Use o token retornado no header `Authorization`.

No Postman, crie uma nova request:

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

### HML

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

### Produção

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

### Windows CMD

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

> Info:
  Vai testar OCR? Use o guia [OCR via Service API](/guides/service-api/sobre-ocr-service-api)
  para montar o payload com `image1`, `image2`, `documentType`, base64 e exemplos
  de retorno. OCR precisa de imagem real; payload curto só valida autenticação e acesso.

Substitua:

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


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


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


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


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


## 4. Leia o resultado

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

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

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

## 5. Trate sucesso e falha

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

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

## 6. Próximo passo

Se você já sabe qual produto consumir, vá para a [API Reference](/api-reference/autorização/gerar-token-de-api).

Se ainda está desenhando o fluxo, use [Escolha o serviço certo](/guides/escolha-o-servico-certo).

---

# Roteiro de integração

URL: https://api-docs.idcerberus.com/guides/roteiro-de-integracao
Fonte: guides/roteiro-de-integracao.mdx
Descrição: Um passo a passo prático para sair do primeiro teste até uma integração pronta para produção

# Roteiro de integração

Use este roteiro como checklist de execução. A ideia é sair de uma primeira
chamada manual, validar o comportamento esperado e só depois levar o fluxo para
o código da aplicação.

## 1. Confirme o ambiente

Escolha onde o teste será feito:

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

A estrutura da chamada é a mesma nos dois ambientes. Para trocar de HML para
produção, altere apenas a base URL.

## 2. Gere o token

Antes de executar serviços protegidos, gere um token JWT.

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

Copie o valor de `access_token` retornado. Nas chamadas seguintes, envie:

```http
Authorization: Bearer {jwt_token}
```

## 3. Teste manualmente antes de codar

Se a pessoa integrando ainda não tem familiaridade com terminal, comece pelo
Postman. Ele deixa URL, headers e body separados, o que reduz erro de digitação.

Fluxo recomendado:

1. testar no Postman;
2. repetir o mesmo request com `curl`;
3. confirmar o response esperado;
4. levar o request para Node.js, Python, C# ou outra linguagem.

## 4. Escolha o serviço correto

O endpoint `POST /api/service-api` funciona como executor de produtos. A rota é
sempre a mesma, mas o campo `service` define o que será executado.

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

Para pessoa física, a entrada principal costuma ser `cpf`. Para pessoa jurídica,
costuma ser `cnpj`. Serviços de documento, biometria e documentoscopia podem
exigir imagens em base64, URLs de imagem, selfie ou chave de consulta.

## 5. Valide o response

Na maioria dos serviços, os dados de negócio ficam em `result` e o status técnico
fica em `status`.

```json
{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

Não valide apenas o HTTP status. Leia também `status.code`, `status.message` e,
quando existir, `externalId`.

## 6. Prepare a integração para produção

Antes de subir para produção, confirme:

- credenciais de produção foram liberadas;
- a base URL foi trocada para `https://backoffice.idcerberus.com`;
- token expirado é tratado gerando um novo token;
- erros `400`, `401` e `403` têm tratamento claro;
- logs registram `service`, documento consultado de forma segura, `status.code`,
  `status.message` e `externalId`, quando retornado;
- dados sensíveis, base64 e tokens não são gravados em log aberto.

## 7. Onde continuar

- Para primeira chamada completa: [Quickstart](/guides/quickstart)
- Para escolher produtos: [Escolha o serviço certo](/guides/escolha-o-servico-certo)
- Para ver todos os grupos de serviço: [Matriz de serviços](/guides/matriz-de-servicos)
- Para contrato técnico: [API Reference](/api-reference/autorização/gerar-token-de-api)

---

# Visão geral

URL: https://api-docs.idcerberus.com/guides/visao-geral
Fonte: guides/visao-geral.mdx
Descrição: Entenda a arquitetura da integração, ambientes, endpoints e padrão de resposta da API idCerberus

# Visão geral

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

## Modelos de integração

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

## Se você está começando agora

Uma API é uma forma de um sistema conversar com outro. Na prática, você envia um
request para uma URL e recebe um response com o resultado.

Você pode testar os exemplos desta documentação de três formas:

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

O fluxo básico é sempre o mesmo:

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

Se você nunca executou uma chamada HTTP, comece pelo [Quickstart](/guides/quickstart).

## Ambientes

A API possui ambientes separados para homologação e produção. Os endpoints são os
mesmos nos dois ambientes; para trocar de ambiente, altere apenas a URL base.

Método HTTP, headers e payload permanecem iguais. A escolha do ambiente é feita
pela URL informada na chamada.

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

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

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

## Endpoints principais

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

## Fluxo mínimo para testar

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

## Padrão dos serviços externos

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

```http
POST /api/service-api
```

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

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

## Padrão de resposta

A maioria das consultas retorna:

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

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

## Próximos passos

- Para autenticação, veja [Autenticação](/guides/autenticacao).
- Para onboarding via SDK, veja [Onboarding via SDK](/guides/onboarding-sdk).
- Para catálogo de CPF, veja [Serviços de Pessoa Física](/guides/servicos-pessoa-fisica).
- Para catálogo de CNPJ, veja [Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica).
- Para implementação endpoint a endpoint, use a [API Reference](/api-reference/autorização/gerar-token-de-api).

---

# Ambientes

URL: https://api-docs.idcerberus.com/guides/ambientes
Fonte: guides/ambientes.mdx
Descrição: Entenda a diferença entre homologação e produção na API idCerberus

# Ambientes

A API idCerberus possui dois ambientes principais: homologação e produção. Os
endpoints, métodos, headers e bodies são os mesmos. O que muda é apenas a URL
base usada na chamada.

| Ambiente | Base URL | Quando usar |
| --- | --- | --- |
| Homologação | `https://backoffice-hml.idcerberus.com` | Testes, validações e homologação da integração |
| Produção | `https://backoffice.idcerberus.com` | Consultas reais em operação |

> Atencao:
  Não misture credenciais e dados de ambientes diferentes. Um token gerado em
  homologação deve ser usado com a URL de homologação. Um token gerado em
  produção deve ser usado com a URL de produção.

## Como trocar de ambiente

Para trocar de homologação para produção, altere somente a URL base.

| Item | Homologação | Produção |
| --- | --- | --- |
| Base URL | `https://backoffice-hml.idcerberus.com` | `https://backoffice.idcerberus.com` |
| Gerar token | `/api/token-generate` | `/api/token-generate` |
| Executar serviço | `/api/service-api` | `/api/service-api` |
| Header | Igual | Igual |
| Body | Igual | Igual |

## Exemplo: gerar token

Homologação:

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

Produção:

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

## Exemplo: executar serviço

Homologação:

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

Produção:

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

## Erros comuns

| Situação | Como resolver |
| --- | --- |
| Token de HML usado em produção | Gere um token novo na URL de produção |
| Token de produção usado em HML | Gere um token novo na URL de homologação |
| URL com ambiente errado | Confira se está usando `backoffice-hml` ou `backoffice` |
| Credenciais inválidas | Verifique `client`, `secret` e ambiente liberado |

## Recomendação

Comece sempre por homologação. Depois que o fluxo estiver validado, altere a URL
base e as credenciais para produção.

---

# Arquivos para LLMs

URL: https://api-docs.idcerberus.com/guides/llms
Fonte: guides/llms.mdx
Descrição: Use arquivos de contexto para apoiar integrações, automações e assistentes de IA

# Arquivos para LLMs

A documentação também publica arquivos em texto simples e JSON para uso por
LLMs, assistentes de código e ferramentas de automação.

Esses arquivos ajudam a consultar rapidamente guias, endpoints, services,
ambientes e exemplos da API idCerberus.

> Info:
Os links abaixo são arquivos estáticos. Ao clicar, o navegador abre o conteúdo
do arquivo em uma nova página. Para usar em uma ferramenta de IA ou automação,
copie a URL completa.

## Arquivos disponíveis

| Arquivo | Quando usar |
| --- | --- |
| [`llms.txt`](https://api-docs.idcerberus.com/llms.txt) | Índice curto da documentação, com links principais e visão geral. |
| [`llms-small.txt`](https://api-docs.idcerberus.com/llms-small.txt) | Resumo operacional para integrações: ambientes, autenticação, `POST /api/service-api`, fluxos e services documentados. |
| [`llms-full.txt`](https://api-docs.idcerberus.com/llms-full.txt) | Conteúdo completo consolidado dos guias, API Reference e OpenAPI. |
| [`llms-api-reference.txt`](https://api-docs.idcerberus.com/llms-api-reference.txt) | Versão operacional do API Reference, com services e exemplos de curl prontos para consulta por IA. |
| [`services-catalog.json`](https://api-docs.idcerberus.com/services-catalog.json) | Catálogo estruturado em JSON para automações, validadores e agentes. |
| [`services-catalog.min.json`](https://api-docs.idcerberus.com/services-catalog.min.json) | Índice leve para busca rápida por service, categoria, tag e campos. |
| [`mcp-manifest.json`](https://api-docs.idcerberus.com/mcp-manifest.json) | Manifesto para MCPs e agentes, com recursos, ordem de leitura, regras e ferramentas sugeridas. |
| [`examples/auth.hml.curl`](https://api-docs.idcerberus.com/examples/auth.hml.curl) | Exemplo pronto de autenticação em homologação. |

## Uso recomendado

Para dúvidas rápidas sobre a estrutura da documentação, use:

```txt
https://api-docs.idcerberus.com/llms.txt
```

Para pedir ajuda de implementação, geração de `curl`, escolha de service ou
explicação de fluxo, use:

```txt
https://api-docs.idcerberus.com/llms-small.txt
```

Para gerar exemplos de request a partir dos services documentados, use:

```txt
https://api-docs.idcerberus.com/llms-api-reference.txt
```

Para análises mais completas ou perguntas que dependem de todo o conteúdo da
documentação, use:

```txt
https://api-docs.idcerberus.com/llms-full.txt
```

Para automações que precisam de dados estruturados, use:

```txt
https://api-docs.idcerberus.com/services-catalog.json
```

Para busca rápida antes de abrir o contrato completo do service, use:

```txt
https://api-docs.idcerberus.com/services-catalog.min.json
```

Para configurar um MCP ou agente com a lista de recursos recomendados, use:

```txt
https://api-docs.idcerberus.com/mcp-manifest.json
```

## Uso como base para MCP

Esses arquivos já servem como base para um MCP da documentação. A ideia é o MCP consultar os arquivos publicados e responder perguntas sobre services, payloads, exemplos e guias sem chamar a API idCerberus.

Ordem recomendada:

1. Use `llms.txt` como manifesto inicial.
2. Use `services-catalog.min.json` para busca rápida por `service`, nome, categoria, campo ou tag.
3. Use `services-catalog.json` para abrir o contrato completo do service.
4. Use `mcp-manifest.json` para listar recursos, ferramentas sugeridas, regras de segurança e ordem de leitura.
5. Use `llms-api-reference.txt` para payload, response resumido e exemplo por service.
6. Use os arquivos `examples/*.curl` para devolver chamadas prontas.
7. Use `llms-full.txt` quando precisar de contexto completo dos guias e da API Reference.

Um MCP da documentação deve ser somente leitura. Ele não precisa chamar HML, produção, banco ou endpoint real. Também não deve pedir token, `client`, `secret`, CPF, CNPJ ou imagem real.

### Fluxo prático para usar no MCP

1. Leia `mcp-manifest.json` para descobrir quais arquivos existem, em qual ordem usar e quais regras seguir.
2. Busque primeiro em `services-catalog.min.json` para achar o service certo sem carregar contexto demais.
3. Abra `services-catalog.json` quando precisar de alias de chamada, campos, tags, erros comuns, exemplo de payload e dicas para agente.
4. Abra `llms-api-reference.txt` quando precisar explicar o contrato do service com mais texto.
5. Use `examples/*.curl` quando a resposta precisar de uma chamada pronta para copiar.
6. Use `llms-full.txt` só quando a pergunta depender do contexto completo dos guias.

Na prática, o MCP não precisa "adivinhar" nada. Primeiro ele encontra o service no catálogo, depois usa o guia certo para explicar payload, retorno e erro comum.

### O que cada arquivo resolve

| Pergunta | Melhor fonte |
| --- | --- |
| Qual service devo usar? | `services-catalog.min.json` |
| Qual alias vai no body? | `services-catalog.json` em `callingAlias` |
| Quais campos mandar? | `services-catalog.json` em `requiredFields`, `optionalFields` e `payloadExample` |
| Como testar no Postman/curl? | `examples/*.curl` e `llms-api-reference.txt` |
| O que fazer com erro comum? | `commonErrors` no catálogo e `llms-api-reference.txt` |
| Preciso de uma explicação completa do fluxo? | `llms-full.txt` |

### Prompts prontos

Use estes prompts como base quando quiser testar a documentação com uma IA ou montar um MCP mais direcionado.

**Escolher service**

```txt
Use https://api-docs.idcerberus.com/services-catalog.min.json e, se precisar,
https://api-docs.idcerberus.com/services-catalog.json.

Quero resolver este caso: {descreva o objetivo}.
Me diga qual service usar, qual alias vai no body, quais campos são obrigatórios
e qual guia devo abrir antes de testar.
Não invente service fora do catálogo.
```

**Montar curl**

```txt
Use https://api-docs.idcerberus.com/mcp-manifest.json,
https://api-docs.idcerberus.com/services-catalog.json e os arquivos
https://api-docs.idcerberus.com/examples/*.curl.

Monte um curl de homologação para o service {SERVICE}.
Use placeholders para token, CPF, CNPJ, client, secret e imagem.
Não use dado real.
```

**Explicar erro**

```txt
Use o bloco troubleshootingByStatus do mcp-manifest.json e o commonErrors do
service no services-catalog.json.

Explique este retorno: {cole o retorno sem dados sensíveis}.
Diga a causa provável, o que conferir primeiro e o próximo teste seguro.
Não trate REFUSED como falha técnica sem analisar status.message.
```

**OCR**

```txt
Use services-catalog.json, llms-api-reference.txt e o guia de OCR.

Quero testar OCR para {RG/CNH/cartão CNPJ/comprovante}.
Me diga o payload mínimo, o tipo de imagem esperado, o retorno público esperado
e os erros comuns. Não diga que OCR garante extrair todos os campos.
```

### Respostas que o MCP deve evitar

- Não dizer que Face Index valida identidade definitiva. Ele busca correspondência na base de faces.
- Não tratar `fieldsOutput` como contrato público.
- Não prometer que OCR sempre extrai todos os campos.
- Não inventar retorno de campo quando o campo não aparece na documentação.
- Não pedir CPF, CNPJ, token, client, secret ou imagem real para montar exemplo.
- Não sugerir chamada real em HML ou produção; esta base é somente leitura.

Exemplos de perguntas que essa base deve responder:

- OCR: qual service usar para RG, CNH, cartão CNPJ ou comprovante de endereço?
- CPF/CNPJ: qual payload mínimo para Receita Federal, score, risco ou cadastro?
- Face: como testar `SERVICE_FACE_INDEX` e qual imagem usar?
- Erro: o que significa `Don't have access to the service` ou `onboardingStatus: ERROR`?
- Curl: como montar uma chamada de homologação sem usar dado real?

## Exemplo de prompt

```txt
Use a documentação abaixo como fonte principal:
https://api-docs.idcerberus.com/llms-small.txt
https://api-docs.idcerberus.com/llms-api-reference.txt

Objetivo:
Quero integrar a API idCerberus para consultar dados de pessoa física em
homologação.

O que preciso que você entregue:
1. Explique o fluxo completo, em ordem: autenticação, geração do token e chamada
   do endpoint de consulta.
2. Indique qual endpoint devo usar e quais headers são obrigatórios.
3. Escolha o `service` correto para consultar CPF na Receita Federal.
4. Gere um exemplo de `curl` para gerar o token.
5. Gere um exemplo de `curl` para executar a consulta em `POST /api/service-api`.
6. Mostre um exemplo resumido de resposta esperada.
7. Explique como validar sucesso usando `status.code`, `status.message` e
   `result`.
8. Liste os erros mais comuns e como corrigir.

Regras:
- Use homologação, exceto se eu pedir produção explicitamente.
- Não invente endpoints, campos, services ou exemplos fora da documentação.
- Não use CPF, CNPJ, token, client ou secret reais.
- Use placeholders como `{client}`, `{secret}`, `{jwt_token}` e `"cpf"`.
- Se a documentação não trouxer alguma informação, diga que precisa ser
  confirmado antes de implementar.

Formato da resposta:
- Passo a passo curto.
- Depois os exemplos de `curl`.
- Depois uma seção "Como tratar a resposta".
- Depois uma seção "Checklist antes de testar".
```

---

# Como usar esta documentação

URL: https://api-docs.idcerberus.com/guides/como-usar-a-documentacao
Fonte: guides/como-usar-a-documentacao.mdx
Descrição: Entenda quando usar guias, catálogo técnico e API Reference

# Como usar esta documentação

A documentação está organizada para apoiar descoberta, desenho do fluxo e
implementação técnica. O objetivo é evitar que você precise procurar em uma
coleção grande de requests sem contexto.

## O caminho mais comum


    Use o [Quickstart](/guides/quickstart) para validar credenciais, gerar token
    e executar uma primeira chamada com Postman, Windows, macOS ou Linux.


    Use os guias de Pessoas, Empresas e Fluxos principais para entender quando
    cada produto faz sentido.


    Use [Escolha o serviço certo](/guides/escolha-o-servico-certo) quando você
    sabe o problema de negócio, mas ainda não sabe quais consultas combinar.


    Use a [API Reference](/api-reference/autorização/gerar-token-de-api) para copiar payloads,
    conferir parâmetros e mapear responses.


## Se você não sabe por onde executar

Você não precisa começar escrevendo código. A forma mais simples é testar no
Postman, porque a ferramenta deixa URL, headers e body separados em abas.

Depois que a chamada funcionar no Postman, você pode repetir o mesmo request no
terminal:

| Sistema | Como testar |
| --- | --- |
| Windows | PowerShell ou CMD com `curl.exe` |
| macOS | Terminal com `curl` |
| Linux | Terminal com `curl` |

O [Quickstart](/guides/quickstart) mostra esse passo a passo com exemplos para
cada ambiente.

## Áreas da documentação

| Área | Conteúdo | Melhor momento de uso |
| --- | --- | --- |
| Comece aqui | Quickstart, visão geral, organização e status/erros | Início da integração |
| Fluxos principais | Autenticação, onboarding, escolha de serviços e exemplos por linguagem | Desenho e implementação inicial |
| Pessoas | Serviços de CPF por domínio de uso | Escolha de produtos PF |
| Empresas | Serviços de CNPJ por domínio de uso | Escolha de produtos PJ |
| POST /api/service-api | Famílias de produtos executadas pelo endpoint central | Navegação técnica por código `service` |
| Catálogo técnico | Tabelas extensas de campos, request e response | Mapeamento detalhado |
| API Reference | Endpoints, schemas e exemplos técnicos | Implementação no código |

## Guias vs API Reference

Use os guias para decidir o que consumir. Use a API Reference para implementar a
chamada.

| Pergunta | Onde olhar |
| --- | --- |
| Qual serviço resolve meu caso? | [Escolha o serviço certo](/guides/escolha-o-servico-certo) |
| Como autentico? | [Autenticação](/guides/autenticacao) |
| Como funciona onboarding via SDK? | [Onboarding via SDK](/guides/onboarding-sdk) |
| Quais campos um serviço retorna? | Catálogo técnico e API Reference |
| Qual body devo enviar? | API Reference |
| Como trato falhas? | [Status e erros](/guides/status-e-erros) |

## Quando usar o catálogo técnico

O catálogo técnico é útil quando você precisa conferir listas maiores de campos
ou comparar serviços dentro do mesmo domínio.

- [Serviços de Pessoa Física](/guides/servicos-pessoa-fisica)
- [Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica)

Para endpoints operacionais, como consulta ou alteração de cliente, use a seção
Endpoints da API no API Reference.

## Quando usar exemplos por linguagem

Use [Exemplos por linguagem](/guides/exemplos-por-linguagem) quando quiser
acelerar a implementação inicial em `curl`, Node.js, Python ou C#.

Depois de validar o fluxo, troque o `service` e os campos do payload pelo
produto desejado.

---

# Postman do zero

URL: https://api-docs.idcerberus.com/guides/postman-do-zero
Fonte: guides/postman-do-zero.mdx
Descrição: Configure o Postman para testar token, service-api e OCR sem escrever código

# Postman do zero

Use este guia para montar uma collection simples e testar a API idCerberus em homologação.

O objetivo é sair com dois requests funcionando:

- `POST /api/token-generate`
- `POST /api/service-api`


    Sem token válido, nenhum service protegido deve ser testado.


    Troque apenas o campo `service` e os campos obrigatórios de cada consulta.


    Use PowerShell para copiar imagem em base64 e colar no body do Postman.


    Veja o que olhar quando vier falta de acesso, imagem ausente, `{}` ou `ERROR`.


## 1. Crie uma collection

1. Abra o Postman.
2. Clique em **Collections**.
3. Clique em **New Collection**.
4. Nomeie como `idCerberus API`.
5. Salve.

## 2. Crie um environment de HML

1. Clique em **Environments**.
2. Clique em **New Environment**.
3. Nomeie como `idCerberus HML`.
4. Crie a variável `base_url`.
5. No valor, coloque:

```txt
https://backoffice-hml.idcerberus.com
```

6. Crie a variável `jwt_token`.
7. Deixe o valor vazio por enquanto.
8. Salve o environment.
9. Selecione `idCerberus HML` no canto superior direito do Postman.

## 3. Crie o request de token

1. Dentro da collection, clique em **Add request**.
2. Nomeie como `Gerar token`.
3. Selecione o método `POST`.
4. Use a URL:

```txt
{{base_url}}/api/token-generate
```

5. Na aba **Headers**, adicione:

| Key | Value |
| --- | --- |
| `Content-Type` | `application/json` |

6. Na aba **Body**, escolha **raw**.
7. Selecione **JSON**.
8. Cole:

```json
{
  "client": "{client}",
  "secret": "{secret}"
}
```

9. Clique em **Send**.
10. Copie o valor de `access_token`.
11. Cole esse valor na variável `jwt_token` do environment.

> Nota:
  Se preferir, configure um script de teste no request de token para salvar o token automaticamente:

```js
const data = pm.response.json();
pm.environment.set("jwt_token", data.access_token || data.token);
```

## 4. Crie o request de service-api

1. Dentro da collection, clique em **Add request**.
2. Nomeie como `Executar service-api`.
3. Selecione o método `POST`.
4. Use a URL:

```txt
{{base_url}}/api/service-api
```

5. Na aba **Headers**, adicione:

| Key | Value |
| --- | --- |
| `Authorization` | `Bearer {{jwt_token}}` |
| `Content-Type` | `application/json` |

6. Na aba **Body**, escolha **raw**.
7. Selecione **JSON**.
8. Cole um payload de teste.

Exemplo CPF:

```json
{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "00000000000"
}
```

Exemplo CNPJ:

```json
{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "00000000000000"
}
```

## 5. Leia a resposta

Uma resposta de negócio costuma seguir este formato:

```json
{
  "result": {},
  "status": {
    "code": 200,
    "message": "Success"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Leia assim:

| Campo | O que significa |
| --- | --- |
| `result` | Dados úteis retornados pelo service |
| `status.code` | Código técnico do processamento |
| `status.message` | Mensagem técnica do processamento |
| `onboardingStatus` | Resultado operacional do service, quando existir |
| `externalId` | Identificador para rastrear a chamada em suporte/logs |

> Atencao:
  Não use apenas o HTTP status para decidir se deu certo. A API pode responder HTTP 200 e o body indicar `REFUSED` ou `ERROR`.

## 6. Exemplos prontos

Se quiser copiar um curl já montado, use:

| Caso | Exemplo |
| --- | --- |
| Token HML | [`auth.hml.curl`](/examples/auth.hml.curl) |
| CPF HML | [`service-api-cpf.hml.curl`](/examples/service-api-cpf.hml.curl) |
| CNPJ HML | [`service-api-cnpj.hml.curl`](/examples/service-api-cnpj.hml.curl) |
| OCR CNH | [`service-api-ocr-cnh.hml.curl`](/examples/service-api-ocr-cnh.hml.curl) |
| OCR RG | [`service-api-ocr-rg.hml.curl`](/examples/service-api-ocr-rg.hml.curl) |
| OCR cartão CNPJ | [`service-api-ocr-cnpj-card.hml.curl`](/examples/service-api-ocr-cnpj-card.hml.curl) |
| OCR comprovante | [`service-api-ocr-proof-of-address.hml.curl`](/examples/service-api-ocr-proof-of-address.hml.curl) |
| Face Index | [`service-api-face-index.hml.curl`](/examples/service-api-face-index.hml.curl) |

> Nota:
  Se quiser payload, retorno esperado e erro comum no mesmo lugar, abra [Receitas prontas](/guides/receitas-prontas).

## 7. Testar OCR com imagem

Para OCR, o campo `image1` deve receber base64 puro. Não envie prefixo `data:image/jpeg;base64,`.

### CNH

```powershell
$b64 = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\caminho\cnh.jpg"))
@{
  service = "SERVICE_OCR"
  documentType = "CNH"
  image1 = $b64
} | ConvertTo-Json -Compress | Set-Clipboard
```

### RG frente e verso

```powershell
$front = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\caminho\rg-frente.jpg"))
$back = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\caminho\rg-verso.jpg"))
@{
  service = "SERVICE_OCR"
  documentType = "RG"
  image1 = $front
  image2 = $back
} | ConvertTo-Json -Compress | Set-Clipboard
```

### Cartão CNPJ

```powershell
$b64 = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\caminho\cartao-cnpj.jpg"))
@{
  service = "SERVICE_OCR_CNPJ_CARD"
  image1 = $b64
} | ConvertTo-Json -Compress | Set-Clipboard
```

### Comprovante de endereço

```powershell
$b64 = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\caminho\comprovante.jpg"))
@{
  service = "SERVICE_OCR_PROOF_OF_ADDRESS"
  image1 = $b64
} | ConvertTo-Json -Compress | Set-Clipboard
```

Depois de rodar o comando, cole no **Body > raw > JSON** do Postman.

## 8. Troque para produção

Para criar um environment de produção, repita o processo e use:

```txt
https://backoffice.idcerberus.com
```

Use credenciais de produção e gere um novo token. Não reutilize token de HML em produção.

## 9. Se der erro

| Sintoma | O que olhar primeiro | Ação |
| --- | --- | --- |
| `401` ou `403` | Token vencido, ausente ou de outro ambiente | Gere novo token no mesmo ambiente da chamada |
| `Don't have access to the service` | Produto sem o service liberado para API | Conferir cadastro do produto antes de mexer no payload |
| `Imagem ... não encontrada` | Campo de imagem não chegou no body | Conferir `image1`, `image2`, `image1Url`, `image2Url` ou `key` |
| Retornou `{}` | Service sem dado para a massa ou imagem não lida | Testar massa/imagem válida e conferir `status.message` |
| Veio `ERROR` | Falha técnica no processamento | Guardar `externalId`, horário e service chamado |
| Campo esperado não veio | Campo não existe no documento ou não foi extraído | Validar imagem, tipo de documento e contrato do service |

Para diagnóstico mais completo, veja [Erros comuns de integração](/guides/erros-comuns-integracao).

---

# Status e erros

URL: https://api-docs.idcerberus.com/guides/status-e-erros
Fonte: guides/status-e-erros.mdx
Descrição: Entenda como interpretar respostas, falhas e casos sem body JSON

# Status e erros

A API idCerberus separa o status HTTP do status técnico retornado no body. Em
integrações, leia os dois.

## Estrutura padrão

```json
{
  "result": {},
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "8e1ac243-4510-4ebf-ac7d-4b6d133dd619"
}
```

| Campo | Uso |
| --- | --- |
| `result` | Dados retornados pelo produto consultado |
| `status.code` | Código técnico do processamento |
| `status.message` | Mensagem técnica do processamento |
| `externalId` | Identificador externo da consulta, quando retornado |

## Como interpretar

| Caso | Significado prático | Ação recomendada |
| --- | --- | --- |
| HTTP 200 e `status.code` 200 | A chamada foi processada | Ler `result` e seguir a regra de negócio |
| HTTP 200 e `status.code` 400 | A API respondeu, mas o processamento falhou | Ler `status.message`, validar parâmetros e permissão |
| HTTP 401 ou 403 | Problema de autenticação ou permissão | Gerar novo token ou revisar credenciais/produto liberado |
| Timeout | Fonte externa ou rede pode ter demorado | Aplicar retry controlado, sem loop agressivo |
| Sem body JSON | O endpoint retorna outro tipo de conteúdo | Tratar conforme contrato, como PDF no relatório de onboarding |

## Problemas comuns

| Problema | Possível causa | Como resolver |
| --- | --- | --- |
| Token inválido | Token gerado com credenciais erradas ou ambiente incorreto | Gere um novo token no mesmo ambiente da chamada |
| Token expirado | O tempo de validade do token acabou | Gere um novo token e repita a chamada |
| `Authorization` ausente | Header não foi enviado | Envie `Authorization: Bearer {jwt_token}` |
| `Content-Type` ausente | Body JSON enviado sem header correto | Envie `Content-Type: application/json` |
| Campo `service` ausente | Payload não informou qual produto executar | Inclua o campo `service` no body |
| CPF ou CNPJ inválido | Documento incompleto, mascarado ou fora do padrão esperado | Revise o valor enviado antes de chamar a API |
| Serviço sem permissão | Produto não liberado para a conta | Confirme a liberação do serviço com o time responsável |
| Fonte externa indisponível | Consulta depende de órgão, base ou processamento externo | Faça retry controlado ou tente novamente depois |
| URL de ambiente errada | Token de HML usado em produção, ou o contrário | Confira se a URL base e o token são do mesmo ambiente |

## Exemplos de erro

### Token ausente ou inválido

Quando o header `Authorization` não é enviado, está expirado ou pertence a outro
ambiente, a API pode retornar erro de autenticação.

```http
HTTP/1.1 401 Unauthorized
```

Como corrigir:

1. Gere um novo token em `POST /api/token-generate`.
2. Confirme se o token foi gerado no mesmo ambiente da chamada.
3. Envie o header no formato abaixo.

```http
Authorization: Bearer {jwt_token}
```

### Campo `service` ausente

O endpoint `POST /api/service-api` precisa do campo `service` para saber qual
produto executar.

Payload incorreto:

```json
{
  "cpf": "cpf"
}
```

Payload correto:

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

### Documento obrigatório ausente

Se o serviço exige `cpf`, `cnpj`, imagem ou outro campo obrigatório, envie o
campo correspondente no body.

Exemplo de retorno:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "CPF não encontrado."
  }
}
```

Como corrigir:

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

### Produto sem permissão ou não habilitado

Se a credencial não tiver acesso ao produto, a chamada pode falhar mesmo com
token válido.

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Serviço não disponível para este cliente."
  }
}
```

Como corrigir:

- confirme se o `service` está escrito exatamente como na documentação;
- valide se o produto está liberado para a conta;
- confirme se está chamando o ambiente correto.

### Fonte externa indisponível

Algumas consultas dependem de bases externas. Quando a fonte falha ou demora, a
API pode retornar erro técnico.

```json
{
  "result": {},
  "status": {
    "code": 500,
    "message": "Failed to fetch information"
  }
}
```

Como tratar:

- registre o `externalId`, quando existir;
- tente novamente depois com retry limitado;
- não faça loop infinito de chamadas;
- se o erro persistir, encaminhe o payload e o horário da tentativa para suporte.

## Negativo não é erro técnico

Alguns serviços retornam uma consulta negativa como sucesso técnico. Exemplos:

| Resultado | Exemplo |
| --- | --- |
| Nada consta | Certidões criminais ou ações judiciais |
| Cliente não encontrado | Validação de CPF com endereço |
| Sem débitos | Débitos ativos com totais zerados |
| Não PEP | Pessoa politicamente não exposta |

Nesses casos, a chamada pode ter `status.code` 200 e ainda assim representar uma
resposta negativa de negócio.

## Boas práticas de tratamento

- Registre o `externalId` quando ele vier no retorno.
- Não use apenas HTTP status para decidir sucesso de negócio.
- Trate token expirado gerando novo token.
- Valide campos obrigatórios antes de chamar a API.
- Evite retry automático em erro de payload.
- Use retry com limite para timeout ou falha temporária de fonte externa.

## Exemplo de decisão

```js
if (response.status?.code !== 200) {
    throw new Error(response.status?.message || "Falha no processamento");
}

return response.result;
```

---

# Erros comuns de integração

URL: https://api-docs.idcerberus.com/guides/erros-comuns-integracao
Fonte: guides/erros-comuns-integracao.mdx
Descrição: Diagnóstico prático para token, acesso, payload, base64, OCR, retorno vazio e falhas externas

# Erros comuns de integração

Use esta página quando uma chamada falhar, retornar vazio ou parecer diferente do esperado.

A regra mais importante: em `POST /api/service-api`, olhe o body da resposta, não só o HTTP status. Uma chamada pode retornar HTTP 200 e mesmo assim o processamento vir como `REFUSED` ou `ERROR`.


    `401`, `403`, token vencido ou produto sem permissão para o service.


    Campo obrigatório ausente, alias errado, CPF/CNPJ inválido ou JSON malformado.


    Base64, `image1`, `image2`, documento ilegível ou OCR sem campo esperado.


    `ERROR`, `500`, falha externa, timeout ou investigação por `externalId`.


## Diagnóstico rápido

| Sintoma | Causa comum | Como corrigir |
| --- | --- | --- |
| `401` ou `403` | Token ausente, expirado, inválido ou de outro ambiente | Gere um novo token no mesmo ambiente da chamada |
| `Don't have access to the service` | Produto sem o service ativo ou sem API habilitada | Confira configuração do produto antes de mexer no payload |
| `Unable to convert http message` | JSON inválido, base64 quebrado ou body malformado | Valide o JSON e gere o base64 novamente |
| API retorna HTTP 200 com `REFUSED` | Chamada autenticou, mas a regra de negócio recusou | Leia `status.message` e trate como recusa válida |
| API retorna HTTP 200 com `ERROR` | Falha técnica aconteceu dentro do processamento | Guarde `externalId`, horário e service chamado |
| Resultado vazio `{}` | Massa sem dados, imagem não lida ou service sem retorno para aquele caso | Teste massa válida e confira `status.message` |
| Campo esperado não veio | Campo não existe na fonte ou não foi extraído com segurança | Não invente dado; trate campo ausente como opcional quando o contrato permitir |
| Base64 rejeitado | Prefixo, encoding, quebra de linha ou arquivo inválido | Envie base64 puro, sem `data:image/...;base64,` |
| CPF/CNPJ não encontrado | Documento mascarado, incompleto, massa ruim ou ambiente errado | Teste sem máscara e confira a base URL |
| Timeout | Fonte externa demorou ou ficou indisponível | Aplique retry controlado e registre o `externalId`, quando houver |

## Token ou acesso

Antes de investigar código, confirme:

1. A chamada está indo para o ambiente certo.
2. O token foi gerado no mesmo ambiente.
3. O header está como `Authorization: Bearer {jwt_token}`.
4. O produto ligado ao token tem o service ativo.
5. O service está habilitado para API.
6. O alias enviado em `service` é o alias de chamada configurado no produto.

Exemplo típico:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Don't have access to the service"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}
```

Nesse caso, o primeiro ponto é configuração do produto. Não adianta trocar CPF, CNPJ ou imagem antes de confirmar acesso.

## Payload

Campos que mais geram erro:

| Campo | Cuidado |
| --- | --- |
| `service` | Deve bater com o alias liberado no produto |
| `cpf` | Envie sem máscara quando o service não documentar outro formato |
| `cnpj` | Envie CNPJ completo, preferencialmente sem máscara |
| `birthDate` | Use o formato documentado para o service |
| `documentType` | Para OCR React, use `CNH` ou `RG` conforme o documento |
| `image1`, `image2`, `selfie1` | Confirme se o service espera imagem, selfie, frente, verso ou comparação |
| `key` | Use apenas quando o fluxo suportar chave de arquivo já armazenado |

Exemplo de JSON mínimo válido:

```json
{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "00000000000000"
}
```

## Imagem e OCR

Para services de OCR:

1. Use imagem real, nítida e completa.
2. Envie base64 puro.
3. Não envie `data:image/jpeg;base64,`.
4. Para RG, envie frente e verso quando o service exigir.
5. Para face, use selfie real, não foto de documento.
6. Confira se o documento enviado combina com o service.

Exemplo de erro por imagem ausente:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Imagem do verso do documento não encontrada"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}
```

Ação: revisar o payload. Para RG, envie `image1` com a frente e `image2` com o verso.

Se o retorno for:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Não foi possível ler o documento"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}
```

Ação: testar uma imagem mais nítida e confirmar se o tipo de documento bate com o service.

## Erro técnico

Erro técnico normalmente aparece como `ERROR` ou mensagem de falha no body:

```json
{
  "result": {},
  "status": {
    "code": 500,
    "message": "Falha ao realizar OCR"
  },
  "onboardingStatus": "ERROR",
  "externalId": "..."
}
```

Nessa situação, guarde:

- ambiente;
- endpoint;
- service enviado;
- horário aproximado;
- `externalId`;
- `status.code`;
- `status.message`;
- payload sem dados sensíveis.

Não envie token JWT, `client`, `secret`, CPF, CNPJ, imagem real ou base64 completo em canais abertos.

## Checklist antes de chamar suporte

1. Confirmei o ambiente da chamada.
2. Gerei token novo no mesmo ambiente.
3. Conferi o alias do service no produto.
4. Validei que o service está ativo e com API habilitada.
5. Validei o JSON antes de enviar.
6. Removi máscara quando o contrato não exigia máscara.
7. Para OCR, conferi se o base64 é puro.
8. Para OCR, abri a imagem e confirmei que está legível.
9. Guardei `externalId`, horário e `status.message`.

## Como solicitar suporte

Envie um resumo nesse formato:

```txt
Ambiente: HML ou PROD
Endpoint: POST /api/service-api
Service: SERVICE_EXEMPLO
Horário aproximado: 2026-01-01 10:30
ExternalId: ...
Status code: ...
Status message: ...
O que era esperado: ...
O que retornou: ...
```

Não inclua credenciais, token, documento real, imagem real ou base64 completo.

---

# Troubleshooting

URL: https://api-docs.idcerberus.com/guides/troubleshooting
Fonte: guides/troubleshooting.mdx
Descrição: Resolva problemas comuns ao integrar com a API idCerberus

# Troubleshooting

Use esta página quando uma chamada não funcionar como esperado.

## Recebi 401 ou 403

Possíveis causas:

- Token ausente.
- Token expirado.
- Token gerado em outro ambiente.
- Produto não liberado para a conta.

Como resolver:

1. Gere um novo token.
2. Confirme se a URL é de HML ou produção.
3. Envie o header:

```txt
Authorization: Bearer {jwt_token}
```

4. Confirme se o serviço está liberado para a conta.

## Recebi `status.code` 400

Possíveis causas:

- Body inválido.
- Campo obrigatório ausente.
- Código `service` incorreto.
- CPF ou CNPJ inválido.
- Serviço sem permissão.
- Fonte externa indisponível.

Como resolver:

1. Leia `status.message`.
2. Confira se o body está em JSON válido.
3. Confira se enviou `Content-Type: application/json`.
4. Confira se o campo `service` está correto.
5. Compare o body com o exemplo da API Reference.

## O token funciona em HML, mas não em produção

Token e URL precisam ser do mesmo ambiente.

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

Gere um token novo em produção usando credenciais de produção.

## O cURL funciona, mas meu código não

Confira:

- URL base.
- Método HTTP.
- Headers.
- Body JSON.
- Timeout.
- Serialização do JSON.
- Header `Authorization`.
- Header `Content-Type`.

Compare o request do código com o request da API Reference.

## O PowerShell quebra o comando cURL

No Windows, use `curl.exe` em vez de `curl`.

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

O comando `curl` sozinho pode ser interpretado pelo PowerShell como outro alias.

## A consulta retornou sucesso, mas não veio o dado esperado

Nem todo retorno sem dado é erro técnico.

Exemplos:

- certidão com “Nada consta”;
- CPF não encontrado em validação de endereço;
- pessoa não exposta politicamente;
- empresa sem débitos;
- lista vazia de relacionamentos.

Leia `result` e aplique a regra de negócio do seu produto.

## A resposta não veio em JSON

Alguns endpoints retornam outro tipo de conteúdo. Exemplo:

```txt
GET /api/history-onboarding-report/{tokenOnboarding}
```

Esse endpoint retorna PDF, não JSON.

## Checklist rápido

Antes de pedir apoio, confira:

- A URL está correta?
- O método HTTP está correto?
- O token foi gerado no mesmo ambiente?
- O header `Authorization` foi enviado?
- O header `Content-Type` foi enviado?
- O body é JSON válido?
- O campo `service` está correto?
- O CPF/CNPJ está no campo esperado?
- O serviço está liberado para a conta?
- Você leu `status.message`?

---

# Boas práticas de integração

URL: https://api-docs.idcerberus.com/guides/boas-praticas-integracao
Fonte: guides/boas-praticas-integracao.mdx
Descrição: Recomendações para integrar a API idCerberus com segurança e estabilidade

# Boas práticas de integração

Use estas recomendações para reduzir falhas, evitar exposição de credenciais e
deixar a integração pronta para produção.

## Credenciais e token

| Prática | Motivo |
| --- | --- |
| Gere token no back-end | Evita expor `client` e `secret` |
| Não coloque `client` e `secret` no front-end | Usuários poderiam inspecionar as credenciais |
| Não versione credenciais no Git | Evita vazamento acidental |
| Renove o token quando expirar | O token tem validade limitada |
| Não logue o JWT completo | Token pode permitir chamadas protegidas |

## Ambientes

- Use HML para desenvolvimento e homologação.
- Use produção somente depois de validar o fluxo.
- Não misture token de HML com URL de produção.
- Não misture token de produção com URL de HML.

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

## Requests

- Sempre envie `Content-Type: application/json` em requests com body JSON.
- Sempre envie `Authorization: Bearer {jwt_token}` em chamadas protegidas.
- Valide campos obrigatórios antes de chamar a API.
- Envie CPF/CNPJ no formato esperado pelo seu fluxo.
- Use timeout nas chamadas HTTP.

## Retry

Use retry apenas quando fizer sentido.

| Situação | Retry? |
| --- | --- |
| Timeout | Sim, com limite |
| Falha temporária de rede | Sim, com limite |
| Token expirado | Gere novo token e repita |
| Payload inválido | Não |
| Serviço sem permissão | Não |
| CPF/CNPJ inválido | Não |

## Respostas

- Não use apenas o status HTTP para decidir sucesso de negócio.
- Leia também `status.code` e `status.message`.
- Trate `status.code` diferente de 200.
- Salve `externalId` quando ele for retornado.
- Lembre que resultado negativo não é necessariamente erro técnico.

Exemplo:

```js
if (body.status?.code !== 200) {
  throw new Error(body.status?.message || "Falha no processamento");
}

return body.result;
```

## Logs

Registre informações úteis para investigação, mas sem expor dados sensíveis.

| Pode logar | Evite logar |
| --- | --- |
| Endpoint chamado | `client` e `secret` |
| Código `service` | Token JWT completo |
| `status.code` | Documento completo sem necessidade |
| `status.message` | Imagens em base64 |
| `externalId` | Selfies e documentos |

Quando for necessário registrar CPF, CNPJ, telefone ou e-mail para investigação,
prefira mascarar parte do valor. Tokens, imagens, selfies e documentos em base64
não devem ser gravados em logs abertos.

## Produção

Antes de ir para produção, valide o fluxo em homologação, gere um token com as
credenciais do ambiente correto e confirme se a sua aplicação trata respostas de
sucesso, erro e timeout.

---

# Glossário

URL: https://api-docs.idcerberus.com/guides/glossario
Fonte: guides/glossario.mdx
Descrição: Termos comuns usados na documentação da API idCerberus

# Glossário

Esta página explica termos comuns usados nos guias e no API Reference.

| Termo | Significado |
| --- | --- |
| API | Forma de um sistema conversar com outro sistema por meio de requisições |
| Endpoint | URL específica que executa uma operação |
| Request | Chamada enviada para a API |
| Response | Resposta retornada pela API |
| Método HTTP | Tipo da operação, como `GET` ou `POST` |
| Header | Informação enviada junto da chamada, como autenticação ou tipo de conteúdo |
| Body | Conteúdo enviado no request, geralmente em JSON |
| JSON | Formato de dados usado nos exemplos da API |
| Base URL | Endereço inicial do ambiente, como HML ou produção |
| HML | Ambiente de homologação, usado para testes |
| Produção | Ambiente usado para consultas reais |
| Token | Código temporário usado para autenticar chamadas |
| JWT | Formato do token de autenticação retornado pela API |
| Bearer | Tipo de autenticação usado no header `Authorization` |
| `client` | Identificador da aplicação usado para gerar token |
| `secret` | Segredo da aplicação usado para gerar token |
| `service` | Campo que define qual produto será executado em `POST /api/service-api` |
| CPF | Documento de pessoa física |
| CNPJ | Documento de pessoa jurídica |
| `result` | Objeto com os dados retornados pelo serviço |
| `status.code` | Código técnico do processamento |
| `status.message` | Mensagem técnica do processamento |
| `externalId` | Identificador externo da consulta, quando retornado |
| OCR | Extração de dados de documentos por imagem |
| FaceMatch | Comparação facial entre duas imagens |
| Liveness | Validação de prova de vida |
| KYC | Processo de conhecimento e validação de cliente |
| PEP | Pessoa politicamente exposta |

## Exemplo prático

Neste request:

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

`service` informa qual produto será executado, e `cpf` informa qual pessoa será
consultada.

Neste header:

```txt
Authorization: Bearer {jwt_token}
```

`Authorization` é o header, `Bearer` é o tipo de autenticação e `{jwt_token}` é o
token gerado pela API.

---

# Autenticação

URL: https://api-docs.idcerberus.com/guides/autenticacao
Fonte: guides/autenticacao.mdx
Descrição: Gere tokens JWT e autentique chamadas protegidas da API idCerberus

# Autenticação

Use este fluxo para gerar o token JWT usado nas chamadas protegidas da API
idCerberus. A autenticação é o primeiro passo antes de consumir onboarding,
serviços de pessoa física, serviços de pessoa jurídica ou operações de customers.

As credenciais de acesso são compostas por `client` e `secret`, fornecidos
previamente pela React IT.

Caso você ainda não possua essas credenciais, entre em contato pelo e-mail
[contact@react-it.com](mailto:contact@react-it.com). Nossa equipe poderá orientar
o processo de criação da conta e liberação do acesso necessário para a
integração via API.

## Quando usar

Use esta página quando precisar:

- gerar um token de acesso para chamadas protegidas;
- entender como enviar o header `Authorization`;
- identificar o tempo de expiração do token;
- preparar a autenticação antes de testar os endpoints da API Reference.

## Fluxo recomendado

1. Receba as credenciais `client` e `secret`.
2. Gere um token em `POST /api/token-generate`.
3. Guarde o valor de `access_token` no back-end da sua aplicação.
4. Envie o token no header `Authorization`.
5. Gere um novo token quando o anterior expirar.

## Ambientes

O endpoint de autenticação existe em homologação e produção. O payload é o mesmo;
troque apenas a URL base conforme o ambiente.

Na prática, o `curl` de produção é igual ao de HML; a diferença é a URL
informada no `--location`.

| Ambiente | Endpoint |
| --- | --- |
| Homologação | `https://backoffice-hml.idcerberus.com/api/token-generate` |
| Produção | `https://backoffice.idcerberus.com/api/token-generate` |

## Gerar token

Gere um token para acessar os serviços da API enviando o `client` e o `secret`.

```http
POST /api/token-generate
```

```json
{
  "client": "{client}",
  "secret": "{secret}"
}
```

O retorno contém o token de acesso e o tempo de expiração.

| Campo | Descrição |
| --- | --- |
| `access_token` | Token JWT |
| `expires_in` | Tempo de expiração do token |

## Como testar

Você pode gerar o token pelo Postman, pelo PowerShell/CMD no Windows ou pelo
terminal do macOS/Linux.

### No Postman

1. Crie uma requisição `POST`.
2. Use a URL `https://backoffice-hml.idcerberus.com/api/token-generate`.
3. Na aba **Headers**, adicione `Content-Type` com valor `application/json`.
4. Na aba **Body**, selecione **raw** e depois **JSON**.
5. Cole o body com `client` e `secret`.
6. Clique em **Send**.
7. Copie o campo `access_token` retornado.

### No Windows

No PowerShell, use `curl.exe` para evitar conflito com comandos internos:

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

No CMD, use `^` para quebrar linhas:

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

### No macOS ou Linux

Use o comando `curl` no terminal:

Exemplo com `curl` em HML:

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

Exemplo com `curl` em produção:

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

Exemplo de resposta:

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

## Usar token

Envie o token retornado no header `Authorization` das próximas requisições
protegidas.

```http
Authorization: Bearer {access_token}
```

Exemplo em uma chamada de serviço em HML:

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

Exemplo em uma chamada de serviço em produção:

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

## Boas práticas

- Mantenha `client` e `secret` apenas no back-end da aplicação.
- Não exponha credenciais em aplicativos mobile, front-end ou repositórios.
- Renove o token quando `expires_in` indicar expiração.
- Trate respostas de autenticação inválida regenerando o token antes de repetir a chamada.

Para detalhes técnicos do endpoint, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api).

---

# Primeira consulta CPF

URL: https://api-docs.idcerberus.com/guides/primeira-consulta-cpf
Fonte: guides/primeira-consulta-cpf.mdx
Descrição: Execute uma consulta simples de pessoa física do início ao fim

# Primeira consulta CPF

Este guia mostra, passo a passo, como executar uma primeira consulta de pessoa
física usando o endpoint `POST /api/service-api`.

O exemplo usa o serviço `SERVICE_PERSON_DATA_ENRICHMENT`, que consulta dados
cadastrais de um CPF.

## O que você vai fazer

1. Escolher o ambiente.
2. Gerar um token.
3. Copiar o `access_token`.
4. Executar uma consulta de CPF.
5. Ler `result` e `status`.

## 1. Escolha o ambiente

Use homologação para testes:

```txt
https://backoffice-hml.idcerberus.com
```

Use produção somente quando a integração já estiver validada:

```txt
https://backoffice.idcerberus.com
```

## 2. Gere o token

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

Resposta esperada:

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

Copie o valor de `access_token`.

## 3. Execute a consulta

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

Substitua:

| Valor | O que colocar |
| --- | --- |
| `{jwt_token}` | Token gerado no passo anterior |
| `cpf` | CPF que será consultado |

## 4. Entenda o body

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

| Campo | Descrição |
| --- | --- |
| `service` | Define o produto que será executado |
| `cpf` | Documento da pessoa física consultada |

## 5. Leia o retorno

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

| Campo | Como usar |
| --- | --- |
| `result` | Dados retornados pela consulta |
| `status.code` | Código técnico do processamento |
| `status.message` | Mensagem técnica do processamento |

## 6. Próximos serviços comuns

| Necessidade | Serviço |
| --- | --- |
| Consultar status do CPF na Receita Federal | `SERVICE_RFB_PF` |
| Validar CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` |
| Validar CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` |
| Consultar PEP | `SERVICE_PEP` |
| Executar OCR de documento | `SERVICE_OCR` |
| Comparar faces | `SERVICE_FACE_MATCH` |

Para ver todos os serviços de pessoa física, consulte
[Serviços de Pessoa Física](/guides/servicos-pessoa-fisica).

---

# Primeira consulta CNPJ

URL: https://api-docs.idcerberus.com/guides/primeira-consulta-cnpj
Fonte: guides/primeira-consulta-cnpj.mdx
Descrição: Execute uma consulta simples de pessoa jurídica do início ao fim

# Primeira consulta CNPJ

Este guia mostra como executar uma primeira consulta de pessoa jurídica usando o
endpoint `POST /api/service-api`.

O exemplo usa o serviço `SERVICE_CORPORATE_DATA_ENRICHMENT`, que retorna dados
cadastrais de uma empresa.

## O que você vai fazer

1. Escolher o ambiente.
2. Gerar um token.
3. Copiar o `access_token`.
4. Executar uma consulta de CNPJ.
5. Ler `result` e `status`.

## 1. Escolha o ambiente

Homologação:

```txt
https://backoffice-hml.idcerberus.com
```

Produção:

```txt
https://backoffice.idcerberus.com
```

## 2. Gere o token

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

Resposta esperada:

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

## 3. Execute a consulta

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

Substitua:

| Valor | O que colocar |
| --- | --- |
| `{jwt_token}` | Token gerado no passo anterior |
| `cnpj` | CNPJ que será consultado |

## 4. Entenda o body

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

| Campo | Descrição |
| --- | --- |
| `service` | Define o produto que será executado |
| `cnpj` | Documento da pessoa jurídica consultada |

## 5. Leia o retorno

```json
{
  "result": {
    "cnpj": "30108283000150",
    "status": "ATIVA",
    "name": "REACT IT SOLUCOES EM TECNOLOGIA LTDA",
    "fantasyName": "REACT IT SOLUTIONS"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## 6. Próximos serviços comuns

| Necessidade | Serviço |
| --- | --- |
| Consultar status do CNPJ na Receita Federal | `SERVICE_RFB_PJ` |
| Consultar SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` |
| Consultar relacionamentos da empresa | `SERVICE_COMPANY_RELATIONSHIP` |
| Consultar sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` |
| Consultar KYC dos sócios | `SERVICE_COMPANY_KYC_OWNERS` |
| Consultar débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` |

Para ver todos os serviços de pessoa jurídica, consulte
[Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica).

---

# Onboarding via SDK

URL: https://api-docs.idcerberus.com/guides/onboarding-sdk
Fonte: guides/onboarding-sdk.mdx
Descrição: Gere TokenOnboarding, acompanhe o status do cadastro e baixe o relatório final

# Onboarding via SDK

Use este fluxo quando a captura dos dados do usuário acontecer pelo SDK
idCerberus. O back-end da sua empresa gera um `tokenOnboarding`, entrega esse
token ao aplicativo integrado ao SDK e depois consulta o resultado processado
pelo backoffice.

O `tokenOnboarding` identifica o cadastro durante todo o ciclo: criação,
execução no SDK, processamento, consulta de resultado e download do relatório em
PDF.

## Quando usar

Use esta integração quando precisar:

- iniciar um fluxo de onboarding em aplicativo mobile ou experiência web
  integrada ao SDK;
- enviar documentos ou dados iniciais para apoiar o cadastro;
- consultar status, campos capturados e serviços executados;
- baixar o relatório final em PDF para auditoria ou armazenamento.

## Fluxo de integração

1. Gere um token de API em [Autenticação](/guides/autenticacao).
2. Gere um `tokenOnboarding` para o usuário.
3. Envie o `tokenOnboarding` para o aplicativo integrado ao SDK.
4. O usuário realiza o cadastro no fluxo de onboarding.
5. Consulte o resultado usando o mesmo `tokenOnboarding`.
6. Se necessário, baixe o PDF do relatório do onboarding.

## Endpoints do fluxo

| Etapa | Endpoint | Objetivo |
| --- | --- | --- |
| Gerar token de API | `POST /api/token-generate` | Autenticar a aplicação |
| Gerar TokenOnboarding | `POST /api/token-history-onboarding` | Criar o identificador do cadastro |
| Consultar resultado | `GET /api/onboarding/report/{tokenOnboarding}` | Obter status, campos e serviços processados |
| Baixar relatório | `GET /api/history-onboarding-report/{tokenOnboarding}` | Obter o PDF final do onboarding |

## Ambientes

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

Nos exemplos abaixo, `{base_url}` representa a URL base do ambiente escolhido.

## Gerar TokenOnboarding

Gera um novo `tokenOnboarding` para identificar o cadastro do usuário no fluxo
do SDK. Esse token será usado depois para consultar o resultado processado pelo
backoffice.

```http
POST /api/token-history-onboarding
```

Endpoint completo:

```txt
{base_url}/api/token-history-onboarding
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Exemplo de requisição:

```json
{
  "document": "cpf",
  "cpf": "cpf",
  "cnpj": "cnpj",
  "name": "name",
  "documentFiles": [
    {
      "documentFileType": "OTHER",
      "document": "data:image/jpeg;base64",
      "documentUrl": "url"
    }
  ]
}
```

Campos principais:

| Campo | Descrição |
| --- | --- |
| `document` | CPF ou CNPJ usado no onboarding |
| `cpf` | CPF do usuário, quando aplicável |
| `cnpj` | CNPJ relacionado, quando aplicável |
| `name` | Nome do usuário que fará o KYC |
| `documentFiles` | Lista de documentos enviados para o cadastro |
| `documentFiles.documentFileType` | Tipo do documento enviado |
| `documentFiles.document` | Arquivo em base64 |
| `documentFiles.documentUrl` | URL do arquivo a ser enviado |

Tipos de documento aceitos em `documentFiles.documentFileType`:

| Valor | Descrição |
| --- | --- |
| `RG_FRONT` | RG frente |
| `RG_BACK` | RG verso |
| `CNH` | Carteira Nacional de Habilitação |
| `SELFIE` | Selfie |
| `SELFIE_3D` | Selfie 3D |
| `OAB_FRONT` | Carteira OAB frente |
| `OAB_BACK` | Carteira OAB verso |
| `OTHER` | Outros |
| `OTHER_SINGLE_FILE` | Outros, arquivo único |

Exemplo de resposta:

```json
{
  "tokenOnboarding": "56950dae-2d19-4092-a918-a612b3ca8f68",
  "dateHourProcess": "2023-02-17T16:49:41.577364Z"
}
```

| Campo | Descrição |
| --- | --- |
| `tokenOnboarding` | UUID do onboarding usado nas próximas consultas |
| `dateHourProcess` | Data e hora de criação do token |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/token-history-onboarding' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "document": "cpf",
    "cpf": "cpf",
    "cnpj": "cnpj",
    "name": "name",
    "documentFiles": [
      {
        "documentFileType": "OTHER",
        "document": "data:image/jpeg;base64",
        "documentUrl": "url"
      }
    ]
  }'
```

## Consultar resultado

Retorna o status e os resultados de um onboarding. Para consultar, informe o
`tokenOnboarding` que foi entregue ao SDK.

```http
GET /api/onboarding/report/{tokenOnboarding}
```

Endpoint completo:

```txt
{base_url}/api/onboarding/report/{tokenOnboarding}
```

Autorização:

```http
Authorization: Bearer {jwt_token}
```

Campo de entrada:

| Campo | Descrição |
| --- | --- |
| `tokenOnboarding` | UUID do onboarding retornado ao SDK |

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `tokenOnboarding` | UUID do onboarding usado para a consulta |
| `createdDate` | Data e hora de criação do onboarding |
| `numberSteps` | Número de etapas configuradas para o cadastro |
| `status` | Status do onboarding: `APPROVED`, `IN_PROCESS` ou `REFUSED` |
| `result` | Resultado do processamento: `AUT_APPROVED`, `IN_PROCESS` ou `REFUSED` |
| `fields` | Campos capturados durante o cadastro |
| `services` | Serviços executados durante o onboarding |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/onboarding/report/' \
  --header 'Authorization: Bearer {jwt_token}'
```

Exemplo de resposta resumido:

```json
{
  "tokenOnboarding": "bb6adc72-0132-4b27-a723-98fe9f20cb81",
  "createdDate": "2022-06-15T19:02:04.877688Z",
  "numberSteps": 4,
  "status": "APPROVED",
  "result": "AUT_APPROVED",
  "fields": [
    {
      "field": "selfie_liveness_3d",
      "name": "Selfie Liveness 3D",
      "step": "1",
      "value": "https://bucket-onboarding.s3.amazonaws.com/arquivo"
    },
    {
      "field": "button_cnh",
      "name": "CNH - Carteira Nacional de Habilitação",
      "step": "2"
    }
  ],
  "services": [
    {
      "serviceName": "service_liveness_ft",
      "createdDate": "2022-06-15T19:02:06.233020Z",
      "status": "APPROVED",
      "statusMessage": "USER PASSED THE LIVENESS CHALLENGE",
      "fields": [],
      "rules": []
    }
  ]
}
```

### Campos capturados

O array `fields` retorna os dados capturados durante o cadastro.

| Campo | Descrição |
| --- | --- |
| `fields.field` | Alias do campo |
| `fields.name` | Nome do campo |
| `fields.step` | Etapa em que o campo foi capturado |
| `fields.value` | Valor capturado |

Exemplo:

```json
{
  "field": "cnh_image",
  "name": "CNH",
  "step": "3.1",
  "value": "https://bucket-onboarding.s3.amazonaws.com/arquivo"
}
```

### Serviços executados

O array `services` retorna os serviços processados durante o onboarding, como
OCR, validação na Receita Federal, PEP, FaceMatch e Liveness.

| Campo | Descrição |
| --- | --- |
| `services.serviceName` | Alias do serviço executado |
| `services.createdDate` | Data e hora de execução do serviço |
| `services.status` | Status do serviço: `APPROVED`, `IN_PROCESS` ou `REFUSED` |
| `services.statusMessage` | Resultado ou mensagem do processamento |
| `services.fields` | Campos extraídos pelo serviço |
| `services.rules` | Regras avaliadas durante o processamento |

Exemplo:

```json
{
  "serviceName": "SERVICE_FACE_MATCH",
  "createdDate": "2022-06-15T19:04:10.963326Z",
  "status": "APPROVED",
  "statusMessage": "SIMILARITY SCORE: 99.97%",
  "fields": [],
  "rules": []
}
```

### Regras de processamento

Alguns serviços retornam regras avaliadas no processamento. Elas ajudam a
entender por que o onboarding foi aprovado, recusado ou ficou em processamento.

Exemplo:

```json
{
  "name": "situation_cpf_rfb",
  "value": "REGULAR"
}
```

## Baixar relatório em PDF

Realiza o download do relatório do onboarding em PDF.

```http
GET /api/history-onboarding-report/{tokenOnboarding}
```

Endpoint completo:

```txt
{base_url}/api/history-onboarding-report/{tokenOnboarding}
```

Autorização:

```http
Authorization: Bearer {jwt_token}
```

Campo de entrada:

| Campo | Descrição |
| --- | --- |
| `tokenOnboarding` | UUID do onboarding retornado ao SDK |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/history-onboarding-report/{tokenOnboarding}' \
  --header 'Authorization: Bearer {jwt_token}'
```

Esse endpoint não retorna um body JSON. Use-o quando precisar armazenar ou
apresentar o relatório final do processo de onboarding em PDF.

## Boas práticas

- Gere o `tokenOnboarding` no back-end, nunca diretamente no aplicativo.
- Entregue ao SDK apenas o token necessário para iniciar o fluxo.
- Use o mesmo `tokenOnboarding` para consultar resultado e baixar relatório.
- Trate `IN_PROCESS` como estado intermediário e consulte novamente depois.
- Armazene o relatório PDF somente quando houver necessidade operacional,
  regulatória ou de auditoria.

Para detalhes técnicos dos endpoints, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api).

---

# Escolha o serviço certo

URL: https://api-docs.idcerberus.com/guides/escolha-o-servico-certo
Fonte: guides/escolha-o-servico-certo.mdx
Descrição: Encontre os services idCerberus mais indicados para cada caso de uso

# Escolha o serviço certo

Use esta página para sair de uma necessidade de negócio e chegar nos códigos
`service` que devem ser usados em `POST /api/service-api`.

Termos úteis para busca: CPF Receita, RFB PF, CNPJ Receita, RFB PJ, KYC PF, KYC
PJ, OCR, extração de documento, FaceMatch, comparação facial, Liveness, prova de
vida, score de fraude, risco financeiro, dados eleitorais, débitos ativos,
protestos, sócios e compliance.

> Info:
  Esta página é um guia de decisão por necessidade, não a lista completa de
  services. O catálogo técnico completo vive em
  [Serviços de Pessoa Física](/guides/servicos-pessoa-fisica) e
  [Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica).

## Como decidir

1. Identifique se a consulta é de pessoa física, pessoa jurídica, onboarding ou customer.
2. Confirme o documento principal: `cpf`, `cnpj`, `phone`, imagens ou `tokenOnboarding`.
3. Escolha o service pela necessidade de negócio, não pelo nome técnico.
4. Copie o nome exato pelo [Índice de services](/guides/indice-de-services).
5. Monte o request em homologação.
6. Leia `status.code`, `status.message` e `result` antes de liberar em produção.

> Nota:
Se a pessoa que vai integrar não conhece a API, comece pelos exemplos de CPF,
CNPJ, FaceMatch ou documentoscopia em [Exemplos por ambiente](/guides/exemplos-por-ambiente).

## Atalhos por necessidade

| Se você quer... | Use este service |
| --- | --- |
| Consultar dados cadastrais de CPF | `SERVICE_PERSON_DATA_ENRICHMENT` |
| Verificar CPF na Receita Federal | `SERVICE_RFB_PF` |
| Verificar CPF na Receita Federal em modo on-demand | `SERVICE_RFB_PF_ON_DEMAND` |
| Consolidar modelagem de dados da pessoa | `SERVICE_PERSON_DATA_MODELING` |
| Gerar resumo analítico de pessoa com IA | `SERVICE_PERSON_AI_PROMPT` |
| Extrair dados de documento | `SERVICE_OCR` |
| Comparar selfie e documento | `SERVICE_FACE_MATCH` |
| Validar CNH no DataValid | `SERVICE_DATAVALID_CNH` |
| Consultar score biométrico | `SERVICE_DATAVALID_CNH` |
| Consultar PEP | `SERVICE_PEP` |
| Consultar KYC/compliance de pessoa física | `SERVICE_PERSON_KYC` |
| Consultar risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` |
| Consultar processos de pessoa física | `SERVICE_JURIDICAL_PROCESSES` |
| Consultar dados financeiros e endereços da pessoa | `SERVICE_PF_FINANCIAL_AND_ADDRESS` |
| Consultar histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` |
| Avaliar propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` |
| Validar CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` |
| Validar CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` |
| Consultar histórico de telefones | `SERVICE_PHONE_HISTORY` |
| Consultar histórico de e-mails | `SERVICE_EMAILS_EXTENDED` |
| Consultar pessoas relacionadas | `SERVICE_RELATED_PEOPLE` |
| Consultar dados cadastrais de CNPJ | `SERVICE_CORPORATE_DATA_ENRICHMENT` |
| Verificar CNPJ na Receita Federal | `SERVICE_RFB_PJ` |
| Verificar CNPJ na Receita Federal em modo on-demand | `SERVICE_RFB_PJ_ON_DEMAND` |
| Consultar sócios ou vínculos da empresa | `SERVICE_COMPANY_RELATIONSHIP`, `SERVICE_FIRST_LEVEL_PARTNER` |
| Consultar débitos de empresa | `SERVICE_ACTIVE_DEBT_PJ` |
| Consultar KYC dos sócios | `SERVICE_COMPANY_KYC_OWNERS` |
| Consultar protestos de empresa | `SERVICE_PROTEST_PJ` |

## Validar identidade de uma pessoa

| Necessidade | Services indicados | Quando usar |
| --- | --- | --- |
| Confirmar dados cadastrais do CPF | `SERVICE_PERSON_DATA_ENRICHMENT`, `SERVICE_RFB_PF` | Validar nome, nascimento, situação cadastral e origem Receita Federal |
| Atualizar dados do CPF em consulta on-demand | `SERVICE_RFB_PF_ON_DEMAND` | Buscar o dado cadastral no momento da requisição |
| Extrair dados de documento | `SERVICE_OCR` | Ler RG/CIN, CNH, OAB, RNE/CRNM, passaporte e identificação automática |
| Comparar selfie e documento | `SERVICE_FACE_MATCH` | Validar se duas imagens pertencem à mesma pessoa |
| Consultar biometria governamental | `SERVICE_DATAVALID_CNH` | Obter score de similaridade com bases governamentais |
| Validar CNH no DataValid | `SERVICE_DATAVALID_CNH` | Apoiar validação documental com integração validação documental |
| Fazer análise documental completa | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | Extrair dados e combinar documento com selfie em um fluxo único |

## Montar um onboarding completo

| Etapa | Services ou endpoints |
| --- | --- |
| Criar jornada via SDK | `POST /api/token-history-onboarding` |
| Capturar documento e selfie | SDK ou Cliente Web |
| Consultar resultado | `GET /api/onboarding/report/{tokenOnboarding}` |
| Baixar evidências | `GET /api/history-onboarding-report/{tokenOnboarding}` |
| Complementar com consultas avulsas | `SERVICE_RFB_PF`, `SERVICE_PEP`, `SERVICE_FACE_MATCH`, `SERVICE_DATAVALID_CNH` |

## Analisar risco e compliance de pessoa física

| Necessidade | Services indicados |
| --- | --- |
| Pessoa politicamente exposta | `SERVICE_PEP` |
| KYC/compliance consolidado | `SERVICE_PERSON_KYC` |
| Score de fraude | `SERVICE_FRAUD_RISK_SCORE` |
| Risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` |
| Score de inadimplência | `SERVICE_DEFAULT_RISK_SCORE` |
| Propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` |
| Débitos com governo | `SERVICE_ACTIVE_DEBT_PF`, `SERVICE_ACTIVE_DEBT_PF` |
| Processos e certidões | `SERVICE_JURIDICAL_PROCESSES`, `SERVICE_NOTHING_RECORD_LAWSUITS`, `SERVICE_CRIMINAL_RECORD_FEDERAL`, `SERVICE_CRIMINAL_RECORD_CIVIL` |
| Protestos | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` |
| Mandado de prisão | `SERVICE_ARREST_WARRANT` |
| Score ou dados de bureau de crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON`, `SERVICE_BOAVISTA_ONE_SCORE_PERSON`, `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`, `SERVICE_QUOD_CREDIT_RISK_PERSON` |

## Validar contato e residência

| Necessidade | Services indicados |
| --- | --- |
| Validar e-mail | `SERVICE_EMAIL_VALIDATION` |
| Confirmar CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` |
| Buscar pessoa por telefone | `SERVICE_CONFIRM_PHONE` |
| Confirmar CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` |
| Consultar endereços | `SERVICE_ADDRESS` |
| E-mails de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` |
| Telefones de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` |
| Endereços de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` |

## Analisar histórico político e eleitoral

| Necessidade | Services indicados |
| --- | --- |
| Candidaturas e eleições | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` |
| Doações eleitorais PF | `SERVICE_ELECTORAL_DONORS_CPF` |
| Envolvimento político consolidado | `SERVICE_POLITICAL_INVOLVEMENT` |
| Histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` |
| Prestadores de serviço eleitorais PF | `SERVICE_ELECTORAL_PROVIDERS_CPF` |
| Local de votação no TSE | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` |

## Analisar uma empresa

| Necessidade | Services indicados |
| --- | --- |
| Dados cadastrais de CNPJ | `SERVICE_CORPORATE_DATA_ENRICHMENT`, `SERVICE_RFB_PJ` |
| Dados cadastrais de CNPJ on-demand | `SERVICE_RFB_PJ_ON_DEMAND` |
| Inscrição estadual e operação | `SERVICE_SINTEGRA_CONSULTATION` |
| Sócios e relacionamentos | `SERVICE_COMPANY_RELATIONSHIP`, `SERVICE_COMPANY_RFB_OWNERS`, `SERVICE_FIRST_LEVEL_PARTNER` |
| Processos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` |
| KYC e compliance dos sócios | `SERVICE_COMPANY_KYC_OWNERS` |
| Débitos, protestos e regularidade | `SERVICE_ACTIVE_DEBT_PJ`, `SERVICE_PROTEST_PJ`, `SERVICE_DAS_MEI` |
| Beneficiários finais e participação societária | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS`, `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` |
| Score de crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY`, `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` |
| Certidões negativas federais e estaduais | `SERVICE_PGFN_COMPANY`, `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`, `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`, `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` |
| Cota de PCD e Simples Nacional | `SERVICE_PCD_COMPANY`, `SERVICE_SIMPLES_COMPANY` |
| KYC do grupo econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` |
| Projetos públicos e obras civis | `SERVICE_PUBLIC_PROJECTS`, `SERVICE_CIVIL_CONSTRUCTION` |
| Doações eleitorais da empresa | `SERVICE_ELECTORAL_DONORS_CNPJ` |
| Doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` |
| Fornecedores eleitorais PJ | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` |
| Compliance de apostas | `SERVICE_COMPLIANCE_BET_PJ` |

## Combinações comuns

| Fluxo | Combinação recomendada |
| --- | --- |
| Cadastro simples de CPF | `SERVICE_RFB_PF` + `SERVICE_PERSON_DATA_ENRICHMENT` |
| Onboarding com documento | `SERVICE_OCR` + `SERVICE_FACE_MATCH` |
| KYC pessoa física | `SERVICE_PEP` + certidões + débitos + score de risco |
| Cadastro de empresa | `SERVICE_RFB_PJ` + `SERVICE_CORPORATE_DATA_ENRICHMENT` + `SERVICE_SINTEGRA_CONSULTATION` |
| KYC empresarial | dados PJ + sócios + KYC dos sócios + débitos + protestos |

## Próximo passo

Depois de escolher o service, abra o [API Reference](/api-reference/serviços--pessoas/executar-serviço-de-dados-risco-ou-compliance) ou use os arquivos prontos em [Exemplos por ambiente](/guides/exemplos-por-ambiente).

---

# Receitas prontas

URL: https://api-docs.idcerberus.com/guides/receitas-prontas
Fonte: guides/receitas-prontas.mdx
Descrição: Fluxos práticos para testar CPF, CNPJ, OCR, Face Index, risco e score pela Service API

# Receitas prontas

Use esta página quando quiser testar um fluxo comum sem procurar service por service.

Todas as consultas abaixo usam:

```txt
POST /api/service-api
Authorization: Bearer {jwt_token}
Content-Type: application/json
```


    Dados cadastrais e enriquecimento de pessoa física.


    Dados cadastrais e status de empresa.


    CNH, RG, cartão CNPJ e comprovante.


    Busca de uma selfie na base facial.


    Score, rating e sinais de risco de empresa.


    Consulta de score de crédito para CPF.


## Antes de testar

1. Gere token no mesmo ambiente da chamada.
2. Confirme se o produto tem o service ativo e habilitado para API.
3. Use massa válida de HML.
4. Para OCR, use base64 puro, sem prefixo `data:image/...;base64,`.
5. Leia `result`, `status.message`, `onboardingStatus` e `externalId`.

## Testar CPF

Use quando quiser validar uma consulta simples de pessoa física.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_PERSON_DATA_ENRICHMENT` |
| Campo obrigatório | `cpf` |
| Exemplo curl | [`service-api-cpf.hml.curl`](/examples/service-api-cpf.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "00000000000"
}
```

Retorno esperado:

```json
{
  "result": {
    "cpf": "00000000000",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "status": "REGULAR"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "externalId": "..."
}
```

Erro comum:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Don't have access to the service"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}
```

## Testar CNPJ

Use quando quiser validar dados cadastrais de uma empresa.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_REGISTRATION_DATA_CNPJ` |
| Campo obrigatório | `cnpj` |
| Exemplo curl | [`service-api-cnpj.hml.curl`](/examples/service-api-cnpj.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "00000000000000"
}
```

Retorno esperado:

```json
{
  "result": {
    "cnpj": "00000000000000",
    "companyName": "EMPRESA FICTICIA LTDA",
    "tradeName": "EMPRESA FICTICIA",
    "registrationStatus": "ATIVA",
    "openingDate": "2020-01-01"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "externalId": "..."
}
```

Erro comum: CNPJ sem dados na massa de HML pode retornar `result` vazio ou mensagem de documento não encontrado.

## Testar OCR CNH

Use quando tiver uma imagem nítida da CNH inteira.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_OCR` |
| Campos obrigatórios | `documentType`, `image1` |
| Exemplo curl | [`service-api-ocr-cnh.hml.curl`](/examples/service-api-ocr-cnh.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_OCR",
  "documentType": "CNH",
  "image1": "BASE64_DA_CNH"
}
```

Retorno esperado:

```json
{
  "result": {
    "cpf": "00000000000",
    "docType": "CNH",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "cnhCategory": "B",
    "cnhNumber": "00000000000",
    "validDate": "2030-01-01"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: imagem ilegível, documento cortado ou `documentType` diferente do documento enviado.

## Testar OCR RG

Use quando tiver frente e verso do RG.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_OCR` |
| Campos obrigatórios | `documentType`, `image1`, `image2` |
| Exemplo curl | [`service-api-ocr-rg.hml.curl`](/examples/service-api-ocr-rg.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_OCR",
  "documentType": "RG",
  "image1": "BASE64_DA_FRENTE",
  "image2": "BASE64_DO_VERSO"
}
```

Retorno esperado:

```json
{
  "result": {
    "cpf": "00000000000",
    "docType": "RG",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "rgIssuer": "SSP/UF",
    "rgIssueDate": "2024-01-01"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum:

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Imagem do verso do documento não encontrada"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}
```

## Testar OCR cartão CNPJ

Use quando tiver uma imagem legível do cartão CNPJ.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_OCR_CNPJ_CARD` |
| Campo obrigatório | `image1` |
| Exemplo curl | [`service-api-ocr-cnpj-card.hml.curl`](/examples/service-api-ocr-cnpj-card.hml.curl) |

Payload:

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

Retorno esperado:

```json
{
  "result": {
    "cnpj": "00000000000000",
    "docType": "CNPJ_CARD",
    "genericOcr": "texto extraído do cartão CNPJ"
  },
  "status": {
    "code": 200,
    "message": "Cartão CNPJ processado com sucesso!"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: imagem não contém CNPJ válido ou não é cartão CNPJ.

## Testar OCR comprovante

Use quando tiver conta, fatura ou comprovante aceito com endereço visível.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_OCR_PROOF_OF_ADDRESS` |
| Campo obrigatório | `image1` |
| Exemplo curl | [`service-api-ocr-proof-of-address.hml.curl`](/examples/service-api-ocr-proof-of-address.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "BASE64_DO_COMPROVANTE"
}
```

Retorno esperado:

```json
{
  "result": {
    "genericOcr": "texto extraído do comprovante",
    "fullName": "NOME FICTICIO",
    "fullAddress": "RUA EXEMPLO, 100, CENTRO, CIDADE - UF",
    "docType": "Conta de consumo",
    "dueDate": "2026-01-10",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Comprovante de endereço obtido com sucesso!"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: imagem de documento pessoal, nota fiscal sem endereço de residência ou comprovante com baixa qualidade.

## Testar Face Index

Use quando quiser buscar uma selfie na base facial.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_FACE_INDEX` |
| Campos obrigatórios | `image1` |
| Exemplo curl | [`service-api-face-index.hml.curl`](/examples/service-api-face-index.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_FACE_INDEX",
  "image1": "BASE64_DA_SELFIE"
}
```

Retorno esperado quando a face é encontrada:

```json
{
  "result": {
    "cpf": "00000000000",
    "similarity": 99.9,
    "faceFound": true
  },
  "status": {
    "code": 200,
    "message": "Face encontrada na base"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: usar foto de RG, CNH ou print de documento em vez de selfie real.

## Testar risco de crédito PJ

Use quando quiser consultar score, rating e sinais de risco da empresa.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_CREDIT_RISK_COMPANY` |
| Campo obrigatório | `cnpj` |
| Exemplo curl | [`service-api-credit-risk-company.hml.curl`](/examples/service-api-credit-risk-company.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_CREDIT_RISK_COMPANY",
  "cnpj": "00000000000000"
}
```

Retorno esperado:

```json
{
  "result": {
    "cnpj": "00000000000000",
    "creditRisk": {
      "status": "ACTIVE",
      "score": "750",
      "rating": "A",
      "expectedDefault": "LOW",
      "legalProcess": "NOT_FOUND"
    }
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: massa de HML sem score/rating disponível pode retornar menos campos dentro de `result`.

## Testar score de crédito PF

Use quando quiser consultar score de crédito por CPF.

| Item | Valor |
| --- | --- |
| Service | `SERVICE_CREDIT_SCORE` |
| Campo obrigatório | `cpf` |
| Exemplo curl | [`service-api-credit-score.hml.curl`](/examples/service-api-credit-score.hml.curl) |

Payload:

```json
{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "00000000000"
}
```

Retorno esperado:

```json
{
  "result": {
    "cpf": "00000000000",
    "score": "650",
    "riskLevel": "MEDIUM",
    "message": "Score consultado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

Erro comum: falha de processamento externo ou CPF sem retorno na massa de teste.

## Como adaptar uma receita

1. Troque apenas o `service` e os campos obrigatórios.
2. Mantenha o header `Authorization: Bearer {jwt_token}`.
3. Use HML para validar payload e massa.
4. Não trate campo ausente como erro automaticamente.
5. Guarde `externalId` quando precisar investigar.

---

# Exemplos por ambiente

URL: https://api-docs.idcerberus.com/guides/exemplos-por-ambiente
Fonte: guides/exemplos-por-ambiente.mdx
Descrição: Copie chamadas equivalentes para homologação e produção sem trocar parâmetros por engano

# Exemplos por ambiente

Use esta página quando precisar conferir rapidamente a mesma chamada em
homologação e produção. A estrutura do request é a mesma; o que muda é a URL
base.

> Atencao:
Use credenciais, token e base URL do mesmo ambiente. Token de homologação não
deve ser usado em produção, e token de produção não deve ser usado em
homologação.

## URLs base

| Ambiente | Base URL | Quando usar |
| --- | --- | --- |
| Homologação | `https://backoffice-hml.idcerberus.com` | Testes, validação de payload e homologação da integração |
| Produção | `https://backoffice.idcerberus.com` | Operação real, com credenciais produtivas |

## Gerar token

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

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

## Consulta de CPF

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'
```

## Consulta de CNPJ

```bash
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"
}'
```

```bash
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"
}'
```

## Arquivos prontos

Alguns exemplos também são publicados como arquivos `.curl`:

| Arquivo | Uso |
| --- | --- |
| [`auth.hml.curl`](https://api-docs.idcerberus.com/examples/auth.hml.curl) | Gerar token em homologação |
| [`auth.prod.curl`](https://api-docs.idcerberus.com/examples/auth.prod.curl) | Gerar token em produção |
| [`service-api-cpf.hml.curl`](https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl) | Consultar CPF em homologação |
| [`service-api-cpf.prod.curl`](https://api-docs.idcerberus.com/examples/service-api-cpf.prod.curl) | Consultar CPF em produção |
| [`service-api-cnpj.hml.curl`](https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl) | Consultar CNPJ em homologação |
| [`service-api-cnpj.prod.curl`](https://api-docs.idcerberus.com/examples/service-api-cnpj.prod.curl) | Consultar CNPJ em produção |
| [`facematch.hml.curl`](https://api-docs.idcerberus.com/examples/facematch.hml.curl) | Executar FaceMatch em homologação |
| [`documentoscopia.hml.curl`](https://api-docs.idcerberus.com/examples/documentoscopia.hml.curl) | Executar documentoscopia em homologação |

---

# Exemplos por linguagem

URL: https://api-docs.idcerberus.com/guides/exemplos-por-linguagem
Fonte: guides/exemplos-por-linguagem.mdx
Descrição: Exemplos de integração com curl, Node.js, Python e C#

# Exemplos por linguagem

Os exemplos abaixo seguem o mesmo fluxo:

1. Gerar token em `POST /api/token-generate`.
2. Copiar o `access_token`.
3. Chamar `POST /api/service-api`.
4. Ler `result` e `status`.

O serviço usado nos exemplos é `SERVICE_PERSON_DATA_ENRICHMENT`, mas você pode
trocar o campo `service` e os demais parâmetros conforme o produto desejado.

## Ambientes

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

## cURL em macOS ou Linux

Este exemplo usa `jq` para extrair o token automaticamente.

```bash
BASE_URL="https://backoffice-hml.idcerberus.com"

TOKEN=$(curl --silent --location "${BASE_URL}/api/token-generate" \
  --header 'Content-Type: application/json' \
  --data '{
    "client": "{client}",
    "secret": "{secret}"
  }' | jq -r '.access_token')

curl --location "${BASE_URL}/api/service-api" \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'
```

Se não tiver `jq`, gere o token em um primeiro comando, copie `access_token` e
use no segundo comando.

## cURL no Windows PowerShell

No PowerShell, use `curl.exe`.

```powershell
$baseUrl = "https://backoffice-hml.idcerberus.com"

$tokenResponse = curl.exe --silent --location "$baseUrl/api/token-generate" `
  --header "Content-Type: application/json" `
  --data "{\"client\":\"{client}\",\"secret\":\"{secret}\"}"

$token = ($tokenResponse | ConvertFrom-Json).access_token

curl.exe --location "$baseUrl/api/service-api" `
  --header "Authorization: Bearer $token" `
  --header "Content-Type: application/json" `
  --data "{\"service\":\"SERVICE_PERSON_DATA_ENRICHMENT\",\"cpf\":\"cpf\"}"
```

## Node.js

### Node.js com fetch

```js
const baseUrl = "https://backoffice-hml.idcerberus.com";

async function gerarToken() {
  const response = await fetch(`${baseUrl}/api/token-generate`, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      client: "{client}",
      secret: "{secret}",
    }),
  });

  if (!response.ok) {
    throw new Error(`Falha ao gerar token: ${response.status}`);
  }

  return response.json();
}

async function executarServico(token) {
  const response = await fetch(`${baseUrl}/api/service-api`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      service: "SERVICE_PERSON_DATA_ENRICHMENT",
      cpf: "cpf",
    }),
  });

  const body = await response.json();

  if (body.status?.code !== 200) {
    throw new Error(body.status?.message || "Falha no processamento");
  }

  return body.result;
}

const { access_token } = await gerarToken();
const result = await executarServico(access_token);
console.log(result);
```

### Node.js com Axios

```js
import axios from "axios";

const baseUrl = "https://backoffice-hml.idcerberus.com";

const tokenResponse = await axios.post(`${baseUrl}/api/token-generate`, {
  client: "{client}",
  secret: "{secret}",
});

const token = tokenResponse.data.access_token;

const serviceResponse = await axios.post(
  `${baseUrl}/api/service-api`,
  {
    service: "SERVICE_PERSON_DATA_ENRICHMENT",
    cpf: "cpf",
  },
  {
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    timeout: 60000,
  },
);

if (serviceResponse.data.status?.code !== 200) {
  throw new Error(serviceResponse.data.status?.message || "Falha no processamento");
}

console.log(serviceResponse.data.result);
```

## Python

```python
import requests

BASE_URL = "https://backoffice-hml.idcerberus.com"

token_response = requests.post(
    f"{BASE_URL}/api/token-generate",
    json={
        "client": "{client}",
        "secret": "{secret}",
    },
    timeout=30,
)
token_response.raise_for_status()
token = token_response.json()["access_token"]

service_response = requests.post(
    f"{BASE_URL}/api/service-api",
    headers={"Authorization": f"Bearer {token}"},
    json={
        "service": "SERVICE_PERSON_DATA_ENRICHMENT",
        "cpf": "cpf",
    },
    timeout=60,
)
service_response.raise_for_status()
body = service_response.json()

if body.get("status", {}).get("code") != 200:
    raise RuntimeError(body.get("status", {}).get("message", "Falha no processamento"))

print(body["result"])
```

## C#

```csharp
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

var baseUrl = "https://backoffice-hml.idcerberus.com";
using var http = new HttpClient();

var tokenPayload = JsonSerializer.Serialize(new
{
    client = "{client}",
    secret = "{secret}"
});

var tokenResponse = await http.PostAsync(
    $"{baseUrl}/api/token-generate",
    new StringContent(tokenPayload, Encoding.UTF8, "application/json")
);

tokenResponse.EnsureSuccessStatusCode();
using var tokenJson = JsonDocument.Parse(await tokenResponse.Content.ReadAsStringAsync());
var token = tokenJson.RootElement.GetProperty("access_token").GetString();

http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var servicePayload = JsonSerializer.Serialize(new
{
    service = "SERVICE_PERSON_DATA_ENRICHMENT",
    cpf = "cpf"
});

var serviceResponse = await http.PostAsync(
    $"{baseUrl}/api/service-api",
    new StringContent(servicePayload, Encoding.UTF8, "application/json")
);

serviceResponse.EnsureSuccessStatusCode();
var serviceBody = await serviceResponse.Content.ReadAsStringAsync();
Console.WriteLine(serviceBody);
```

## Java

Exemplo usando `HttpClient`, disponível nas versões recentes do Java.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IdCerberusExample {
  public static void main(String[] args) throws Exception {
    var baseUrl = "https://backoffice-hml.idcerberus.com";
    var http = HttpClient.newHttpClient();

    var tokenRequest = HttpRequest.newBuilder()
      .uri(URI.create(baseUrl + "/api/token-generate"))
      .header("Content-Type", "application/json")
      .POST(HttpRequest.BodyPublishers.ofString("""
        {
          "client": "{client}",
          "secret": "{secret}"
        }
      """))
      .build();

    var tokenResponse = http.send(tokenRequest, HttpResponse.BodyHandlers.ofString());
    var tokenBody = tokenResponse.body();
    var token = tokenBody.split("\"access_token\"\\s*:\\s*\"")[1].split("\"")[0];

    var serviceRequest = HttpRequest.newBuilder()
      .uri(URI.create(baseUrl + "/api/service-api"))
      .header("Authorization", "Bearer " + token)
      .header("Content-Type", "application/json")
      .POST(HttpRequest.BodyPublishers.ofString("""
        {
          "service": "SERVICE_PERSON_DATA_ENRICHMENT",
          "cpf": "cpf"
        }
      """))
      .build();

    var serviceResponse = http.send(serviceRequest, HttpResponse.BodyHandlers.ofString());
    System.out.println(serviceResponse.body());
  }
}
```

## Como adaptar para outro serviço

Troque o valor de `service` e os campos do body.

Exemplo para CNPJ:

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

Exemplo para FaceMatch:

```json
{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}
```

---

# Matriz de serviços

URL: https://api-docs.idcerberus.com/guides/matriz-de-servicos
Fonte: guides/matriz-de-servicos.mdx
Descrição: Visão resumida dos principais serviços por tipo de documento, entrada e momento de uso

# Matriz de serviços

Esta matriz ajuda a localizar rapidamente qual serviço usar antes de abrir o
payload completo no API Reference.

> Info:
  Esta página é um atalho por objetivo. O catálogo técnico completo, com todos
  os campos e exemplos de cada service, vive em
  [Serviços de Pessoa Física](/guides/servicos-pessoa-fisica) e
  [Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica) — use-os como
  fonte de referência quando precisar do contrato completo de um service.

> Nota:
  Todos os itens abaixo são executados por `POST /api/service-api`, exceto os
  endpoints de autenticação, onboarding e customers. No endpoint central, o campo
  `service` escolhe o produto.

## Pessoa física

> Info:
  Os serviços de OCR ficam nesta matriz, mas os payloads completos estão no guia
  [OCR via Service API](/guides/service-api/sobre-ocr-service-api). Use esse guia quando
  a chamada envolver `image1`, `image2`, base64, URL de imagem ou `documentType`.

| Objetivo | Serviço | Entrada principal | Quando usar |
| --- | --- | --- | --- |
| Enriquecer dados cadastrais | `SERVICE_PERSON_DATA_ENRICHMENT` | `cpf` | Obter dados básicos de identificação |
| Consultar CPF na Receita | `SERVICE_RFB_PF` | `cpf` | Validar situação cadastral do CPF |
| Consultar CPF na Receita on-demand | `SERVICE_RFB_PF_ON_DEMAND` | `cpf` | Buscar dados cadastrais no momento da consulta |
| Consolidar modelagem de dados PF | `SERVICE_PERSON_DATA_MODELING` | `cpf` | Reunir sinais cadastrais, contatos, vínculos e risco em texto consolidado |
| Gerar resumo analítico de pessoa | `SERVICE_PERSON_AI_PROMPT` | `cpf` | Apoiar leitura de dados consolidados com uma resposta textual |
| Extrair dados de documento via OCR React | `SERVICE_OCR` | `documentType`, `image1`, `image2` | Ler RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificar automaticamente |
| Ler documento de emancipação | `SERVICE_OCR_EMANCIPATION` | `image1` | Extrair texto e dados possíveis de documento variável |
| Ler comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | `image1` | Extrair nome, endereço, datas e valores quando disponíveis |
| Buscar face na base | `SERVICE_FACE_INDEX` | `image1` | Procurar rosto em base indexada e retornar CPF/similaridade quando houver |
| Comparar faces | `SERVICE_FACE_MATCH` | `image1`, `image2` | Comparar selfie com documento ou outra imagem |
| Validar CNH no DataValid | `SERVICE_DATAVALID_CNH` | `cpf`, `image1` | Validar dados de CNH com apoio do validação documental |
| Consultar PEP | `SERVICE_PEP` | `cpf` | Avaliar exposição política |
| Consultar KYC/compliance PF | `SERVICE_PERSON_KYC` | `cpf` | Análise mais ampla de compliance |
| Consultar risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` | `cpf`, `birthDate` | Obter score e leitura resumida de risco financeiro |
| Consultar score de crédito | `SERVICE_CREDIT_SCORE` | `cpf` | Obter score de crédito |
| Consultar score inadimplência | `SERVICE_DEFAULT_RISK_SCORE` | `cpf` | Avaliar risco de inadimplência |
| Consultar dados demográficos | `SERVICE_DEMOGRAPHIC_DATA_CPF` | `cpf`, `birthDate` | Obter indicadores demográficos do CPF |
| Consultar indicadores de atividades | `SERVICE_ACTIVITIES_INDICATORS` | `cpf` | Obter sinais profissionais e de atividade |
| Consultar domínios PF | `SERVICE_DOMAINS_CPF` | `cpf` | Buscar domínios e sinais digitais associados ao CPF |
| Consultar prêmios e certificações | `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF` | `cpf` | Obter prêmios/certificações encontrados |
| Consultar benefícios sociais familiares | `SERVICE_FAMILY_SOCIAL_BENEFITS` | `cpf` | Verificar benefícios sociais familiares |
| Consultar benefícios sociais estendidos | `SERVICE_SOCIAL_ASSISTANCE_EXTENDED` | `cpf` | Verificar benefícios sociais estendidos |
| Consultar processos | `SERVICE_JURIDICAL_PROCESSES` | `cpf` | Levantar processos jurídicos e administrativos |
| Consultar histórico profissional | `SERVICE_PROFESSIONAL_HISTORY` | `cpf` | Recuperar vínculos profissionais |
| Consultar histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | `cpf`, `birthDate` | Recuperar vínculos em que a pessoa aparece como titular ou sócia |
| Consultar dados financeiros e endereços | `SERVICE_PF_FINANCIAL_AND_ADDRESS` | `cpf`, `birthDate` | Combinar dados cadastrais, endereços e informações financeiras |
| Consultar propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` | `cpf` | Avaliar sinais de propensão a apostas online |
| Consultar histórico de telefones | `SERVICE_PHONE_HISTORY` | `cpf`, `birthDate`, `limit` | Recuperar telefones associados ao CPF |
| Consultar histórico de e-mails | `SERVICE_EMAILS_EXTENDED` | `cpf`, `limit` | Recuperar e-mails associados ao CPF |
| Consultar pessoas relacionadas | `SERVICE_RELATED_PEOPLE` | `cpf`, `birthDate` | Mapear vínculos pessoais associados ao CPF |
| Validar CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` | `cpf`, `phone` | Conferir associação entre CPF e telefone |
| Validar CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` | `cpf`, `zipcode`, `numberAddress` | Conferir associação entre CPF e endereço |
| Consultar e-mails de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` | `cpf` | Mapear e-mails associados a pessoas relacionadas ao CPF |
| Consultar telefones de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` | `cpf` | Mapear telefones associados a pessoas relacionadas ao CPF |
| Consultar endereços de pessoas relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` | `cnpj` | Mapear endereços associados a pessoas relacionadas ao CNPJ |
| Consultar score de crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON` | `cpf` | Obter score de crédito com nível e classificação de risco |
| Consultar score de crédito multidados | `SERVICE_BOAVISTA_ONE_SCORE_PERSON` | `cpf` | Obter score de crédito multidados com nível e classificação de risco |
| Consultar dados restritivos de crédito | `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` | `cpf` | Verificar indicativo e quantidade de restrições de crédito |
| Consultar flags negativos de crédito | `SERVICE_QUOD_CREDIT_RISK_PERSON` | `cpf` | Verificar flags negativos e nível de risco de crédito |
| Consultar local de votação no TSE | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` | `cpf`, `birthDate`, `motherName` | Obter local de votação, situação eleitoral e biometria no TSE |
| Consultar antecedentes criminais civis | `SERVICE_CRIMINAL_RECORD_CIVIL` | `cpf`, `rg`, `uf` | Verificar ocorrências criminais em bases estaduais |
| Consultar antecedentes criminais federais | `SERVICE_CRIMINAL_RECORD_FEDERAL` | `cpf` | Verificar ocorrências criminais em bases federais |
| Consultar cartão SUS | `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` | `cpf` | Obter número do Cartão Nacional de Saúde e dados de nascimento |
| Consultar certidão de Nada Consta | `SERVICE_NOTHING_RECORD_LAWSUITS` | `cpf`, `court`, `uf`, `sphere` | Emitir certidão de nada consta em tribunal e esfera específicos |
| Consultar certidão negativa de protesto | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` | `cpf` | Verificar protestos em cartório para o CPF |
| Consultar certidão negativa de protesto (alias curto) | `SERVICE_PROTEST_PF` | `cpf` | Verificar protestos em cartório para o CPF, quando o produto usa o alias curto |
| Consultar MEI | `SERVICE_MEI` | `cpf` | Verificar empresas MEI associadas ao CPF |
| Consultar dados eleitorais de candidato | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` | `cpf` | Levantar histórico de candidaturas eleitorais |
| Consultar dados pelo telefone | `SERVICE_CONFIRM_PHONE` | `phone` | Obter dados de possível titular a partir do telefone |
| Consultar dados PIS | `SERVICE_PIS_CONSULTATION` | `cpf` | Verificar número e status do PIS/NIS associado ao CPF |
| Consultar dívida ativa | `SERVICE_ACTIVE_DEBT_PF` | `cpf` | Verificar débitos ativos vinculados ao CPF |
| Consultar doações eleitorais | `SERVICE_ELECTORAL_DONORS_CPF` | `cpf` | Levantar doações eleitorais realizadas pelo CPF |
| Consultar documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `key`, `image1`, `image2`, `selfie1` | Processar documento, imagem e selfie em um fluxo único |
| Consultar endereços | `SERVICE_ADDRESS` | `cpf` | Recuperar endereços associados ao CPF |
| Consultar envolvimento político | `SERVICE_POLITICAL_INVOLVEMENT` | `cpf` | Consolidar candidaturas, cargos, doações e vínculos políticos |
| Consultar envolvimento político PF | `SERVICE_POLITICAL_INVOLVEMENT_CPF` | `cpf` | Consolidar candidaturas, cargos, doações e vínculos políticos |
| Consultar exposição e perfil na mídia | `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` | `cpf` | Avaliar notícias, notoriedade e alertas de mídia associados ao CPF |
| Consultar histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` | `cpf` | Levantar vínculos políticos de familiares do CPF |
| Consultar informações financeiras | `SERVICE_FINANCIAL_INFORMATION` | `cpf` | Obter renda presumida e indicadores financeiros estimados |
| Consultar mandado de prisão | `SERVICE_ARREST_WARRANT` | `nome`, `motherName`, `fatherName`, `birthDate`, `cpf` | Verificar existência de mandado de prisão |
| Consultar prestadores de serviço eleitorais | `SERVICE_ELECTORAL_PROVIDERS_CPF` | `cpf` | Levantar prestações de serviço eleitorais vinculadas ao CPF |
| Consultar relacionamentos econômicos | `SERVICE_ECONOMIC_RELATIONSHIP` | `cpf` | Mapear vínculos econômicos associados ao CPF |
| Consultar resultado da documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `key` | Obter o resultado já processado da documentoscopia pela chave |
| Consultar score de risco de fraude | `SERVICE_FRAUD_RISK_SCORE` | `cpf`, `factor` | Avaliar propensão de fraude com base em fator de risco |
| Consultar servidores públicos | `SERVICE_PUBLIC_SERVANTS` | `cpf` | Verificar vínculos com o serviço público |
| Consultar validação de e-mail | `SERVICE_EMAIL_VALIDATION` | `email` | Validar formato, domínio e risco de um e-mail |
| Consultar validação do E-Social | `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` | `cpf` | Validar qualificação cadastral no E-Social |

## Pessoa jurídica

| Objetivo | Serviço | Entrada principal | Quando usar |
| --- | --- | --- | --- |
| Enriquecer dados cadastrais | `SERVICE_CORPORATE_DATA_ENRICHMENT` | `cnpj` | Obter dados da empresa na Receita Federal |
| Consultar status do CNPJ | `SERVICE_RFB_PJ` | `cnpj` | Validar situação cadastral da empresa |
| Consultar CNPJ na Receita on-demand | `SERVICE_RFB_PJ_ON_DEMAND` | `cnpj` | Buscar dados cadastrais da empresa no momento da consulta |
| Consultar dados cadastrais de CNPJ | `SERVICE_REGISTRATION_DATA_CNPJ` | `cnpj` | Obter cadastro empresarial retornado pela base |
| Ler cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | `image1` | Extrair CNPJ e texto OCR do cartão CNPJ |
| Consultar SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` | `cnpj`, `uf` | Verificar inscrição e situação estadual |
| Consultar domínios CNPJ | `SERVICE_DOMAINS_CNPJ` | `cnpj` | Buscar domínios e sinais digitais associados à empresa |
| Consultar relacionamentos | `SERVICE_COMPANY_RELATIONSHIP` | `cnpj` | Entender vínculos societários e de empresa |
| Consultar sócios na Receita Federal | `SERVICE_COMPANY_RFB_OWNERS` | `cnpj` | Recuperar dados cadastrais dos sócios na Receita |
| Consultar sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` | `cnpj` | Avaliar círculo de pessoas relacionadas |
| Consultar KYC dos sócios | `SERVICE_COMPANY_KYC_OWNERS` | `cnpj` | Avaliar PEP, sanções e compliance dos sócios |
| Consultar processos PJ | `SERVICE_JURIDICAL_PROCESSES_PJ` | `cnpj` | Levantar processos jurídicos da empresa |
| Consultar processos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` | `cnpj` | Levantar processos relacionados aos sócios |
| Consultar doações eleitorais PJ | `SERVICE_ELECTORAL_DONORS_CNPJ` | `cnpj` | Avaliar doações eleitorais associadas à empresa |
| Consultar doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` | `cnpj` | Avaliar doações eleitorais associadas aos sócios |
| Consultar fornecedores eleitorais PJ | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` | `cnpj` | Avaliar prestação de serviços eleitorais associada ao CNPJ |
| Consultar débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` | `cnpj` | Verificar débitos com o governo |
| Consultar protestos PJ | `SERVICE_PROTEST_PJ` | `cnpj` | Emitir ou consultar certidão/protestos |
| Consultar compliance de apostas | `SERVICE_COMPLIANCE_BET` | `cnpj` | Avaliar exposição relacionada a apostas |
| Consultar compliance de apostas | `SERVICE_COMPLIANCE_BET_PJ` | `cnpj` | Avaliar exposição relacionada a apostas |
| Consultar risco de crédito PJ | `SERVICE_CREDIT_RISK_COMPANY` | `cnpj` | Obter score, rating e risco esperado de crédito PJ |
| Consultar score de crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY` | `cnpj` | Obter score de crédito PJ com nível e classificação de risco |
| Consultar score de crédito Quantum PJ | `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` | `cnpj` | Obter score de crédito Quantum PJ |
| Identificar beneficiários finais | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` | `cnpj` | Calcular percentual de participação acumulado, inclusive por cadeias indiretas |
| Consultar percentual de participação societária | `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` | `cnpj` | Obter percentual de participação de cada sócio da empresa |
| Consultar projetos públicos | `SERVICE_PUBLIC_PROJECTS` | `cnpj` | Verificar projetos com financiamento de órgãos públicos |
| Consultar obras civis | `SERVICE_CIVIL_CONSTRUCTION` | `cnpj` | Verificar obras civis vinculadas ao CNPJ (CNO) |
| Consultar débitos com a PGFN | `SERVICE_PGFN_COMPANY` | `cnpj` | Emitir certidão de débitos tributários federais e dívida ativa da união |
| Consultar cota de PCD | `SERVICE_PCD_COMPANY` | `cnpj` | Verificar cumprimento da cota legal de PCD e reabilitados |
| Consultar certidão negativa correcional CGU | `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` | Verificar punições vigentes em CEIS, CNEP e CEPIM |
| Consultar certidão negativa CNJ | `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` | Verificar condenações cíveis por improbidade administrativa e inelegibilidade |
| Consultar certidão negativa de débitos estaduais | `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` | `cnpj` | Verificar débitos estaduais em qualquer UF |
| Consultar optante pelo Simples Nacional | `SERVICE_SIMPLES_COMPANY` | `cnpj` | Verificar situação como optante pelo Simples Nacional e SIMEI |
| Consultar KYC do grupo econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` | `cnpj` | Obter indicadores agregados de PEP e sanções do grupo econômico |
| Consultar DAS MEI na Receita | `SERVICE_DAS_MEI` | `cnpj` | Verificar situação fiscal e pagamentos do DAS MEI |
| Consultar endereços estendidos | `SERVICE_ADDRESSES_EXTENDED_CNPJ` | `cnpj` | Obter a lista completa de endereços do CNPJ |
| Consultar exposição e perfil na mídia dos sócios | `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` | `cnpj` | Avaliar notícias e alertas de mídia relacionados aos sócios |
| Consultar score de crédito multidados PJ | `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` | `cnpj` | Obter score de crédito multidados PJ |
| Consultar dados restritivos PJ | `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` | `cnpj` | Verificar indicativo e quantidade de restrições de crédito PJ |
| Consultar flags negativos PJ | `SERVICE_QUOD_CREDIT_RISK_COMPANY` | `cnpj` | Verificar flags negativos e nível de risco de crédito PJ |
| Consultar ações trabalhistas | `SERVICE_LABOR_LAWSUITS` | `cnpj` | Verificar processos trabalhistas relacionados à empresa |
| Consultar acordos sindicais | `SERVICE_SYNDICATE_AGREEMENTS` | `cnpj` | Verificar acordos firmados entre a empresa e sindicatos |
| Consultar anúncios online | `SERVICE_ONLINE_ADS` | `cnpj` | Identificar anúncios vinculados à empresa em portais e marketplaces |
| Consultar arrecadação Simples Nacional - MEI | `SERVICE_PGMEI` | `cnpj` | Verificar guias e situação do DAS-MEI |
| Consultar avaliações e reputação | `SERVICE_REPUTATIONS_AND_REVIEWS` | `cnpj` | Consolidar reputação da empresa em plataformas de avaliação |
| Consultar categoria comercial | `SERVICE_MERCHANT_CATEGORY_DATA` | `cnpj` | Obter a categorização MCC da empresa |
| Consultar dados de fundos de investimento | `SERVICE_INVESTMENT_FUND_DATA` | `cnpj` | Obter dados cadastrais e operacionais de fundos vinculados ao CNPJ |
| Consultar distribuição de processos dos sócios | `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` | `cnpj` | Obter estatísticas agregadas dos processos dos sócios |
| Consultar distribuição de processos judiciais | `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` | `cnpj` | Obter estatísticas agregadas dos processos da empresa |
| Consultar evolução da empresa | `SERVICE_COMPANY_EVOLUTION` | `cnpj` | Acompanhar evolução de capital, funcionários, filiais e sócios |
| Consultar FGTS | `SERVICE_FGTS` | `cnpj` | Verificar certidão de regularidade perante o FGTS |
| Consultar histórico de dados básicos | `SERVICE_HISTORY_BASIC_DATA` | `cnpj` | Acompanhar alterações cadastrais básicas do CNPJ ao longo do tempo |
| Consultar influência do quadro societário | `SERVICE_OWNERS_INFLUENCE` | `cnpj` | Avaliar influência inferida do quadro societário |
| Consultar KYC e compliance dos funcionários | `SERVICE_EMPLOYEES_KYC` | `cnpj` | Verificar PEP e sanções dos funcionários da empresa |
| Consultar marketplaces | `SERVICE_MARKETPLACE_DATA` | `cnpj` | Verificar presença e desempenho da empresa em marketplaces |
| Consultar Receita Federal - QSA | `SERVICE_RF_QSA` | `cnpj` | Obter o quadro societário-administrativo completo do CNPJ |
| Consultar relacionamentos do grupo econômico | `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` | `cnpj` | Mapear entidades do mesmo grupo econômico do CNPJ |
| Consultar telefones | `SERVICE_PHONES_EXTENDED_COMPANY` | `cnpj` | Obter telefones associados à empresa com indicadores de validade |

## Fluxos fora do service-api

| Objetivo | Endpoint | Quando usar |
| --- | --- | --- |
| Gerar token JWT | `POST /api/token-generate` | Antes de chamadas protegidas |
| Gerar token de onboarding | `POST /api/token-history-onboarding` | Antes de iniciar integração via SDK |
| Consultar onboarding | `GET /api/onboarding/report/{tokenOnboarding}` | Para recuperar resultado estruturado em JSON |
| Baixar relatório de onboarding | `GET /api/history-onboarding-report/{tokenOnboarding}` | Para obter o PDF final |
| Consultar cliente | `GET /api/customer` | Para localizar cliente por CPF ou CNPJ |
| Alterar status de cliente | `POST /api/changeStatusOfCustomer` | Para ativar ou desativar cliente |

## Próximo passo

Depois de escolher o serviço, abra [POST /api/service-api](/api-reference/serviços--pessoas/executar-serviço-de-dados-risco-ou-compliance) na API Reference e copie o exemplo correspondente.

---

# Índice de services

URL: https://api-docs.idcerberus.com/guides/indice-de-services
Fonte: guides/indice-de-services.mdx
Descrição: Lista operacional dos services já documentados no API Reference

# Índice de services

Use este Índice quando já souber qual produto precisa executar e quiser confirmar o nome exato do `service` antes de montar a chamada.

> Info:
Todas as consultas abaixo usam `POST /api/service-api`. O produto executado é definido pelo campo `service` no body.

## Como pesquisar melhor

A busca funciona melhor quando o termo aparece como título, alias ou texto da página. Se não souber o alias exato, pesquise pelo tipo de documento, dado ou problema que quer resolver.


 Pesquise por `cpf`, `receita`, `score`, `risco`, `telefone`, `email`, `ocr`, `face` ou `processos`.


 Pesquise por `cnpj`, `receita`, `risco de crédito`, `sócios`, `domínios`, `cartão CNPJ` ou `compliance`.


 Pesquise por `OCR`, `CNH`, `RG`, `cartão CNPJ`, `comprovante de endereço`, `base64` ou `image1`.


 Vá para o API Reference quando precisar de body, curl, response resumido e erro comum.


### Atalhos de busca


 Documentos de identificação, CNH, RG, OAB, RNE/CRNM e passaporte.


 OCR de cartão CNPJ com `SERVICE_OCR_CNPJ_CARD`.


 OCR de conta, fatura ou comprovante com imagem/base64.


 Busca facial por selfie na base de faces.


 Services de score, rating, risco e crédito PF/PJ.


 Validações e histórico de contato.


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

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

## Services por tipo de pessoa


 67 services para CPF, biometria, OCR, contatos, risco, crédito, compliance e dados eleitorais.


 58 services para CNPJ, Receita Federal, sócios, contatos, risco, compliance, OCR e dados societários.


## Pessoa Física

Abra o service para ver alias público, campos de entrada, termos de busca e retorno esperado.

**Service:** `SERVICE_CRIMINAL_RECORD_CIVIL`

**Campos principais:** `cpf`, `rg`, `uf`

**Termos de busca:** PF - Antecedentes criminais civis

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**Retorno principal:** Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CRIMINAL_RECORD_CIVIL)

**Service:** `SERVICE_CRIMINAL_RECORD_FEDERAL`

**Campos principais:** `cpf`

**Termos de busca:** PF - Antecedentes criminais federais

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**Retorno principal:** Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CRIMINAL_RECORD_FEDERAL)

**Service:** `SERVICE_SOCIAL_ASSISTANCE_EXTENDED`

**Campos principais:** `cpf`

**Termos de busca:** PF - Benefícios sociais estendidos

**Quando usar:** Use este service quando precisar executar a consulta "Benefícios sociais estendidos" via API.

**Retorno principal:** Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_SOCIAL_ASSISTANCE_EXTENDED)

**Service:** `SERVICE_FAMILY_SOCIAL_BENEFITS`

**Campos principais:** `cpf`

**Termos de busca:** PF - Benefícios sociais familiares

**Quando usar:** Use este service quando precisar executar a consulta "Benefícios sociais familiares" via API.

**Retorno principal:** Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FAMILY_SOCIAL_BENEFITS)

**Service:** `SERVICE_FACE_INDEX`

**Campos principais:** `image1`

**Termos de busca:** PF - Busca de face na base, comparação facial biometria selfie rosto, face index busca facial selfie CPF base de faces

**Quando usar:** Use para comparar duas imagens faciais e retornar a similaridade entre elas.

**Retorno principal:** Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FACE_INDEX)

**Service:** `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Cartão SUS

**Quando usar:** Use este service quando precisar executar a consulta "Cartão SUS" via API.

**Retorno principal:** Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF)

**Service:** `SERVICE_NOTHING_RECORD_LAWSUITS`

**Campos principais:** `cpf`, `court`, `uf`, `sphere`

**Termos de busca:** PF - Certidão de Nada Consta, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**Retorno principal:** Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_NOTHING_RECORD_LAWSUITS)

**Service:** `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`

**Campos principais:** `cpf`

**Termos de busca:** PF - Certidão negativa de protesto

**Quando usar:** Use para consultar protestos associados ao documento da pessoa.

**Retorno principal:** Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROTEST_CLEARANCE_CERTIFICATE)

**Service:** `SERVICE_PROTEST_PF`

**Campos principais:** `cpf`

**Termos de busca:** PF - Certidão negativa de protesto PF

**Quando usar:** Use para consultar protestos associados ao documento da pessoa.

**Retorno principal:** Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROTEST_PF)

**Service:** `SERVICE_MEI`

**Campos principais:** `cpf`

**Termos de busca:** PF - Consulta de MEI

**Quando usar:** Use este service quando precisar executar a consulta "Consulta de MEI" via API.

**Retorno principal:** Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_MEI)

**Service:** `SERVICE_RFB_PF_ON_DEMAND`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - CPF na Receita Federal on-demand

**Quando usar:** Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.

**Retorno principal:** Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RFB_PF_ON_DEMAND)

**Service:** `SERVICE_DEMOGRAPHIC_DATA_CPF`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** CPF Receita Federal, PF - Dados demográficos

**Quando usar:** Use para consultar dados demograficos associados à pessoa.

**Retorno principal:** Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DEMOGRAPHIC_DATA_CPF)

**Service:** `SERVICE_ELECTION_CANDIDATE_DATA_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Dados eleitorais de candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**Retorno principal:** Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTION_CANDIDATE_DATA_CPF)

**Service:** `SERVICE_PF_FINANCIAL_AND_ADDRESS`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** PF - Dados financeiros e endereços

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**Retorno principal:** Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PF_FINANCIAL_AND_ADDRESS)

**Service:** `SERVICE_CONFIRM_PHONE`

**Campos principais:** `phone`

**Termos de busca:** PF - Dados pelo telefone, telefone celular validação contato

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**Retorno principal:** Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CONFIRM_PHONE)

**Service:** `SERVICE_PIS_CONSULTATION`

**Campos principais:** `cpf`

**Termos de busca:** PF - Dados PIS

**Quando usar:** Use este service quando precisar executar a consulta "Dados PIS" via API.

**Retorno principal:** Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PIS_CONSULTATION)

**Service:** `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`

**Campos principais:** `cpf`

**Termos de busca:** PF - Dados Restritivos, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_BOAVISTA_CREDIT_SCORE_PERSON)

**Service:** `SERVICE_ACTIVE_DEBT_PF`

**Campos principais:** `cpf`

**Termos de busca:** PF - Dívida ativa, dívida ativa débito cobrança inadimplência

**Quando usar:** Use para consultar débitos ou dívidas associadas à pessoa.

**Retorno principal:** Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ACTIVE_DEBT_PF)

**Service:** `SERVICE_ELECTORAL_DONORS_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Doações eleitorais, dados eleitorais campanha doações candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**Retorno principal:** Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTORAL_DONORS_CPF)

**Service:** `SERVICE_DIGITAL_DOCUMENTOSCOPY`

**Campos principais:** `key`, `image1`, `image2`, `selfie1`

**Termos de busca:** PF - Documentoscopia digital, documentoscopia documento selfie validação

**Quando usar:** Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.

**Retorno principal:** Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DIGITAL_DOCUMENTOSCOPY)

**Service:** `SERVICE_DOMAINS_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Domínios, domínios sites presença digital

**Quando usar:** Use para consultar dados de sites vinculados à pessoa.

**Retorno principal:** Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DOMAINS_CPF)

**Service:** `SERVICE_RELATED_PEOPLE_EMAILS`

**Campos principais:** `cpf`

**Termos de busca:** PF - E-mails de Pessoas Relacionadas, email validação contato

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**Retorno principal:** Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_EMAILS)

**Service:** `SERVICE_ADDRESS`

**Campos principais:** `cpf`

**Termos de busca:** PF - Endereços

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**Retorno principal:** Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ADDRESS)

**Service:** `SERVICE_RELATED_PEOPLE_ADDRESSES`

**Campos principais:** `cnpj`

**Termos de busca:** PF - Endereços de Pessoas Relacionadas

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**Retorno principal:** Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_ADDRESSES)

**Service:** `SERVICE_PERSON_DATA_ENRICHMENT`

**Campos principais:** `cpf`

**Termos de busca:** PF - Enriquecimento de dados

**Quando usar:** Use para complementar dados cadastrais da pessoa a partir do documento informado.

**Retorno principal:** Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_DATA_ENRICHMENT)

**Service:** `SERVICE_POLITICAL_INVOLVEMENT`

**Campos principais:** `cpf`

**Termos de busca:** PF - Envolvimento político

**Quando usar:** Use este service quando precisar executar a consulta "Envolvimento político" via API.

**Retorno principal:** Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_POLITICAL_INVOLVEMENT)

**Service:** `SERVICE_POLITICAL_INVOLVEMENT_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Envolvimento político PF

**Quando usar:** Use este service quando precisar executar a consulta "Envolvimento político PF" via API.

**Retorno principal:** Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_POLITICAL_INVOLVEMENT_CPF)

**Service:** `SERVICE_MEDIA_PROFILE_EXPOSURE_PF`

**Campos principais:** `cpf`

**Termos de busca:** PF - Exposição e perfil na mídia

**Quando usar:** Use este service quando precisar executar a consulta "Exposição e perfil na mídia" via API.

**Retorno principal:** Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_MEDIA_PROFILE_EXPOSURE_PF)

**Service:** `SERVICE_FACE_MATCH`

**Campos principais:** `image1`, `image2`

**Termos de busca:** PF - FaceMatch, comparação facial biometria selfie rosto

**Quando usar:** Use para comparar duas imagens faciais e retornar a similaridade entre elas.

**Retorno principal:** Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FACE_MATCH)

**Service:** `SERVICE_QUOD_CREDIT_RISK_PERSON`

**Campos principais:** `cpf`

**Termos de busca:** PF - Flags Negativos

**Quando usar:** Use este service quando precisar executar a consulta "Flags Negativos" via API.

**Retorno principal:** Retorna flags negativos de crédito de pessoa física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_QUOD_CREDIT_RISK_PERSON)

**Service:** `SERVICE_EMAILS_EXTENDED`

**Campos principais:** `cpf`, `limit`

**Termos de busca:** PF - Histórico de e-mails, email validação contato

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**Retorno principal:** Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_EMAILS_EXTENDED)

**Service:** `SERVICE_PHONE_HISTORY`

**Campos principais:** `cpf`, `birthDate`, `limit`

**Termos de busca:** PF - Histórico de telefones, telefone celular validação contato

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**Retorno principal:** Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PHONE_HISTORY)

**Service:** `SERVICE_FAMILY_POLITICAL_HISTORY_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Histórico familiar político

**Quando usar:** Use este service quando precisar executar a consulta "Histórico familiar político" via API.

**Retorno principal:** Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FAMILY_POLITICAL_HISTORY_CPF)

**Service:** `SERVICE_PROFESSIONAL_HISTORY`

**Campos principais:** `cpf`

**Termos de busca:** PF - Histórico profissional

**Quando usar:** Use este service quando precisar executar a consulta "Histórico profissional" via API.

**Retorno principal:** Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROFESSIONAL_HISTORY)

**Service:** `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** PF - Histórico profissional do titular

**Quando usar:** Use este service quando precisar executar a consulta "Histórico profissional do titular" via API.

**Retorno principal:** Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY)

**Service:** `SERVICE_ACTIVITIES_INDICATORS`

**Campos principais:** `cpf`

**Termos de busca:** PF - Indicadores de atividades

**Quando usar:** Use este service quando precisar executar a consulta "Indicadores de atividades" via API.

**Retorno principal:** Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ACTIVITIES_INDICATORS)

**Service:** `SERVICE_FINANCIAL_INFORMATION`

**Campos principais:** `cpf`

**Termos de busca:** PF - Informações financeiras

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**Retorno principal:** Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FINANCIAL_INFORMATION)

**Service:** `SERVICE_PERSON_KYC`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** PF - KYC e compliance, compliance KYC sanções PEP mídia

**Quando usar:** Use para executar checagens de KYC e compliance da pessoa.

**Retorno principal:** Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_KYC)

**Service:** `SERVICE_ARREST_WARRANT`

**Campos principais:** `nome`, `motherName`, `fatherName`, `birthDate`, `cpf`

**Termos de busca:** PF - Mandado de prisão

**Quando usar:** Use este service quando precisar executar a consulta "Mandado de prisão" via API.

**Retorno principal:** Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ARREST_WARRANT)

**Service:** `SERVICE_PERSON_DATA_MODELING`

**Campos principais:** `cpf`

**Termos de busca:** PF - Modelagem de dados

**Quando usar:** Use este service quando precisar executar a consulta "Modelagem de dados" via API.

**Retorno principal:** Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_DATA_MODELING)

**Service:** `SERVICE_OCR_PROOF_OF_ADDRESS`

**Campos principais:** `image1`

**Termos de busca:** OCR documento imagem base64 leitura extração, PF - OCR de comprovante de endereço, comprovante de endereço conta fatura endereço

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**Retorno principal:** Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR_PROOF_OF_ADDRESS)

**Service:** `SERVICE_OCR_EMANCIPATION`

**Campos principais:** `image1`

**Termos de busca:** OCR documento imagem base64 leitura extração, PF - OCR de emancipação, documento emancipação cartório certidão declaração

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**Retorno principal:** Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR_EMANCIPATION)

**Service:** `SERVICE_OCR`

**Campos principais:** `documentType`, `image1`, `image2`

**Termos de busca:** OCR documento imagem base64 leitura extração, PF - OCR React

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**Retorno principal:** Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR)

**Service:** `SERVICE_PEP`

**Campos principais:** `cpf`

**Termos de busca:** PF - Pessoa politicamente exposta

**Quando usar:** Use para verificar exposição política ou vínculo com Pessoa Politicamente Exposta.

**Retorno principal:** Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PEP)

**Service:** `SERVICE_RELATED_PEOPLE`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** PF - Pessoas relacionadas

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.

**Retorno principal:** Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE)

**Service:** `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Prêmios e certificações

**Quando usar:** Use este service quando precisar executar a consulta "Prêmios e certificações" via API.

**Retorno principal:** Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_AWARDS_AND_CERTIFICATIONS_CPF)

**Service:** `SERVICE_ELECTORAL_PROVIDERS_CPF`

**Campos principais:** `cpf`

**Termos de busca:** CPF Receita Federal, PF - Prestadores de serviço eleitorais, dados eleitorais campanha doações candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**Retorno principal:** Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTORAL_PROVIDERS_CPF)

**Service:** `SERVICE_JURIDICAL_PROCESSES`

**Campos principais:** `cpf`

**Termos de busca:** PF - Processos jurídicos e administrativos, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**Retorno principal:** Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_JURIDICAL_PROCESSES)

**Service:** `SERVICE_PERSON_AI_PROMPT`

**Campos principais:** `cpf`

**Termos de busca:** PF - Prompt de IA para pessoa

**Quando usar:** Use este service quando precisar executar a consulta "Prompt de IA para pessoa" via API.

**Retorno principal:** Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_AI_PROMPT)

**Service:** `SEVICE_ONLINE_BETTING_PROPENSITY`

**Campos principais:** `cpf`

**Termos de busca:** PF - Propensão a apostas online, apostas bets compliance bet

**Quando usar:** Use este service quando precisar executar a consulta "Propensão a apostas online" via API.

**Retorno principal:** Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SEVICE_ONLINE_BETTING_PROPENSITY)

**Service:** `SERVICE_ECONOMIC_RELATIONSHIP`

**Campos principais:** `cpf`

**Termos de busca:** PF - Relacionamentos econômicos

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.

**Retorno principal:** Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ECONOMIC_RELATIONSHIP)

**Service:** `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`

**Campos principais:** `key`

**Termos de busca:** PF - Resultado da documentoscopia digital, documentoscopia documento selfie validação

**Quando usar:** Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.

**Retorno principal:** Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT)

**Service:** `SERVICE_FINANCIAL_RISK_SCORE`

**Campos principais:** `cpf`, `birthDate`

**Termos de busca:** PF - Risco financeiro, score risco crédito rating inadimplência

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**Retorno principal:** Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FINANCIAL_RISK_SCORE)

**Service:** `SERVICE_DATAVALID_CNH`

**Campos principais:** `cpf`, `image1`

**Termos de busca:** PF - Score biométrico, score risco crédito rating inadimplência

**Quando usar:** Use para comparar a imagem enviada com bases biométricas disponíveis e retornar a similaridade.

**Retorno principal:** Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DATAVALID_CNH)

**Service:** `SERVICE_CREDIT_SCORE`

**Campos principais:** `cpf`

**Termos de busca:** PF - Score de crédito, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CREDIT_SCORE)

**Service:** `SERVICE_QUOD_CREDIT_SCORE_PERSON`

**Campos principais:** `cpf`

**Termos de busca:** PF - Score de Crédito, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna score de crédito de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_QUOD_CREDIT_SCORE_PERSON)

**Service:** `SERVICE_BOAVISTA_ONE_SCORE_PERSON`

**Campos principais:** `cpf`

**Termos de busca:** PF - Score de Crédito Multidados, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna score de crédito multidados de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_BOAVISTA_ONE_SCORE_PERSON)

**Service:** `SERVICE_DEFAULT_RISK_SCORE`

**Campos principais:** `cpf`

**Termos de busca:** PF - Score de inadimplência, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DEFAULT_RISK_SCORE)

**Service:** `SERVICE_FRAUD_RISK_SCORE`

**Campos principais:** `cpf`, `factor`

**Termos de busca:** PF - Score de risco de fraude, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**Retorno principal:** Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FRAUD_RISK_SCORE)

**Service:** `SERVICE_PUBLIC_SERVANTS`

**Campos principais:** `cpf`

**Termos de busca:** PF - Servidores públicos

**Quando usar:** Use este service quando precisar executar a consulta "Servidores públicos" via API.

**Retorno principal:** Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PUBLIC_SERVANTS)

**Service:** `SERVICE_RFB_PF`

**Campos principais:** `cpf`, `dataDeNascimento`

**Termos de busca:** CPF Receita Federal, PF - Status do CPF na Receita Federal

**Quando usar:** Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.

**Retorno principal:** Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RFB_PF)

**Service:** `SERVICE_RELATED_PEOPLE_PHONES`

**Campos principais:** `cpf`

**Termos de busca:** PF - Telefones de Pessoas Relacionadas, telefone celular validação contato

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**Retorno principal:** Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_PHONES)

**Service:** `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`

**Campos principais:** `cpf`, `birthDate`, `motherName`

**Termos de busca:** CPF Receita Federal, PF - TSE - Local de votação

**Quando usar:** Use este service quando precisar executar a consulta "TSE - Local de votação" via API.

**Retorno principal:** Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF)

**Service:** `SERVICE_CPF_ADDRESS_VALIDATION`

**Campos principais:** `cpf`, `zipcode`, `numberAddress`

**Termos de busca:** CPF Receita Federal, PF - Validação de CPF com endereço

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**Retorno principal:** Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CPF_ADDRESS_VALIDATION)

**Service:** `SERVICE_CPF_PHONE_VALIDATION`

**Campos principais:** `cpf`, `phone`

**Termos de busca:** CPF Receita Federal, PF - Validação de CPF com telefone, telefone celular validação contato

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**Retorno principal:** Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CPF_PHONE_VALIDATION)

**Service:** `SERVICE_EMAIL_VALIDATION`

**Campos principais:** `email`

**Termos de busca:** PF - Validação de e-mail, email validação contato

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**Retorno principal:** Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_EMAIL_VALIDATION)

**Service:** `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`

**Campos principais:** `cpf`, `nit`

**Termos de busca:** PF - Validação do E-Social

**Quando usar:** Use este service quando precisar executar a consulta "Validação do E-Social" via API.

**Retorno principal:** Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION)

## Pessoa Jurídica

Abra o service para ver alias público, campos de entrada, termos de busca e retorno esperado.

**Service:** `SERVICE_LABOR_LAWSUITS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Ações Trabalhistas, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da empresa.

**Retorno principal:** Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_LABOR_LAWSUITS)

**Service:** `SERVICE_SYNDICATE_AGREEMENTS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Acordos Sindicais

**Quando usar:** Use este service quando precisar executar a consulta "Acordos Sindicais" via API.

**Retorno principal:** Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SYNDICATE_AGREEMENTS)

**Service:** `SERVICE_ONLINE_ADS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Anúncios Online

**Quando usar:** Use este service quando precisar executar a consulta "Anúncios Online" via API.

**Retorno principal:** Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ONLINE_ADS)

**Service:** `SERVICE_PGMEI`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Arrecadação Simples Nacional - MEI

**Quando usar:** Use este service quando precisar executar a consulta "Arrecadação Simples Nacional - MEI" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PGMEI)

**Service:** `SERVICE_REPUTATIONS_AND_REVIEWS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Avaliações e Reputação

**Quando usar:** Use este service quando precisar executar a consulta "Avaliações e Reputação" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_REPUTATIONS_AND_REVIEWS)

**Service:** `SERVICE_ULTIMATE_BENEFICIAL_OWNERS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Beneficiários Finais

**Quando usar:** Use este service quando precisar executar a consulta "Beneficiários Finais" via API.

**Retorno principal:** 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%.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ULTIMATE_BENEFICIAL_OWNERS)

**Service:** `SERVICE_MERCHANT_CATEGORY_DATA`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Categoria Comercial

**Quando usar:** Use este service quando precisar executar a consulta "Categoria Comercial" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MERCHANT_CATEGORY_DATA)

**Service:** `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Certidão Negativa CNJ

**Quando usar:** Use este service quando precisar executar a consulta "Certidão Negativa CNJ" via API.

**Retorno principal:** Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY)

**Service:** `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Certidão Negativa Correcional CGU

**Quando usar:** Use este service quando precisar executar a consulta "Certidão Negativa Correcional CGU" via API.

**Retorno principal:** Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY)

**Service:** `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Certidão Negativa de Débitos Estaduais, dívida ativa débito cobrança inadimplência

**Quando usar:** Use para consultar débitos ou dívidas associadas à empresa.

**Retorno principal:** Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_STATE_DEBT_CERTIFICATE_COMPANY)

**Service:** `SERVICE_PROTEST_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Certidão negativa de protesto

**Quando usar:** Use para consultar protestos associados ao documento da empresa.

**Retorno principal:** Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PROTEST_PJ)

**Service:** `SERVICE_RFB_PJ_ON_DEMAND`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, CPF Receita Federal, PJ - CNPJ na Receita Federal on-demand

**Quando usar:** Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.

**Retorno principal:** Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RFB_PJ_ON_DEMAND)

**Service:** `SERVICE_COMPLIANCE_BET_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Compliance de casas de apostas, apostas bets compliance bet

**Quando usar:** Use para executar checagens de KYC e compliance da empresa.

**Retorno principal:** Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPLIANCE_BET_PJ)

**Service:** `SERVICE_COMPLIANCE_BET`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Compliance de casas de apostas (alias curto), apostas bets compliance bet

**Quando usar:** Use para executar checagens de KYC e compliance da empresa.

**Retorno principal:** Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPLIANCE_BET)

**Service:** `SERVICE_PCD_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Cota de PCD

**Quando usar:** Use este service quando precisar executar a consulta "Cota de PCD" via API.

**Retorno principal:** Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PCD_COMPANY)

**Service:** `SERVICE_REGISTRATION_DATA_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Dados cadastrais de CNPJ

**Quando usar:** Use este service quando precisar executar a consulta "Dados cadastrais de CNPJ" via API.

**Retorno principal:** Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_REGISTRATION_DATA_CNPJ)

**Service:** `SERVICE_INVESTMENT_FUND_DATA`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Dados de Fundos de Investimento

**Quando usar:** Use este service quando precisar executar a consulta "Dados de Fundos de Investimento" via API.

**Retorno principal:** Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_INVESTMENT_FUND_DATA)

**Service:** `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Dados Restritivos PJ, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à empresa.

**Retorno principal:** Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY)

**Service:** `SERVICE_DAS_MEI`

**Campos principais:** `cnpj`

**Termos de busca:** CPF Receita Federal, PJ - DAS MEI na Receita

**Quando usar:** Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.

**Retorno principal:** Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_DAS_MEI)

**Service:** `SERVICE_ACTIVE_DEBT_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Débitos ativos, dívida ativa débito cobrança inadimplência

**Quando usar:** Use para consultar débitos ou dívidas associadas à empresa.

**Retorno principal:** Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ACTIVE_DEBT_PJ)

**Service:** `SERVICE_PGFN_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Débitos com a PGFN, dívida ativa débito cobrança inadimplência

**Quando usar:** Use para consultar débitos ou dívidas associadas à empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PGFN_COMPANY)

**Service:** `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Distribuição de Processos dos Sócios, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_LAWSUITS_DISTRIBUTION)

**Service:** `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Distribuição de Processos Judiciais, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da empresa.

**Retorno principal:** Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY)

**Service:** `SERVICE_ELECTORAL_DONORS_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Doações eleitorais, dados eleitorais campanha doações candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à empresa.

**Retorno principal:** Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ELECTORAL_DONORS_CNPJ)

**Service:** `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Doações eleitorais dos sócios, dados eleitorais campanha doações candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à empresa.

**Retorno principal:** Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ)

**Service:** `SERVICE_DOMAINS_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Domínios CNPJ, domínios sites presença digital

**Quando usar:** Use para consultar dados de sites vinculados à empresa.

**Retorno principal:** Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_DOMAINS_CNPJ)

**Service:** `SERVICE_ADDRESSES_EXTENDED_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Endereços estendidos

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ADDRESSES_EXTENDED_CNPJ)

**Service:** `SERVICE_CORPORATE_DATA_ENRICHMENT`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Enriquecimento de dados

**Quando usar:** Use para complementar dados cadastrais da empresa a partir do documento informado.

**Retorno principal:** Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CORPORATE_DATA_ENRICHMENT)

**Service:** `SERVICE_COMPANY_EVOLUTION`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Evolução da Empresa

**Quando usar:** Use este service quando precisar executar a consulta "Evolução da Empresa" via API.

**Retorno principal:** Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_EVOLUTION)

**Service:** `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Exposição e perfil na mídia dos sócios

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à empresa.

**Retorno principal:** Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MEDIA_PROFILE_EXPOSURE_PJ)

**Service:** `SERVICE_FGTS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - FGTS

**Quando usar:** Use este service quando precisar executar a consulta "FGTS" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_FGTS)

**Service:** `SERVICE_QUOD_CREDIT_RISK_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Flags Negativos PJ

**Quando usar:** Use este service quando precisar executar a consulta "Flags Negativos PJ" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUOD_CREDIT_RISK_COMPANY)

**Service:** `SERVICE_ELECTORAL_PROVIDERS_CNPJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, PJ - Fornecedores eleitorais, dados eleitorais campanha doações candidato

**Quando usar:** Use para consultar informações eleitorais relacionadas à empresa.

**Retorno principal:** Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ELECTORAL_PROVIDERS_CNPJ)

**Service:** `SERVICE_HISTORY_BASIC_DATA`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Histórico de Dados Básicos

**Quando usar:** Use este service quando precisar executar a consulta "Histórico de Dados Básicos" via API.

**Retorno principal:** Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_HISTORY_BASIC_DATA)

**Service:** `SERVICE_OWNERS_INFLUENCE`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Influência do Quadro Societário

**Quando usar:** Use este service quando precisar executar a consulta "Influência do Quadro Societário" via API.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_INFLUENCE)

**Service:** `SERVICE_ECONOMIC_GROUP_KYC_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - KYC e Compliance do Grupo Econômico, compliance KYC sanções PEP mídia

**Quando usar:** Use para executar checagens de KYC e compliance da empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ECONOMIC_GROUP_KYC_COMPANY)

**Service:** `SERVICE_EMPLOYEES_KYC`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - KYC e Compliance dos Funcionários, compliance KYC sanções PEP mídia

**Quando usar:** Use para executar checagens de KYC e compliance da empresa.

**Retorno principal:** Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_EMPLOYEES_KYC)

**Service:** `SERVICE_COMPANY_KYC_OWNERS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - KYC e compliance dos sócios, compliance KYC sanções PEP sancionado interpol ofac

**Quando usar:** Use para executar checagens de KYC e compliance da empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_KYC_OWNERS)

**Service:** `SERVICE_MARKETPLACE_DATA`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Marketplaces

**Quando usar:** Use este service quando precisar executar a consulta "Marketplaces" via API.

**Retorno principal:** Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MARKETPLACE_DATA)

**Service:** `SERVICE_CIVIL_CONSTRUCTION`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Obras Civis

**Quando usar:** Use este service quando precisar executar a consulta "Obras Civis" via API.

**Retorno principal:** Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO).

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CIVIL_CONSTRUCTION)

**Service:** `SERVICE_OCR_CNPJ_CARD`

**Campos principais:** `image1`

**Termos de busca:** CNPJ Receita Federal, OCR cartão CNPJ comprovante inscrição empresa, OCR documento imagem base64 leitura extração, PJ - OCR de cartão CNPJ

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**Retorno principal:** Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OCR_CNPJ_CARD)

**Service:** `SERVICE_SIMPLES_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Optante pelo Simples Nacional

**Quando usar:** Use este service quando precisar executar a consulta "Optante pelo Simples Nacional" via API.

**Retorno principal:** Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SIMPLES_COMPANY)

**Service:** `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Percentual de Participação Societária

**Quando usar:** Use este service quando precisar executar a consulta "Percentual de Participação Societária" via API.

**Retorno principal:** Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY)

**Service:** `SERVICE_JURIDICAL_PROCESSES_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Processos jurídicos, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da empresa.

**Retorno principal:** Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_JURIDICAL_PROCESSES_PJ)

**Service:** `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Processos jurídicos dos sócios, processos judiciais jurídicos tribunal certidão

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da empresa.

**Retorno principal:** Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS)

**Service:** `SERVICE_PUBLIC_PROJECTS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Projetos Públicos

**Quando usar:** Use este service quando precisar executar a consulta "Projetos Públicos" via API.

**Retorno principal:** Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PUBLIC_PROJECTS)

**Service:** `SERVICE_RF_QSA`

**Campos principais:** `cnpj`

**Termos de busca:** CPF Receita Federal, PJ - Receita Federal - QSA

**Quando usar:** Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RF_QSA)

**Service:** `SERVICE_COMPANY_RELATIONSHIP`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Relacionamentos da empresa

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à empresa.

**Retorno principal:** Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_RELATIONSHIP)

**Service:** `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Relacionamentos do Grupo Econômico

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ECONOMIC_GROUP_RELATIONSHIPS)

**Service:** `SERVICE_CREDIT_RISK_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Risco de crédito, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à empresa.

**Retorno principal:** Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CREDIT_RISK_COMPANY)

**Service:** `SERVICE_BOAVISTA_ONE_SCORE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Score de Crédito Multidados PJ, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_ONE_SCORE_COMPANY)

**Service:** `SERVICE_QUOD_CREDIT_SCORE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Score de Crédito PJ, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à empresa.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUOD_CREDIT_SCORE_COMPANY)

**Service:** `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Score de Crédito Quantum PJ, score risco crédito rating inadimplência

**Quando usar:** Use para avaliar risco, score ou propensão associada à empresa.

**Retorno principal:** Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY)

**Service:** `SERVICE_SINTEGRA_CONSULTATION`

**Campos principais:** `cnpj`, `uf`

**Termos de busca:** PJ - SINTEGRA

**Quando usar:** Use este service quando precisar executar a consulta "SINTEGRA" via API.

**Retorno principal:** Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SINTEGRA_CONSULTATION)

**Service:** `SERVICE_FIRST_LEVEL_PARTNER`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Sócios de primeiro nível

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à empresa.

**Retorno principal:** Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_FIRST_LEVEL_PARTNER)

**Service:** `SERVICE_COMPANY_RFB_OWNERS`

**Campos principais:** `cnpj`

**Termos de busca:** CPF Receita Federal, PJ - Sócios na Receita Federal

**Quando usar:** Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.

**Retorno principal:** 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.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_RFB_OWNERS)

**Service:** `SERVICE_RFB_PJ`

**Campos principais:** `cnpj`

**Termos de busca:** CNPJ Receita Federal, CPF Receita Federal, PJ - Status do CNPJ na Receita Federal

**Quando usar:** Use para consultar ou validar dados cadastrais da empresa em bases da Receita Federal.

**Retorno principal:** Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RFB_PJ)

**Service:** `SERVICE_PHONES_EXTENDED_COMPANY`

**Campos principais:** `cnpj`

**Termos de busca:** PJ - Telefones, telefone celular validação contato

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**Retorno principal:** Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem.

[Ver no API Reference](https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PHONES_EXTENDED_COMPANY)

## Passo a passo por service

Use o API Reference para copiar body, curl e response resumido de cada produto:


 Catálogo completo com payloads e responses para services de CPF.


 Catálogo completo com payloads e responses para services de CNPJ.

---

# [object Object]

URL: https://api-docs.idcerberus.com/[object Object]
Fonte: [object Object].mdx



---

# Famílias de serviços

URL: https://api-docs.idcerberus.com/guides/service-api/familias-de-servicos
Fonte: guides/service-api/familias-de-servicos.mdx
Descrição: Navegue pelos principais grupos de produtos executados via POST /api/service-api

# Famílias de serviços

O endpoint `POST /api/service-api` concentra diferentes produtos. A separação por
família ajuda a localizar rapidamente o payload correto sem tratar o endpoint
como uma lista única e extensa.

> Info:
  Esta página agrupa por família de produto. O catálogo técnico completo, com
  todos os campos e exemplos de cada service, vive em
  [Serviços de Pessoa Física](/guides/servicos-pessoa-fisica) e
  [Serviços de Pessoa Jurídica](/guides/servicos-pessoa-juridica) — use-os como
  fonte de referência quando precisar do contrato completo de um service.


    Services de CPF, cadastro, score, compliance e dados complementares.


    Services de CNPJ, cadastro empresarial, sócios, risco e compliance.


    OCR, face, liveness, documentoscopia e payloads com imagem.


    Scores, validações, compliance, certidões e sinais de risco.


## Como usar esta página

1. Escolha a família de serviço.
2. Copie o código `service` ou confirme o alias de chamada configurado no produto.
3. Abra `POST /api/service-api` na API Reference.
4. Selecione o exemplo correspondente.
5. Mapeie o response esperado.

## Padrão de consumo

Todos os produtos desta página usam a mesma base de chamada:

```json
{
  "service": "codigo_do_servico",
  "cpf": "cpf"
}
```

O campo `service` escolhe o produto. Os demais campos variam conforme a
consulta: documentos usam imagens ou URLs, serviços PF usam `cpf`, serviços PJ
usam `cnpj` e algumas certidões exigem dados complementares como `uf`, `rg` ou
`court`.

> Atencao:
  A API valida o `service` contra os services liberados no produto do cliente.
  Por isso, em alguns casos o valor enviado na chamada pode ser um alias curto
  do produto, e não outro alias documentado no catálogo.

Antes de testar com o cliente, confirme o alias no produto, copie esse valor
para o body e depois complete os campos obrigatórios da família escolhida.

| Alias documentado | Alias curto do produto |
| --- | --- |
| `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `SERVICE_DOCUMENTOSCOPY` |
| `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `SERVICE_DIGITAL_DOCUMENTOSCOPY` |
| `SERVICE_ECONOMIC_RELATIONSHIP` | `economic_relationships` |
| `SERVICE_EMAIL_VALIDATION` | `SERVICE_EMAIL_VALIDATION1` |
| `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`, `SERVICE_PROTEST_PF` | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` |
| `SERVICE_PROTEST_PJ` | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ` |

Pense no `POST /api/service-api` como um executor. A rota é sempre a mesma, mas
o serviço executado muda de acordo com o valor enviado em `service`.

Exemplo:

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

Neste caso, a API entende que deve executar o serviço de enriquecimento de dados
de pessoa física. Se o `service` mudar, o produto executado também muda.

| Tipo de consulta | Documento principal | Observação |
| --- | --- | --- |
| Pessoa física | `cpf` | Pode exigir dados adicionais em certidões, validações ou biometria |
| Pessoa jurídica | `cnpj` | Pode exigir `uf` em consultas estaduais ou documentos complementares |
| Documento e biometria | `image1`, `image2`, `selfie1` ou URLs | Use base64 ou URL conforme o produto |
| Onboarding/documentoscopia assíncrona | `key` | A chave permite consultar o resultado depois |

> Nota:
  Para implementação, copie o exemplo completo na API Reference e use esta página
  apenas para escolher rapidamente o produto correto.

## Cadastro e identidade PF

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Enriquecimento de pessoa física | `SERVICE_PERSON_DATA_ENRICHMENT` | `cpf` |
| Status do CPF na Receita Federal | `SERVICE_RFB_PF` | `cpf`, `dataDeNascimento` |
| CPF na Receita Federal on-demand | `SERVICE_RFB_PF_ON_DEMAND` | `cpf` |
| Modelagem de dados de pessoa física | `SERVICE_PERSON_DATA_MODELING` | `cpf` |
| Prompt de IA para pessoa | `SERVICE_PERSON_AI_PROMPT` | `cpf` |
| Consulta de MEI | `SERVICE_MEI` | `cpf` |
| Endereços | `SERVICE_ADDRESS` | `cpf` |
| Histórico de telefones | `SERVICE_PHONE_HISTORY` | `cpf`, `birthDate`, `limit` |
| Histórico de e-mails | `SERVICE_EMAILS_EXTENDED` | `cpf`, `limit` |
| Pessoas relacionadas | `SERVICE_RELATED_PEOPLE` | `cpf`, `birthDate` |
| Cartão SUS | `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` | `cpf` |
| Dados pelo telefone | `SERVICE_CONFIRM_PHONE` | `phone` |
| Dados PIS | `SERVICE_PIS_CONSULTATION` | `cpf` |
| Validação do E-Social | `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` | `cpf` |
| Relacionamentos econômicos | `SERVICE_ECONOMIC_RELATIONSHIP` | `cpf` |
| Histórico profissional | `SERVICE_PROFESSIONAL_HISTORY` | `cpf` |
| Histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | `cpf`, `birthDate` |
| Dados financeiros e endereços PF | `SERVICE_PF_FINANCIAL_AND_ADDRESS` | `cpf`, `birthDate` |
| Dados demográficos | `SERVICE_DEMOGRAPHIC_DATA_CPF` | `cpf`, `birthDate` |
| Indicadores de atividades | `SERVICE_ACTIVITIES_INDICATORS` | `cpf` |
| Domínios PF | `SERVICE_DOMAINS_CPF` | `cpf` |
| E-mails de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` | `cpf` |
| Telefones de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` | `cpf` |
| Endereços de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` | `cnpj` |
| TSE - Local de votação | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` | `cpf`, `birthDate`, `motherName` |

## Documentos e biometria

Nesta família, o payload precisa de mais cuidado: imagem errada, base64 com
prefixo ou alias incorreto podem fazer a chamada autenticar e mesmo assim não
produzir o retorno esperado. Para OCR, use também o guia [OCR via Service API](/guides/service-api/sobre-ocr-service-api).

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| OCR React | `SERVICE_OCR` | `documentType`, `image1`, `image2` |
| OCR de emancipação | `SERVICE_OCR_EMANCIPATION` | `image1` |
| OCR de comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | `image1` |
| Busca de face na base | `SERVICE_FACE_INDEX` | `image1` |
| FaceMatch | `SERVICE_FACE_MATCH` | `image1`, `image2` |
| Score biométrico / Validação de CNH no DataValid | `SERVICE_DATAVALID_CNH` | `cpf`, `image1` |
| Documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `key`, `image1`, `image2`, `selfie1` |
| Resultado da documentoscopia | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `key` |

## Risco, validações e compliance PF

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Pessoa politicamente exposta | `SERVICE_PEP` | `cpf` |
| KYC e compliance de pessoa física | `SERVICE_PERSON_KYC` | `cpf`, `birthDate` |
| Exposição e perfil na mídia PF | `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` | `cpf` |
| Score de fraude | `SERVICE_FRAUD_RISK_SCORE` | `cpf`, `factor` |
| Risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` | `cpf`, `birthDate` |
| Score de inadimplência | `SERVICE_DEFAULT_RISK_SCORE` | `cpf` |
| Score de crédito | `SERVICE_CREDIT_SCORE` | `cpf` |
| Débitos ativos PF | `SERVICE_ACTIVE_DEBT_PF` | `cpf` |
| Validação de e-mail | `SERVICE_EMAIL_VALIDATION` | `email` |
| Validação de CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` | `cpf`, `phone` |
| Validação de CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` | `cpf`, `zipcode`, `numberAddress` |
| Propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` | `cpf` |
| Prêmios e certificações | `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF` | `cpf` |
| Benefícios sociais familiares | `SERVICE_FAMILY_SOCIAL_BENEFITS` | `cpf` |
| Benefícios sociais estendidos | `SERVICE_SOCIAL_ASSISTANCE_EXTENDED` | `cpf` |
| Score de Crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON` | `cpf` |
| Score de Crédito Multidados | `SERVICE_BOAVISTA_ONE_SCORE_PERSON` | `cpf` |
| Dados Restritivos | `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` | `cpf` |
| Flags Negativos | `SERVICE_QUOD_CREDIT_RISK_PERSON` | `cpf` |
| Informações financeiras | `SERVICE_FINANCIAL_INFORMATION` | `cpf` |
| Servidores públicos | `SERVICE_PUBLIC_SERVANTS` | `cpf` |

## Certidões e judicial PF

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Nada consta em ações judiciais | `SERVICE_NOTHING_RECORD_LAWSUITS` | `cpf`, `court`, `uf`, `sphere` |
| Antecedentes criminais federais | `SERVICE_CRIMINAL_RECORD_FEDERAL` | `cpf` |
| Antecedentes criminais civis | `SERVICE_CRIMINAL_RECORD_CIVIL` | `cpf`, `rg`, `uf` |
| Certidão negativa de protesto | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` | `cpf` |
| Processos jurídicos | `SERVICE_JURIDICAL_PROCESSES` | `cpf` |
| Mandado de prisão | `SERVICE_ARREST_WARRANT` | `cpf`, `nome`, `birthDate` |

## Político e eleitoral

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Dados eleitorais de candidato | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` | `cpf` |
| Doações eleitorais PF | `SERVICE_ELECTORAL_DONORS_CPF` | `cpf` |
| Envolvimento político | `SERVICE_POLITICAL_INVOLVEMENT` | `cpf` |
| Histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` | `cpf` |
| Prestadores eleitorais PF | `SERVICE_ELECTORAL_PROVIDERS_CPF` | `cpf` |
| Envolvimento político PF | `SERVICE_POLITICAL_INVOLVEMENT_CPF` | `cpf` |

## Cadastro e regularidade PJ

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Enriquecimento de pessoa jurídica | `SERVICE_CORPORATE_DATA_ENRICHMENT` | `cnpj` |
| Status do CNPJ na Receita Federal | `SERVICE_RFB_PJ` | `cnpj` |
| CNPJ na Receita Federal on-demand | `SERVICE_RFB_PJ_ON_DEMAND` | `cnpj` |
| SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` | `cnpj`, `uf` |
| Dados cadastrais de CNPJ | `SERVICE_REGISTRATION_DATA_CNPJ` | `cnpj` |
| Domínios CNPJ | `SERVICE_DOMAINS_CNPJ` | `cnpj` |
| Endereços estendidos de empresa | `SERVICE_ADDRESSES_EXTENDED_CNPJ` | `cnpj` |
| Doações eleitorais PJ | `SERVICE_ELECTORAL_DONORS_CNPJ` | `cnpj` |
| Fornecedores eleitorais PJ | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` | `cnpj` |
| DAS MEI | `SERVICE_DAS_MEI` | `cnpj` |
| Projetos Públicos | `SERVICE_PUBLIC_PROJECTS` | `cnpj` |
| Obras Civis | `SERVICE_CIVIL_CONSTRUCTION` | `cnpj` |

## Sócios, relacionamentos e compliance PJ

| Produto | Código `service` | Entrada principal |
| --- | --- | --- |
| Relacionamentos de empresa | `SERVICE_COMPANY_RELATIONSHIP` | `cnpj` |
| Sócios na Receita Federal | `SERVICE_COMPANY_RFB_OWNERS` | `cnpj` |
| Sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` | `cnpj` |
| Processos jurídicos PJ | `SERVICE_JURIDICAL_PROCESSES_PJ` | `cnpj` |
| Processos jurídicos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` | `cnpj` |
| KYC e compliance dos sócios | `SERVICE_COMPANY_KYC_OWNERS` | `cnpj` |
| Exposição e perfil na mídia dos sócios | `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` | `cnpj` |
| Doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` | `cnpj` |
| Débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` | `cnpj` |
| Protesto PJ | `SERVICE_PROTEST_PJ` | `cnpj` |
| Compliance de apostas | `SERVICE_COMPLIANCE_BET` | `cnpj` |
| Compliance de apostas PJ | `SERVICE_COMPLIANCE_BET_PJ` | `cnpj` |
| Risco de crédito PJ | `SERVICE_CREDIT_RISK_COMPANY` | `cnpj` |
| Score de Crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY` | `cnpj` |
| Score de Crédito Multidados PJ | `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` | `cnpj` |
| Dados Restritivos PJ | `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` | `cnpj` |
| Flags Negativos PJ | `SERVICE_QUOD_CREDIT_RISK_COMPANY` | `cnpj` |
| Score de Crédito Quantum PJ | `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` | `cnpj` |
| Ações Trabalhistas | `SERVICE_LABOR_LAWSUITS` | `cnpj` |
| Acordos Sindicais | `SERVICE_SYNDICATE_AGREEMENTS` | `cnpj` |
| Anúncios Online | `SERVICE_ONLINE_ADS` | `cnpj` |
| Arrecadação Simples Nacional - MEI | `SERVICE_PGMEI` | `cnpj` |
| Avaliações e Reputação | `SERVICE_REPUTATIONS_AND_REVIEWS` | `cnpj` |
| Categoria Comercial | `SERVICE_MERCHANT_CATEGORY_DATA` | `cnpj` |
| Dados de Fundos de Investimento | `SERVICE_INVESTMENT_FUND_DATA` | `cnpj` |
| Distribuição de Processos dos Sócios | `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` | `cnpj` |
| Distribuição de Processos Judiciais | `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` | `cnpj` |
| Evolução da Empresa | `SERVICE_COMPANY_EVOLUTION` | `cnpj` |
| FGTS | `SERVICE_FGTS` | `cnpj` |
| Histórico de Dados Básicos | `SERVICE_HISTORY_BASIC_DATA` | `cnpj` |
| Influência do Quadro Societário | `SERVICE_OWNERS_INFLUENCE` | `cnpj` |
| KYC e Compliance dos Funcionários | `SERVICE_EMPLOYEES_KYC` | `cnpj` |
| Marketplaces | `SERVICE_MARKETPLACE_DATA` | `cnpj` |
| Receita Federal - QSA | `SERVICE_RF_QSA` | `cnpj` |
| Relacionamentos do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` | `cnpj` |
| Telefones | `SERVICE_PHONES_EXTENDED_COMPANY` | `cnpj` |
| Beneficiários Finais | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` | `cnpj` |
| Percentual de Participação Societária | `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` | `cnpj` |
| Débitos com a PGFN | `SERVICE_PGFN_COMPANY` | `cnpj` |
| Cota de PCD | `SERVICE_PCD_COMPANY` | `cnpj` |
| Certidão Negativa Correcional CGU | `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` |
| Certidão Negativa CNJ | `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` |
| Certidão Negativa de Débitos Estaduais | `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` | `cnpj` |
| Optante pelo Simples Nacional | `SERVICE_SIMPLES_COMPANY` | `cnpj` |
| KYC e Compliance do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` | `cnpj` |
| OCR de cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | `image1` |

---

# Enriquecimento cadastral

URL: https://api-docs.idcerberus.com/guides/pessoas/enriquecimento-cadastral
Fonte: guides/pessoas/enriquecimento-cadastral.mdx
Descrição: Consulte, valide e complemente dados cadastrais de pessoas físicas

# Enriquecimento cadastral

Use estes serviços para validar dados de CPF, complementar cadastros e confirmar
associações entre uma pessoa e seus dados de contato. Eles apoiam onboarding,
atualização cadastral, prevenção à fraude, análise operacional e qualificação de
bases.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

O serviço executado é definido pelo campo `service`.

## Quando usar

Use esta categoria quando precisar:

- validar se um CPF está regular na Receita Federal;
- enriquecer dados cadastrais de uma pessoa física;
- confirmar dados associados a telefone, endereço ou e-mail;
- consultar informações complementares como MEI, PIS, E-Social, Cartão SUS,
  endereços e relacionamentos econômicos.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Enriquecimento de dados de PF | `SERVICE_PERSON_DATA_ENRICHMENT` | Retorna dados cadastrais, status, filiação, nascimento, região fiscal e indicadores de unicidade do nome |
| Status do CPF na Receita Federal | `SERVICE_RFB_PF` | Consulta situação cadastral do CPF, data de nascimento, óbito e origem da informação |
| CPF na Receita Federal on-demand | `SERVICE_RFB_PF_ON_DEMAND` | Busca ou atualiza dados cadastrais do CPF no momento da requisição |
| Modelagem de dados de pessoa física | `SERVICE_PERSON_DATA_MODELING` | Consolida dados cadastrais, contatos, vínculos, processos e endereços em uma visão textual |
| Prompt de IA para pessoa | `SERVICE_PERSON_AI_PROMPT` | Gera uma leitura analítica dos dados consolidados da pessoa consultada |
| Validação de e-mail | `SERVICE_EMAIL_VALIDATION` | Verifica validade, normalização, risco, domínio descartável, spam trap e características do endereço |
| Validação de CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` | Verifica associação entre CPF e telefone e retorna taxa de correspondência |
| Validação de CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` | Verifica associação entre CPF, CEP e número do endereço |
| Consulta de MEI | `SERVICE_MEI` | Retorna empresas MEI associadas ao CPF |
| Dados PIS | `SERVICE_PIS_CONSULTATION` | Consulta dados do Programa de Integração Social quando disponível |
| Cartão SUS | `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` | Retorna os dados do Cartão Nacional de Saúde localizados para o CPF, com número do cartão, data de captura e dados de nascimento |
| Validação E-Social | `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` | Valida qualificação cadastral no E-Social, com CPF, nome, nascimento e PIS |
| Consulta de endereços | `SERVICE_ADDRESS` | Retorna endereços associados ao CPF |
| Dados pelo telefone | `SERVICE_CONFIRM_PHONE` | Retorna dados de pessoa a partir de telefone |
| Histórico de telefones | `SERVICE_PHONE_HISTORY` | Retorna telefones associados ao CPF, tipo de linha e indicação de recência |
| Histórico de e-mails | `SERVICE_EMAILS_EXTENDED` | Retorna e-mails associados ao CPF e sinais de uso, validação e prioridade |
| Pessoas relacionadas | `SERVICE_RELATED_PEOPLE` | Retorna pessoas relacionadas ao CPF e o tipo de relacionamento identificado |
| E-mails de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` | Retorna e-mails de pessoas relacionadas ao CPF, com o relacionamento identificado |
| Telefones de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` | Retorna telefones de pessoas relacionadas ao CPF, com o relacionamento identificado |
| Endereços de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` | Retorna endereços de pessoas relacionadas ao CNPJ, com o relacionamento identificado |
| TSE - Local de votação | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` | Retorna local de votação, situação eleitoral e biometria atual no TSE |
| Relacionamentos econômicos | `SERVICE_ECONOMIC_RELATIONSHIP` | Retorna vínculos econômicos associados ao CPF |
| Histórico profissional | `SERVICE_PROFESSIONAL_HISTORY` | Consulta vínculos e histórico profissional |
| Histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | Retorna vínculos profissionais em que a pessoa aparece como titular ou sócia |
| Dados financeiros e endereços PF | `SERVICE_PF_FINANCIAL_AND_ADDRESS` | Combina dados cadastrais, endereços e informações financeiras em uma única consulta |

## Exemplo rápido

Consulta de enriquecimento cadastral de pessoa física:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'
```

Payload:

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

Resposta esperada:

```json
{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "name": "NOME DA PESSOA",
    "birthdate": "1998-07-05",
    "origin": "RECEITA FEDERAL",
    "age": 24
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Como combinar os serviços

Uma validação cadastral simples costuma começar com `SERVICE_RFB_PF`. Para uma
visão mais completa, use `SERVICE_PERSON_DATA_ENRICHMENT`. Quando o objetivo for
validar contato ou entrega, combine as consultas de e-mail, telefone e endereço.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Física](/guides/servicos-pessoa-fisica).

---

# Biometria e documentos

URL: https://api-docs.idcerberus.com/guides/pessoas/biometria-e-documentos
Fonte: guides/pessoas/biometria-e-documentos.mdx
Descrição: Valide documentos, selfies, biometria facial e evidências de identidade

# Biometria e documentos

Use estes serviços para extrair dados de documentos, comparar imagens faciais,
validar vivacidade e apoiar decisões de identidade em fluxos de onboarding e KYC.
Eles ajudam a reduzir fraude documental, automatizar leitura de documentos e
verificar se a pessoa apresentada corresponde à evidência enviada.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

> Info:
  Para OCR, comece pelo guia [OCR via Service API](/guides/service-api/sobre-ocr-service-api).
  Ele reúne os payloads de RG, CNH, cartão CNPJ, emancipação e comprovante de endereço,
  além do padrão de retorno limpo em `result`.


    Extraia dados de RG, CNH, cartão CNPJ, comprovantes e documentos variáveis.


    Compare duas imagens faciais e leia o percentual de similaridade.


    Processe documento, imagem e selfie em fluxos de análise documental.


## Quando usar

Use estes serviços quando precisar:

- extrair dados de documentos por OCR;
- comparar imagens de rosto com FaceMatch;
- consultar score biométrico;
- executar documentoscopia digital e consultar o resultado depois.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| OCR React | `SERVICE_OCR` | Lê RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identifica automaticamente e retorna campos limpos dentro de `result` |
| OCR de cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | Extrai CNPJ e texto OCR do cartão CNPJ |
| OCR de comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | Extrai nome, endereço, datas e valores quando encontrados |
| OCR de emancipação | `SERVICE_OCR_EMANCIPATION` | Lê documentos variáveis de emancipação e retorna texto, campos objetivos e análise |
| FaceMatch | `SERVICE_FACE_MATCH` | Compara duas imagens e retorna status e percentual de similaridade facial |
| Score biométrico | `SERVICE_DATAVALID_CNH` | Compara CPF e selfie com bases oficiais e retorna similaridade |
| Validação de CNH no DataValid | `SERVICE_DATAVALID_CNH` | Valida dados de CNH com apoio do validação documental |
| Documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | Processa documento, extrai dados e executa FaceMatch quando houver selfie |
| Resultado da documentoscopia | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | Consulta o resultado de uma documentoscopia usando a chave enviada na criação |

## Documentos suportados no OCR

| Documento | Valor |
| --- | --- |
| CNH | `CNH` |
| RG | `RG` |
| RG novo | `NEWRG` |
| RNE | `RNE` |
| Cartão CPF | `CARTAOCPF` |
| Passaporte | `PASSPORT` |
| CRLV | `BR_CAR_LICENCE` |
| Comprovante de luz | `LIGHTRECEIPT` |
| Carteira de trabalho | `CTPS` |

## Exemplo rápido

Comparação facial entre duas imagens:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_FACE_MATCH",
    "image1": "base64",
    "image2": "base64"
  }'
```

Payload:

```json
{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}
```

Resposta esperada:

```json
{
  "result": {
    "status": "Face picture match",
    "similarity": 99.95
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Boas práticas

- Envie imagens nítidas, sem cortes no documento ou no rosto.
- Use `image1Url` e `image2Url` quando as imagens já estiverem hospedadas em URL
  acessível pelo serviço.
- Para documentos com frente e verso, envie as duas imagens quando disponível.
- Combine OCR e FaceMatch quando o fluxo exigir validação de identidade
  com maior robustez.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Física](/guides/servicos-pessoa-fisica).

---

# Risco e compliance

URL: https://api-docs.idcerberus.com/guides/pessoas/risco-e-compliance
Fonte: guides/pessoas/risco-e-compliance.mdx
Descrição: Avalie exposição, restrições, certidões, débitos e sinais de risco de pessoas físicas

# Risco e compliance

Use estes serviços para identificar sinais de risco associados a uma pessoa
física, incluindo exposição política, certidões, antecedentes, protestos, débitos,
processos, mandados e scores. Eles apoiam decisões de onboarding, crédito,
prevenção à fraude, compliance e monitoramento contínuo.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

## Quando usar

Use esta categoria quando precisar:

- verificar se a pessoa é PEP ou possui exposição pública relevante;
- consultar sanções e histórico de compliance em uma visão consolidada;
- avaliar propensão de fraude ou inadimplência;
- consultar certidões, antecedentes criminais e nada consta;
- verificar protestos, débitos ativos e processos;
- complementar uma esteira de aprovação com sinais de risco.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Pessoa politicamente exposta | `SERVICE_PEP` | Indica se o CPF pertence a uma Pessoa Politicamente Exposta |
| KYC e compliance de pessoa física | `SERVICE_PERSON_KYC` | Consolida PEP, sanções e histórico de compliance associado ao CPF |
| Exposição e perfil na mídia PF | `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` | Consulta exposição pública, notoriedade, impopularidade e notícias relacionadas ao CPF |
| Dívida ativa PF | `SERVICE_ACTIVE_DEBT_PF` | Consulta situação de dívida ativa em fontes públicas |
| Débitos ativos PF | `SERVICE_ACTIVE_DEBT_PF` | Retorna totais e lista de débitos ativos associados ao CPF |
| Score de risco de fraude | `SERVICE_FRAUD_RISK_SCORE` | Mede propensão de fraude com base em fator de risco |
| Risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` | Retorna score e leitura resumida de risco financeiro |
| Score de inadimplência | `SERVICE_DEFAULT_RISK_SCORE` | Retorna score, faixa de risco e probabilidade esperada de inadimplência |
| Score de Crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON` | Consulta score de crédito de pessoa física, com nível e classificação de risco |
| Score de Crédito Multidados | `SERVICE_BOAVISTA_ONE_SCORE_PERSON` | Consulta score de crédito multidados de pessoa física |
| Dados Restritivos | `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` | Consulta dados restritivos de crédito de pessoa física, com indicativo e quantidade de restrições |
| Flags Negativos | `SERVICE_QUOD_CREDIT_RISK_PERSON` | Consulta flags negativos de crédito de pessoa física, com nível e classificação de risco |
| Propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` | Avalia sinais de propensão a apostas online associados ao CPF |
| Nada consta em ações judiciais | `SERVICE_NOTHING_RECORD_LAWSUITS` | Emite certidão de Nada Consta em tribunais regionais federais |
| Antecedentes criminais federais | `SERVICE_CRIMINAL_RECORD_FEDERAL` | Consulta certidão de antecedentes criminais federal |
| Antecedentes criminais civis | `SERVICE_CRIMINAL_RECORD_CIVIL` | Consulta certidão de antecedentes criminais estadual |
| Certidão negativa de protesto | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` | Consulta protestos em cartórios e detalhes de títulos |
| Processos jurídicos | `SERVICE_JURIDICAL_PROCESSES` | Consulta processos jurídicos e administrativos associados ao CPF |
| Servidores públicos | `SERVICE_PUBLIC_SERVANTS` | Consulta vínculos com serviço público |
| Mandado de prisão | `SERVICE_ARREST_WARRANT` | Consulta existência de mandado de prisão |

## Exemplo rápido

Consulta de score de risco de fraude:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_FRAUD_RISK_SCORE",
    "cpf": "cpf",
    "factor": "minRisk or minattrition"
  }'
```

Payload:

```json
{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}
```

Resposta esperada:

```json
{
  "result": {
    "cpf": "80246074507",
    "score": "8.0691",
    "factor": "MEDIUM RISK",
    "message": "Success calculating score"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Leitura dos resultados

O objeto `status` indica o resultado técnico da chamada. Os sinais de negócio
ficam no objeto `result`, como status da certidão, scores, fatores de risco,
valores de dívida, protestos e indicadores encontrados. Em fluxos críticos,
combine mais de uma consulta para reduzir decisão baseada em um único sinal.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Física](/guides/servicos-pessoa-fisica).

---

# Dados eleitorais

URL: https://api-docs.idcerberus.com/guides/pessoas/dados-eleitorais
Fonte: guides/pessoas/dados-eleitorais.mdx
Descrição: Consulte candidaturas, doações, vínculos políticos e exposição eleitoral de pessoas físicas

# Dados eleitorais

Use estes serviços para avaliar exposição eleitoral e envolvimento político de
uma pessoa física. As consultas cobrem candidaturas, doações, prestação de
serviços eleitorais, histórico familiar político e indicadores agregados de
participação pública.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

## Quando usar

Use esta categoria quando precisar:

- identificar se uma pessoa já concorreu ou foi eleita;
- consultar doações eleitorais realizadas;
- avaliar envolvimento político e exposição pública;
- identificar histórico familiar político;
- consultar prestação de serviços eleitorais e possíveis relações econômicas com campanhas.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Dados eleitorais de candidato | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` | Retorna histórico eleitoral, candidaturas, partido, bens, prestação de contas e dados de campanha |
| Doações eleitorais PF | `SERVICE_ELECTORAL_DONORS_CPF` | Consulta doações eleitorais realizadas por uma pessoa e estatísticas agregadas |
| Envolvimento político | `SERVICE_POLITICAL_INVOLVEMENT` | Resume eleições, cargos, PEP, valores doados, valores recebidos e score de envolvimento político |
| Histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` | Consulta participação política de familiares e distribuições por cargo, partido e região |
| Prestadores de serviço eleitorais PF | `SERVICE_ELECTORAL_PROVIDERS_CPF` | Consulta prestação de serviços eleitorais, partidos atendidos e valores de provisões |

## Exemplo rápido

Consulta consolidada de envolvimento político:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_POLITICAL_INVOLVEMENT",
    "cpf": "cpf"
  }'
```

Payload:

```json
{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}
```

Resposta esperada:

```json
{
  "result": {
    "electionsCount": 5,
    "isCurrentlyInOffice": true,
    "wasFormerlyElected": true,
    "isPep": true,
    "amountDonated": 19804076,
    "amountReceived": 20599420,
    "politicalInvolvementScore": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Como interpretar

Esses serviços não substituem uma política interna de compliance, mas ajudam a
trazer evidências estruturadas sobre exposição pública e relações eleitorais. Use
os retornos como insumos para classificação de risco, diligência reforçada ou
monitoramento.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Física](/guides/servicos-pessoa-fisica).

---

# Dados cadastrais de empresas

URL: https://api-docs.idcerberus.com/guides/empresas/dados-cadastrais
Fonte: guides/empresas/dados-cadastrais.mdx
Descrição: Consulte situação cadastral, dados oficiais, atividades econômicas e obrigações de empresas

# Dados cadastrais de empresas

Use estes serviços para validar a existência de uma empresa, enriquecer dados de
CNPJ e consultar informações oficiais de cadastro. Eles ajudam em fluxos de
onboarding PJ, análise cadastral, atualização de base, prevenção à fraude e
validação operacional antes de liberar uma relação comercial.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

O campo `service` define qual consulta será executada.

## Quando usar

Use esta categoria quando precisar:

- confirmar a situação cadastral de um CNPJ na Receita Federal;
- recuperar razão social, nome fantasia, data de abertura, atividades e natureza jurídica;
- verificar cadastro estadual no SINTEGRA;
- consultar endereços estendidos associados ao CNPJ;
- consultar presença digital, domínios e sinais de operação online;
- consultar períodos, boletos e códigos de barras de DAS MEI ou da Arrecadação Simples Nacional - MEI;
- acompanhar o histórico de alterações cadastrais, capital social e regime tributário da empresa;
- consultar telefones, categoria comercial (MCC), presença em marketplaces, anúncios online e reputação da empresa em plataformas de avaliação;
- consultar dados de fundos de investimento vinculados ao CNPJ e a evolução temporal de capital, funcionários e sócios.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Enriquecimento de dados de PJ | `SERVICE_CORPORATE_DATA_ENRICHMENT` | Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, atividades econômicas, natureza jurídica, regime e capital |
| Status do CNPJ na Receita Federal | `SERVICE_RFB_PJ` | Consulta a situação cadastral do CNPJ e a data do status na Receita Federal |
| CNPJ na Receita Federal on-demand | `SERVICE_RFB_PJ_ON_DEMAND` | Busca ou atualiza dados cadastrais da empresa no momento da requisição |
| SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` | Consulta dados do cadastro estadual no SINTEGRA, incluindo UF, status e CFDF quando aplicável |
| Endereços estendidos de empresa | `SERVICE_ADDRESSES_EXTENDED_CNPJ` | Retorna endereços associados ao CNPJ, incluindo logradouro, bairro, cidade, UF, país, CEP e tipo de endereço |
| Doações eleitorais PJ | `SERVICE_ELECTORAL_DONORS_CNPJ` | Consulta doações eleitorais realizadas pela empresa e estatísticas agregadas |
| Fornecedores eleitorais PJ | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` | Consulta prestação de serviços eleitorais associada ao CNPJ |
| DAS MEI na Receita | `SERVICE_DAS_MEI` | Consulta períodos de DAS MEI, situação de apuração, boleto e código de barras |
| Arrecadação Simples Nacional - MEI | `SERVICE_PGMEI` | Consulta o DAS do MEI com histórico de arrecadação mensal e status de pagamento |
| Histórico de Dados Básicos | `SERVICE_HISTORY_BASIC_DATA` | Consulta o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social |
| Categoria Comercial | `SERVICE_MERCHANT_CATEGORY_DATA` | Consulta a categorização MCC da empresa, por associação direta com a Abecs ou inferida pelo CNAE |
| Telefones | `SERVICE_PHONES_EXTENDED_COMPANY` | Consulta os telefones associados à empresa, com indicadores de validade, prioridade e origem |
| Evolução da Empresa | `SERVICE_COMPANY_EVOLUTION` | Consulta a evolução temporal de capital, funcionários, filiais e sócios, com tendência de crescimento |
| Marketplaces | `SERVICE_MARKETPLACE_DATA` | Consulta a presença da empresa em marketplaces, lojas operadas, produtos listados e avaliações |
| Anúncios Online | `SERVICE_ONLINE_ADS` | Consulta anúncios online vinculados à empresa em portais de classificados e marketplaces peer-to-peer |
| Avaliações e Reputação | `SERVICE_REPUTATIONS_AND_REVIEWS` | Consulta a reputação da empresa em diferentes plataformas de avaliação, com visão consolidada e histórico |
| Dados de Fundos de Investimento | `SERVICE_INVESTMENT_FUND_DATA` | Consulta informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme CVM |

## Exemplo rápido

Consulta de enriquecimento cadastral de pessoa jurídica:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_CORPORATE_DATA_ENRICHMENT",
    "cnpj": "cnpj"
  }'
```

Payload:

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

Resposta esperada:

```json
{
  "result": {
    "cnpj": "30108283000150",
    "status": "ATIVA",
    "name": "REACT IT SOLUCOES EM TECNOLOGIA LTDA",
    "fantasyName": "REACT IT SOLUTIONS",
    "origin": "Receita Federal",
    "regime": "SIMPLES",
    "foundedDate": "2018-04-04T00:00:00Z"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Boas práticas

- Envie CNPJ sem máscara quando possível, mantendo apenas números.
- Use o enriquecimento de dados quando precisar montar uma visão cadastral
  completa da empresa.
- Use o status do CNPJ quando a necessidade for apenas validar se a empresa está
  ativa ou regular.
- Para empresas com operação estadual, combine Receita Federal e SINTEGRA.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Jurídica](/guides/servicos-pessoa-juridica).

---

# Sócios e relacionamentos

URL: https://api-docs.idcerberus.com/guides/empresas/socios-e-relacionamentos
Fonte: guides/empresas/socios-e-relacionamentos.mdx
Descrição: Analise quadro societário, vínculos empresariais, círculos de relacionamento e riscos associados a sócios

# Sócios e relacionamentos

Esta categoria reúne consultas para entender quem está por trás de uma empresa,
quais vínculos existem entre pessoas e CNPJs, e quais riscos aparecem no entorno
societário. Ela é útil para onboarding PJ, análise de beneficiário final, KYC de
sócios, avaliação de relacionamentos econômicos e investigação de vínculos
relevantes.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

## Quando usar

Use esta categoria quando precisar:

- identificar proprietários, representantes e vínculos de uma empresa;
- mapear pessoas físicas relacionadas ao CNPJ em primeiro nível;
- consultar o quadro societário-administrativo (QSA) completo da matriz na Receita Federal;
- mapear o grupo econômico e inferir o nível de influência do quadro societário;
- avaliar processos judiciais associados aos sócios, individualmente ou de forma agregada;
- consultar indicadores de PEP, sanções e histórico de compliance dos sócios.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Relacionamentos de uma empresa | `SERVICE_COMPANY_RELATIONSHIP` | Retorna vínculos da empresa, incluindo proprietários, empregados, empresas possuídas e relacionamentos com pessoas |
| Sócios na Receita Federal | `SERVICE_COMPANY_RFB_OWNERS` | Retorna dados cadastrais dos sócios identificados na Receita Federal |
| Sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` | Resume círculos de pessoas físicas relacionadas ao CNPJ, com métricas de idade, renda, localização, processos e distribuições |
| Receita Federal - QSA | `SERVICE_RF_QSA` | Consulta o quadro societário-administrativo do CNPJ, com dados cadastrais da matriz e a lista de sócios e administradores |
| Relacionamentos do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` | Consulta entidades (pessoas e empresas) que integram o mesmo grupo econômico do CNPJ, com relacionamentos atuais e históricos |
| Influência do Quadro Societário | `SERVICE_OWNERS_INFLUENCE` | Infere o nível de influência do quadro societário, considerando exposição na mídia, envolvimento político e processos dos sócios |
| Distribuição de Processos dos Sócios | `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` | Consulta dados agregados sobre a distribuição de processos judiciais nos quais os sócios da empresa estão envolvidos |
| Processos jurídicos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` | Consulta processos associados aos sócios e agrupa indicadores por documento |
| KYC e compliance dos sócios | `SERVICE_COMPANY_KYC_OWNERS` | Consulta exposição a PEP, sanções atuais e históricas, e ocorrências relevantes no quadro societário |
| Doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` | Consulta doações eleitorais realizadas por sócios vinculados ao CNPJ |

## Exemplo rápido

Consulta de relacionamentos de uma empresa:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_COMPANY_RELATIONSHIP",
    "cnpj": "cnpj"
  }'
```

Payload:

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

Resposta esperada:

```json
{
  "result": {
    "cnpj": "99244297000106",
    "relationshipTotal": 1,
    "totalOwners": 1,
    "totalEmployees": 1,
    "companyRelationships": [
      {
        "cpf": "77272722314",
        "name": "NOME DO SÓCIO",
        "relationshipName": "SOCIO-ADMINISTRADOR",
        "origin": "RECEITA FEDERAL"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

## Como combinar os serviços

Uma análise PJ costuma começar com `SERVICE_COMPANY_RELATIONSHIP` para entender a
estrutura da empresa. Em seguida, `SERVICE_FIRST_LEVEL_PARTNER` ajuda a resumir o
entorno societário. Quando houver necessidade de aprofundar risco, use
`SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` e `SERVICE_COMPANY_KYC_OWNERS`.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Jurídica](/guides/servicos-pessoa-juridica).

---

# Compliance de empresas

URL: https://api-docs.idcerberus.com/guides/empresas/compliance
Fonte: guides/empresas/compliance.mdx
Descrição: Consulte débitos, protestos, restrições e exposições regulatórias de empresas

# Compliance de empresas

Os serviços de compliance de empresas apoiam a identificação de riscos
financeiros, regulatórios e reputacionais ligados a CNPJs. Eles podem ser usados
em onboarding PJ, monitoramento de fornecedores, avaliação de terceiros,
processos de crédito, prevenção à fraude e rotinas de PLD/FT.

Todos os serviços desta categoria são consumidos pelo endpoint:

```http
POST /api/service-api
```

## Quando usar

Use esta categoria quando precisar:

- verificar débitos ativos de uma empresa com órgãos públicos;
- consultar protestos em cartórios;
- avaliar exposição pública e notícias relacionadas aos sócios;
- avaliar exposição e conformidade de empresas relacionadas ao mercado de apostas;
- identificar os beneficiários finais e o percentual de participação societária;
- consultar certidões negativas federais e estaduais (PGFN, CGU, CNJ, débitos estaduais, PCD, Simples Nacional);
- avaliar KYC agregado do grupo econômico completo da empresa;
- complementar uma análise cadastral com sinais de risco e restrição.

## Serviços disponíveis

| Serviço | Código `service` | Uso principal |
| --- | --- | --- |
| Débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` | Consulta débitos ativos da empresa com o governo e retorna totais, origens e lista de débitos |
| Certidão negativa de protesto PJ | `SERVICE_PROTEST_PJ` | Consulta protestos em cartórios e retorna detalhes de títulos encontrados |
| Exposição e perfil na mídia dos sócios | `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` | Consulta exposição pública, notoriedade, impopularidade e notícias relacionadas aos sócios da empresa |
| Compliance de casas de apostas PJ | `SERVICE_COMPLIANCE_BET_PJ` | Consulta exposição esportiva, relação com apostas, dados cadastrais e sinais regulatórios de empresas do setor |
| FGTS | `SERVICE_FGTS` | Consulta a certidão de regularidade do empregador perante o FGTS |
| Ações Trabalhistas | `SERVICE_LABOR_LAWSUITS` | Consulta certidão on-demand informando se há processos trabalhistas relacionados à empresa |
| Distribuição de Processos Judiciais | `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` | Consulta dados agregados sobre a distribuição de processos judiciais nos quais a empresa está envolvida |
| KYC e Compliance dos Funcionários | `SERVICE_EMPLOYEES_KYC` | Consulta indicadores de KYC e compliance regulatório dos funcionários, incluindo PEP e sanções nacionais e internacionais |
| Acordos Sindicais | `SERVICE_SYNDICATE_AGREEMENTS` | Consulta os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários |
| Score de Crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY` | Consulta score de crédito de pessoa jurídica pelo CNPJ, com nível e classificação de risco |
| Score de Crédito Multidados PJ | `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` | Consulta score de crédito multidados de pessoa jurídica pelo CNPJ |
| Dados Restritivos PJ | `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` | Consulta dados restritivos de crédito de pessoa jurídica, com indicativo e quantidade de restrições |
| Flags Negativos PJ | `SERVICE_QUOD_CREDIT_RISK_COMPANY` | Consulta flags negativos de crédito de pessoa jurídica, com nível e classificação de risco |
| Score de Crédito Quantum PJ | `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` | Consulta score de crédito Quantum de pessoa jurídica pelo CNPJ |
| Beneficiários Finais | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` | Identifica os beneficiários finais da empresa, com percentual de participação acumulado por cadeias indiretas |
| Percentual de Participação Societária | `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` | Consulta o percentual de participação societária de cada sócio da empresa |
| Débitos com a PGFN | `SERVICE_PGFN_COMPANY` | Consulta certidão de débitos tributários federais e dívida ativa da união junto à PGFN |
| Cota de PCD | `SERVICE_PCD_COMPANY` | Consulta certidão de cumprimento da cota legal de PCD e beneficiários reabilitados |
| Certidão Negativa Correcional CGU | `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` | Consulta punições vigentes em CEIS, CNEP e CEPIM |
| Certidão Negativa CNJ | `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` | Consulta condenações cíveis por improbidade administrativa e inelegibilidade |
| Certidão Negativa de Débitos Estaduais | `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` | Consulta débitos estaduais, disponível para todos os estados |
| Optante pelo Simples Nacional | `SERVICE_SIMPLES_COMPANY` | Consulta situação como optante pelo Simples Nacional e pelo SIMEI |
| KYC e Compliance do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` | Consulta indicadores agregados de PEP e sanções do grupo econômico completo |

## Exemplo rápido

Consulta de compliance de casas de apostas PJ:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_COMPLIANCE_BET_PJ",
    "cnpj": "cnpj"
  }'
```

Payload:

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

Resposta esperada:

```json
{
  "result": {
    "cnpj": "00000000000000",
    "status": "ATIVA",
    "origin": "Receita Federal",
    "officialName": "NOME OFICIAL ANONIMIZADO",
    "tradeName": "NOME FANTASIA ANONIMIZADO",
    "isBet": false,
    "onlineBettingCompliance": []
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}
```

## Leitura dos resultados

O objeto `status` indica o resultado técnico da consulta. Os sinais de negócio
ficam no objeto `result`, como valores de dívida, protestos, vínculos, exposição
regulatória e indicadores de conformidade. Em análises críticas, combine esses
serviços com dados cadastrais e relacionamentos societários.

Para campos, exemplos completos e responses, consulte a
[API Reference](/api-reference/autorização/gerar-token-de-api) ou o
[Catálogo técnico de Pessoa Jurídica](/guides/servicos-pessoa-juridica).

---

# Serviços de Pessoa Física

URL: https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica
Fonte: guides/servicos-pessoa-fisica.mdx
Descrição: Serviços externos disponíveis para consultas de CPF

# Serviços de Pessoa Física

Os serviços de pessoa física permitem consultar, validar e enriquecer dados de
CPF em fluxos de onboarding, KYC, prevenção à fraude, análise cadastral,
biometria, documentos, compliance e dados eleitorais.

Todos são executados pelo endpoint central de serviços. O campo `service`
define qual produto será processado, e os demais campos variam conforme a
consulta escolhida.

Antes de montar o body, confira no produto do cliente qual alias está liberado.
Esse é o valor que deve ir no campo `service`.

```http
POST /api/service-api
```

Nos exemplos de `curl`, `{base_url}` representa a URL do ambiente escolhido:

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

Exemplo de requisição:

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

## Como usar este catálogo

Esta é a referência técnica completa de pessoa física — use-a quando precisar
do contrato completo de um service. Para navegar por objetivo ou família de
produto primeiro, veja
[Escolha o serviço certo](/guides/escolha-o-servico-certo),
[Matriz de serviços](/guides/matriz-de-servicos) ou
[Famílias de serviços](/guides/service-api/familias-de-servicos).

Use esta página para consultar a lista completa de serviços de CPF, seus códigos
`service`, campos principais e exemplos mais extensos de request e response.

> Atencao:
  O catálogo mostra o nome funcional e o alias documentado do service. Se o
  produto do cliente tiver sido configurado com alias curto, use o alias do
  produto no campo `service`. Isso evita erro de acesso mesmo quando o produto
  está ativo.

Passo rápido para evitar erro:

1. Abra o produto do cliente no Backoffice.
2. Confirme o alias liberado para o serviço.
3. Envie esse alias no campo `service`.
4. Use os demais campos da tabela como entrada principal da consulta.

| Alias documentado | Alias curto do produto |
| --- | --- |
| `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `SERVICE_DOCUMENTOSCOPY` |
| `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `SERVICE_DIGITAL_DOCUMENTOSCOPY` |
| `SERVICE_ECONOMIC_RELATIONSHIP` | `economic_relationships` |
| `SERVICE_EMAIL_VALIDATION` | `SERVICE_EMAIL_VALIDATION1` |
| `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`, `SERVICE_PROTEST_PF` | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` |

> Info:
  OCR, documentoscopia, FaceMatch e Liveness precisam de imagem/base64, URL ou
  `key` real para retornar dados completos. Payload curto ajuda a validar
  autenticação, acesso ao produto e formato básico da chamada, mas não valida o
  retorno completo do processamento.

## Guias relacionados

| Guia | Quando usar |
| --- | --- |
| [Escolha o serviço certo](/guides/escolha-o-servico-certo) | Para decidir o service pelo caso de uso. |
| [Famílias de serviços](/guides/service-api/familias-de-servicos) | Para navegar por grupo de produto. |
| [OCR via Service API](/guides/service-api/sobre-ocr-service-api) | Para payloads de documento, imagem, base64 e exemplos de retorno. |
| [API Reference](/api-reference/autorização/gerar-token-de-api) | Para detalhes endpoint a endpoint. |

## Status e erros

No retorno das consultas, a API inclui um objeto `status` que indica o status da
consulta. Esse objeto apresenta os atributos `code` e `message`, usados para
interpretar o processamento técnico.

```json
{
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

Para detalhes de tratamento, consulte [Status e erros](/guides/status-e-erros).

## Serviços disponíveis

### Cadastro e identidade

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| Enriquecimento de dados de PF | `SERVICE_PERSON_DATA_ENRICHMENT` | `cpf` |
| Status do CPF na Receita Federal | `SERVICE_RFB_PF` | `cpf`, `dataDeNascimento` |
| CPF na Receita Federal on-demand | `SERVICE_RFB_PF_ON_DEMAND` | `cpf` |
| Modelagem de dados de pessoa física | `SERVICE_PERSON_DATA_MODELING` | `cpf` |
| Prompt de IA para pessoa | `SERVICE_PERSON_AI_PROMPT` | `cpf` |
| Consulta de MEI | `SERVICE_MEI` | `cpf` |
| Dados pelo telefone | `SERVICE_CONFIRM_PHONE` | `phone` |
| Endereços | `SERVICE_ADDRESS` | `cpf` |
| Histórico de telefones | `SERVICE_PHONE_HISTORY` | `cpf`, `birthDate`, `limit` |
| Pessoas relacionadas | `SERVICE_RELATED_PEOPLE` | `cpf`, `birthDate` |
| Histórico de e-mails | `SERVICE_EMAILS_EXTENDED` | `cpf`, `limit` |
| Relacionamentos econômicos | `SERVICE_ECONOMIC_RELATIONSHIP` | `cpf` |
| Histórico profissional | `SERVICE_PROFESSIONAL_HISTORY` | `cpf` |
| Histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | `cpf`, `birthDate` |
| Dados financeiros e endereços PF | `SERVICE_PF_FINANCIAL_AND_ADDRESS` | `cpf`, `birthDate` |
| Dados demográficos | `SERVICE_DEMOGRAPHIC_DATA_CPF` | `cpf`, `birthDate` |
| Indicadores de atividades | `SERVICE_ACTIVITIES_INDICATORS` | `cpf` |
| Domínios PF | `SERVICE_DOMAINS_CPF` | `cpf` |
| Cartão SUS | `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` | `cpf` |
| E-mails de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` | `cpf` |
| Telefones de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` | `cpf` |
| Endereços de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` | `cnpj` |
| TSE - Local de votação | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` | `cpf`, `birthDate`, `motherName` |

### Biometria e documentos

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| OCR React | `SERVICE_OCR` | `documentType`, `image1`, `image2` |
| OCR de emancipação | `SERVICE_OCR_EMANCIPATION` | `image1` |
| OCR de comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | `image1` |
| Busca de face na base | `SERVICE_FACE_INDEX` | `image1` |
| FaceMatch | `SERVICE_FACE_MATCH` | `image1`, `image2` |
| Score biométrico / Validação de CNH no DataValid | `SERVICE_DATAVALID_CNH` | `cpf`, `image1` |
| Documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `key`, `image1`, `image2`, `selfie1` |
| Resultado da documentoscopia | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `key` |

### Risco, compliance e validações

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| Pessoa politicamente exposta | `SERVICE_PEP` | `cpf` |
| KYC e compliance de pessoa física | `SERVICE_PERSON_KYC` | `cpf`, `birthDate` |
| Exposição e perfil na mídia PF | `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` | `cpf` |
| Dívida ativa PF / Débitos ativos PF | `SERVICE_ACTIVE_DEBT_PF` | `cpf` |
| Score de risco de fraude | `SERVICE_FRAUD_RISK_SCORE` | `cpf`, `factor` |
| Risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` | `cpf`, `birthDate` |
| Score de inadimplência | `SERVICE_DEFAULT_RISK_SCORE` | `cpf` |
| Score de crédito | `SERVICE_CREDIT_SCORE` | `cpf` |
| Score de Crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON` | `cpf` |
| Score de Crédito Multidados | `SERVICE_BOAVISTA_ONE_SCORE_PERSON` | `cpf` |
| Dados Restritivos | `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` | `cpf` |
| Flags Negativos | `SERVICE_QUOD_CREDIT_RISK_PERSON` | `cpf` |
| Nada consta em ações judiciais | `SERVICE_NOTHING_RECORD_LAWSUITS` | `cpf`, `court`, `uf`, `sphere` |
| Antecedentes criminais federais | `SERVICE_CRIMINAL_RECORD_FEDERAL` | `cpf` |
| Antecedentes criminais civis | `SERVICE_CRIMINAL_RECORD_CIVIL` | `cpf`, `rg`, `uf` |
| Certidão negativa de protesto | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` | `cpf` |
| Validação de e-mail | `SERVICE_EMAIL_VALIDATION` | `email` |
| Validação de CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` | `cpf`, `phone` |
| Validação de CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` | `cpf`, `zipcode`, `numberAddress` |
| Informações financeiras | `SERVICE_FINANCIAL_INFORMATION` | `cpf` |
| Dados PIS | `SERVICE_PIS_CONSULTATION` | `cpf` |
| Prêmios e certificações | `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF` | `cpf` |
| Benefícios sociais familiares | `SERVICE_FAMILY_SOCIAL_BENEFITS` | `cpf` |
| Benefícios sociais estendidos | `SERVICE_SOCIAL_ASSISTANCE_EXTENDED` | `cpf` |
| Validação E-Social | `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` | `cpf`, `nit` |
| Processos jurídicos | `SERVICE_JURIDICAL_PROCESSES` | `cpf` |
| Servidores públicos | `SERVICE_PUBLIC_SERVANTS` | `cpf` |
| Propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` | `cpf` |
| Mandado de prisão | `SERVICE_ARREST_WARRANT` | `nome`, `motherName`, `fatherName`, `birthDate`, `cpf` |
| Dados eleitorais de candidato | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` | `cpf` |
| Doações eleitorais PF | `SERVICE_ELECTORAL_DONORS_CPF` | `cpf` |
| Envolvimento político | `SERVICE_POLITICAL_INVOLVEMENT` | `cpf` |
| Envolvimento político PF | `SERVICE_POLITICAL_INVOLVEMENT_CPF` | `cpf` |
| Histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` | `cpf` |
| Prestadores de serviço eleitorais PF | `SERVICE_ELECTORAL_PROVIDERS_CPF` | `cpf` |

## Consultas avançadas adicionadas

Alguns serviços retornam informações consolidadas ou análises derivadas de
fontes complementares. Eles seguem o mesmo padrão de chamada do endpoint
`POST /api/service-api`, mas podem ter respostas mais amplas conforme a
disponibilidade dos dados na consulta.

| Serviço | Quando usar | Exemplo de body |
| --- | --- | --- |
| `SERVICE_RFB_PF_ON_DEMAND` | Buscar o CPF na Receita Federal em tempo de consulta | `{ "service": "SERVICE_RFB_PF_ON_DEMAND", "cpf": "cpf" }` |
| `SERVICE_PERSON_DATA_MODELING` | Consolidar dados de modelagem, contatos, vínculos, processos e endereços | `{ "service": "SERVICE_PERSON_DATA_MODELING", "cpf": "cpf" }` |
| `SERVICE_PERSON_AI_PROMPT` | Gerar resumo analítico textual a partir dos dados consolidados da pessoa | `{ "service": "SERVICE_PERSON_AI_PROMPT", "cpf": "cpf" }` |
| `SERVICE_DATAVALID_CNH` | Validar CNH com apoio do validação documental | `{ "service": "SERVICE_DATAVALID_CNH", "cpf": "cpf", "image1": "base64" }` |
| `SERVICE_FINANCIAL_RISK_SCORE` | Consultar score de risco financeiro | `{ "service": "SERVICE_FINANCIAL_RISK_SCORE", "cpf": "cpf" }` |
| `SERVICE_PF_FINANCIAL_AND_ADDRESS` | Combinar dados cadastrais, endereços e informações financeiras | `{ "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "cpf": "cpf" }` |
| `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | Retornar histórico profissional em que a pessoa aparece como titular ou sócia | `{ "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "cpf": "cpf" }` |
| `SEVICE_ONLINE_BETTING_PROPENSITY` | Avaliar propensão a apostas online | `{ "service": "SEVICE_ONLINE_BETTING_PROPENSITY", "cpf": "cpf" }` |

> Atencao:
  O alias `SEVICE_ONLINE_BETTING_PROPENSITY` está documentado sem a
  letra `R` em `SERVICE` porque essa é a grafia implementada no backend. Não
  altere essa grafia sem validação técnica, pois a chamada pode deixar de ser
  reconhecida.

## Exemplos

### Enriquecimento de dados de pessoa física

A consulta de enriquecimento de dados de pessoa física retorna informações de
uma pessoa física existente no site da Receita Federal. O retorno pode incluir
status cadastral, protocolo da consulta, indicação de óbito quando disponível e
outras informações relacionadas ao CPF consultado.

As informações dessa consulta são obtidas a partir da consulta pública de pessoa
física no site da Receita Federal.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Body:

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status na base da Receita Federal |
| `result.statusDate` | Data do status na base da Receita Federal |
| `result.name` | Nome |
| `result.fatherName` | Nome do pai |
| `result.motherName` | Nome da mãe |
| `result.birthdate` | Data de nascimento |
| `result.birthCountry` | País de nascimento |
| `result.dead` | Indicação de óbito |
| `result.deathYear` | Ano do óbito |
| `result.gender` | Gênero |
| `result.age` | Idade |
| `result.origin` | Origem das informações |
| `result.fiscalRegion` | Região fiscal do CPF |
| `result.numberOfPeopleWithTheSameName` | Quantidade de pessoas com o mesmo nome completo |
| `result.nameWordCount` | Quantidade de nomes no nome completo |
| `result.nameUniqueScore` | Score de unicidade do nome, em que `1` indica único e `0` extremamente comum |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "statusDate": "2022-05-29T00:00:00",
    "name": "NOME DA PESSOA",
    "gender": "M",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1998-07-05",
    "birthCountry": "BRASILEIRA",
    "dead": false,
    "country": "BRAZIL",
    "fiscalRegion": "DF-GO-MS-MT-TO",
    "numberOfPeopleWithTheSameName": "3",
    "nameWordCount": "3",
    "nameUniqueScore": "0.994",
    "origin": "RECEITA FEDERAL",
    "age": 24
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Status do CPF na Receita Federal

A consulta de status do CPF na Receita Federal retorna a situação cadastral de
um CPF existente na base pública da Receita Federal.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Body:

```json
{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status na base da Receita Federal |
| `result.statusDate` | Data do status na base da Receita Federal |
| `result.origin` | Origem das informações |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_RFB_PF",
    "cpf": "cpf",
    "dataDeNascimento": "yyyy-MM-dd (opcional) "
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "123414124",
    "status": "REGULAR",
    "name": "NOME EXEMPLO",
    "birthDate": "yyyy-MM-ddT00:00",
    "dead": false,
    "origin": "RECEITA FEDERAL",
    "age": 30
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  },
  "externalId": "1782ea0a-8663-41a8-b156-688527f5363b"
}
```

### CPF na Receita Federal on-demand

Executa a consulta do CPF na Receita Federal em modo on-demand. Use quando for
necessário buscar ou atualizar os dados cadastrais diretamente no momento da
requisição.

```json
{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "123414124",
    "status": "REGULAR",
    "name": "NOME EXEMPLO",
    "birthDate": "1994-05-21T00:00",
    "dead": false,
    "origin": "RECEITA FEDERAL",
    "age": 30
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Modelagem de dados de pessoa física

Consolida informações de modelagem, histórico de telefones, processos,
relacionamentos econômicos, histórico profissional e endereços para apoiar
análises mais completas de uma pessoa.

```json
{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}
```

Exemplo de resposta:

```json
{
  "result": {
    "modelData": "Dados de modelagem consolidados para o CPF consultado."
  },
  "results": [
    {
      "modelData": "Dados de modelagem consolidados para o CPF consultado."
    }
  ],
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Prompt de IA para pessoa

Gera um resumo analítico a partir de dados consolidados da pessoa consultada.
Esse serviço é útil quando a integração precisa transformar múltiplos sinais em
uma explicação textual estruturada.

```json
{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}
```

Exemplo de resposta:

```json
{
  "result": {
    "modelData": "Resumo analítico gerado a partir dos dados consolidados da pessoa consultada."
  },
  "results": [
    {
      "modelData": "Resumo analítico gerado a partir dos dados consolidados da pessoa consultada."
    }
  ],
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### OCR React

Use `SERVICE_OCR` para extrair dados de documentos de identificação como RG/CIN,
CNH, OAB, RNE/CRNM e PASSAPORTE. Para deixar a API identificar o documento,
envie `documentType: IDENTIFICATION_DOCUMENT`.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Body:

```json
{
  "service": "SERVICE_OCR",
  "documentType": "CNH",
  "image1": "base64"
}
```

Tipos de documento suportados:

| Documento | Valor |
| --- | --- |
| CNH | `CNH` |
| RG / CIN | `RG` |
| OAB | `OAB` |
| RNE / CRNM | `RNE` |
| Passaporte | `PASSAPORT` |
| Identificação automática | `IDENTIFICATION_DOCUMENT` |

Para respostas completas por tipo de documento, consulte
[Documentos de identificação](/guides/service-api/identificacao-de-documentos).

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_OCR",
    "documentType": "CNH",
    "image1": "base64"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "06319423196",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthDate": "1992-01-05",
    "cnhCategory": "AB",
    "cnhNumber": "07796497926",
    "emissionPlace": "DETRAN DE",
    "rg": "3451620",
    "rgIssuer": "SSP/UF",
    "cnhIssueDate": "2020-04-13",
    "renach": "DF767732467",
    "state": "DF"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}
```

### FaceMatch

Esse serviço compara duas imagens e retorna a similaridade entre as pessoas nas
imagens. As imagens podem ser enviadas em base64 ou por URL, conforme a
integração.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Body:

```json
{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.status` | Status da similaridade facial das imagens |
| `result.similarity` | Similaridade facial das imagens |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FACE_MATCH",
    "image1": "base64",
    "image2": "base64"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "status": "Face picture match",
    "similarity": 99.95
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Pessoa politicamente exposta

Consulta o CPF de um indivíduo e retorna se a pessoa é politicamente exposta.

```json
{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status indicando se a pessoa é politicamente exposta |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PEP",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "74768289096",
    "status": "Pessoa não exposta politicamente"
  },
  "status": {
    "code": 200,
    "message": "success"
  }
}
```

### KYC e compliance de pessoa física

Consolida sinais de compliance de uma pessoa física, incluindo exposição PEP,
sanções atuais e histórico de ocorrências encontradas nas bases consultadas.

```json
{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF consultado |
| `result.isPep` | Indica se a pessoa é politicamente exposta |
| `result.isCurrentlySanctioned` | Indica se existe sanção vigente associada à pessoa |
| `result.sanctionsHistory` | Histórico de sanções encontradas |
| `result.pepHistories` | Histórico de exposição PEP |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "12345678901",
    "isPep": false,
    "isCurrentlySanctioned": false,
    "sanctionsHistory": [],
    "pepHistories": []
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}
```

### Exposição e perfil na mídia de pessoa física

Consulta exposição pública e perfil de mídia associado ao CPF, incluindo nível
de exposição, celebridade, impopularidade, unicidade do nome e notícias
relacionadas quando disponíveis.

```json
{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF consultado |
| `result.mediaExposureLevel` | Nível de exposição em mídia |
| `result.celebrityLevel` | Nível de notoriedade pública |
| `result.unpopularityLevel` | Nível de impopularidade |
| `result.fullName` | Nome completo retornado |
| `result.shortName` | Nome curto retornado |
| `result.fullNameUniquenessScore` | Score de unicidade do nome completo |
| `result.shortNameUniquenessScore` | Score de unicidade do nome curto |
| `result.newsItems` | Notícias relacionadas encontradas |

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "12345678901",
    "mediaExposureLevel": "MEDIUM",
    "celebrityLevel": "LOW",
    "unpopularityLevel": "LOW",
    "fullName": "NOME EXEMPLO",
    "shortName": "NOME EXEMPLO",
    "fullNameUniquenessScore": 0.98,
    "shortNameUniquenessScore": 0.91,
    "newsItems": [
      {
        "title": "Notícia de exemplo",
        "url": "https://www.exemplo.com/noticia",
        "publicationDate": "2024-01-15",
        "sentimentAnalysis": "NEUTRAL"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}
```

### Dívida ativa - Pessoa Física

Consulta a situação dos débitos relativos a créditos tributários federais e à
Dívida Ativa da União, disponível na Receita Federal e na Procuradoria-Geral da
Fazenda Nacional (PGFN).

```json
{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status da dívida ativa |
| `result.statusDate` | Data do status |
| `result.origin` | Origem do status |
| `result.validDate` | Data de validade |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_ACTIVE_DEBT_PF",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "88154726068",
    "status": "NEGATIVA",
    "statusDate": "2022-08-16",
    "origin": "Receita-Federal PGFN",
    "validDate": "0001-01-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Score de risco de fraude

O score de risco de fraude mede a propensão de fraude de uma interação associada
a um CPF. Essa propensão é calculada a partir de inferência estatística baseada
em informações históricas de fraude e apoia decisões de prevenção à fraude e
análise de risco.

```json
{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.score` | Score de risco de fraude |
| `result.factor` | Status de risco retornado pela DataRisk: `HIGH RISK`, `MEDIUM RISK` ou `LOW RISK` |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FRAUD_RISK_SCORE",
    "cpf": "cpf",
    "factor": "minRisk or minattrition"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "score": "8.0691",
    "factor": "MEDIUM RISK",
    "message": "Success calculating score"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Risco financeiro

Calcula um score de risco financeiro para o CPF informado. A resposta retorna o
score normalizado e uma mensagem com a leitura resumida da análise.

```json
{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF consultado |
| `result.score` | Score calculado |
| `result.message` | Mensagem com score e interpretação de risco |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "score": "650",
    "message": "Score: 650 | Análise: RISCO MÉDIO"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Score de inadimplência

O score de inadimplência identifica o nível de risco de inadimplência de um
cliente ou prospecto. O resultado varia de 0 a 1000; quanto maior o valor, menor
o risco de inadimplência.

```json
{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.score` | Score de inadimplência |
| `result.origin` | Origem do score |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_DEFAULT_RISK_SCORE",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "{80246074507}",
    "status": "REGULAR",
    "origin": "Datarisk",
    "score": "462",
    "rank": "E",
    "expectedDefault": "58.94%",
    "processType": "SEM PROCESSOS"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Score biométrico

A consulta de score biométrico compara um CPF e uma selfie com imagens presentes
em bases do Governo Federal, como CPF, CNPJ e CNH. O retorno indica o índice de
similaridade encontrado.

```json
{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}
```

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status da consulta do score biométrico |
| `result.message` | Mensagem da consulta |
| `result.similarity` | Score de similaridade da imagem com a base do Governo Federal |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_DATAVALID_CNH",
    "cpf": "cpf",
    "image1": "{base64Image}"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "73583960149",
    "status": "Altíssima probabilidade",
    "message": "Biometrics exist at the base of the Government",
    "similarity": 99.66
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Validação de CNH no DataValid

Valida dados de CNH com apoio do validação documental. O serviço recebe o CPF e a
imagem de referência, normalmente em base64, para executar a validação
disponível na integração.

```json
{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "base64"
}
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "73583960149"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

> Nota:
  Atualmente, o retorno exposto por este serviço pode ser mínimo e variar
  conforme a disponibilidade da integração validação documental. Use o status da
  chamada e os campos retornados em `result` como contrato efetivo da resposta.

### Certidão de Nada Consta - Ações Judiciais

Emite uma certidão de Nada Consta em tribunais regionais federais. Na esfera
eleitoral, a consulta está disponível apenas para fontes do TRF1 e TRF4.

```json
{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}
```

Parâmetros opcionais:

| Campo | Descrição |
| --- | --- |
| `court` | Tribunal: `TRF1`, `TRF2`, `TRF3`, `TRF4` ou `TRF5` |
| `uf` | UF da federação brasileira |
| `sphere` | Esfera: `CIVIL`, `CRIMINAL` ou `ELEITORAL` |

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status do Nada Consta |
| `result.origin` | Origem do Nada Consta |
| `result.uf` | UF do Nada Consta, quando retornado com essa nomenclatura |
| `result.state` | Tribunal ou estado retornado no exemplo da API |
| `result.name` | Nome do indivíduo |
| `result.certificateNumber` | Número da certidão |
| `result.certificateText` | Texto da certidão |
| `result.expirationDate` | Data de expiração |
| `result.emissionDate` | Data de emissão |
| `result.type` | Tipo da certidão |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
    "cpf": "cpf",
    "court": "TRF1",
    "uf": "uf",
    "sphere": "CIVIL"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "origin": "NadaConsta",
    "state": "TRF1",
    "name": "Fulano",
    "certificateNumber": "212312312311231",
    "certificateText": "A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998",
    "expirationDate": "2022-10-20",
    "emissionDate": "2022-10-20",
    "type": "CIVEL E CRIMINAL"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Certidão de antecedentes criminais - Federal

Emite uma certidão de antecedentes criminais junto à Polícia Federal. Quando não
há antecedentes, o status do resultado retorna como `NADA CONSTA`.

```json
{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}
```

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status da certidão criminal |
| `result.expirationDate` | Data de expiração da certidão |
| `result.certificateNumber` | Número da certidão criminal |
| `result.certificateText` | Texto da certidão criminal |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "certificateNumber": "79222652022",
    "certificateText": "A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998",
    "expirationDate": "2022-10-20"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Certidão de antecedentes criminais - Civil

Emite uma certidão de antecedentes criminais junto à Polícia Civil do estado
consultado. Caso a pessoa não possua antecedentes, o status do resultado retorna
como `NADA CONSTA`. Quando houver antecedentes, a descrição dos registros não é
retornada por essa consulta.

```json
{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}
```

Parâmetros aceitos:

| Campo | Descrição | Valor aceito |
| --- | --- | --- |
| `cpf` | Número do CPF | Qualquer texto |
| `rg` | Número do RG da identidade | Qualquer texto |
| `uf` | UF do estado | Qualquer texto |
| `motherName` | Nome da mãe | Qualquer texto |
| `fatherName` | Nome do pai | Qualquer texto |
| `rgIssuingAgency` | Órgão emissor do documento | Qualquer texto |
| `rgIssuingUf` | Estado do órgão emissor do documento | Qualquer texto |
| `rgExpeditionDate` | Data de emissão do documento | Qualquer data válida |
| `dateFormat` | Formato da data de emissão do documento | Exemplo: `yyyy-MM-dd` |
| `placeOfBirth` | Local de nascimento | Qualquer texto |
| `address` | Endereço | Qualquer texto |
| `numberAddress` | Número do endereço | Qualquer número |
| `zipcode` | CEP | Qualquer texto |
| `neighborhood` | Bairro | Qualquer texto |
| `city` | Cidade | Qualquer texto |

Obrigatoriedade de parâmetros por estado:

| Estado | CPF | UF | RG | MOTHERNAME | FATHERNAME | RGISSUINGAGENCY | RGISSUINGUF | RGEXPEDITIONDATE | DATEFORMAT | PLACEOFBIRTH | ADDRESS | NUMBERADDRESS | NEIGHBORHOOD | CITY | ZIPCODE |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| MG | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | - | - | - | - | - | - | - | - | - | - |
| CE | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | - | - | - | - | - | - | - | - | - | - |
| RR | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | - | - | - | - | - | - | - | - | - | - |
| MT | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | Obrigatório | Obrigatório | - | - | Obrigatório | - | - | - | - | - |
| RJ | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | Obrigatório | - | Obrigatório | - | - | Semi-obrigatório | Semi-obrigatório | Semi-obrigatório | Semi-obrigatório | Semi-obrigatório |
| PE | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | Obrigatório | Obrigatório | - | - | Obrigatório | Semi-obrigatório | - | Semi-obrigatório | Semi-obrigatório | - |
| PA | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | - | Obrigatório | - | - | Obrigatório | - | - | - | - | - |
| MS | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | - | Obrigatório | Obrigatório | - | - | - | - | - | - | - | - |
| SE | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | - | - | - | - | - | - | - | - | - | - |
| BA | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | - | - | - | - | - | - | - | - | - | - |
| SP | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | - | - | Obrigatório | Obrigatório | - | - | - | - | - | - |
| ES | Obrigatório | Obrigatório | Obrigatório | Semi-obrigatório | Opcional | - | Obrigatório | - | - | - | - | - | - | - | - |
| RS | Obrigatório | Obrigatório | Obrigatório | - | - | - | - | - | - | - | - | - | - | - | - |

Estados disponíveis para consulta: `BA`, `CE`, `ES`, `MG`, `MS`, `MT`, `PA`,
`PE`, `RJ`, `RR`, `RS`, `SE` e `SP`.

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status da certidão criminal |
| `result.uf` | UF consultada |
| `result.emissionDate` | Data de emissão da certidão |
| `result.expirationDate` | Data de expiração da certidão, quando retornada |
| `result.certificateNumber` | Número da certidão criminal |
| `result.certificateText` | Texto da certidão criminal |
| `result.origin` | Origem da certidão |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
    "cpf": "cpf",
    "rg": "rg",
    "uf": "uf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "uf": "BA",
    "emissionDate": "00:00 de 20/12/2022",
    "certificateNumber": "A5FD4A36-3F31-4F75-8AF0-103B7BB66212",
    "certificateText": "Antecedentes Criminais CERTIFICADO DE ANTECEDENTES CRIMINAIS Nome: NOME DA PESSOA Número do Rg: 14781688 Nome do Pai: NOME DO PAI Nome da Mãe: NOME DA MÃE Data de Nascimento: 19/6/1997 Naturalidade: \"Certifico que o requerente acima qualificado NÃO registra antecedentes criminais até a presente data no Centro de Documentação e Estatística Policial (CEDEP), da Polícia Civil \". IMPORTANTE: Este certificado é válido somente com a apresentação da cédula de Identidade expedida pelo Instituto de Identificação Pedro Melo/DPT/SSP. Este certificado foi emitido terça-feira, 20 de dezembro de 2022 e está disponível para consulta no endereço http://www.ba.gov.br/antecedentes/validar_atestado.asp, informando o código A5FD4A36-3F31-4F75-8AF0-103B7BB66212 Obs: Este certificado tem validade até a data 20/3/2023 Imprimir Fechar Janela",
    "origin": "PoliciaCivilAntecedentes"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Certidão negativa de protesto

Consulta informações de protestos em cartórios. Quando não existem protestos de
títulos contra o indivíduo, retorna uma certidão emitida pelo Instituto de
Estudos de Protestos de Títulos do Brasil.

```json
{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "77272722134",
    "protestos": [
      {
        "cartorio": "CARTÓRIO LARANJEIRAS - 32º OFÍCIO DE NOTAS DO RIO DE JANEIRO",
        "cidade": "RIO DE JANEIRO",
        "quantidadeTitulos": "",
        "endereco": "R. DAS LARANJEIRAS - LARANJEIRAS, RIO DE JANEIRO - RJ, 22221-060",
        "telefone": "19 3396-2809",
        "protestos": [
          {
            "cpfCnpj": "00000000000000",
            "data": "2017-10-10",
            "dataProtesto": "2017-10-10",
            "dataVencimento": "",
            "valor": "9.900,00"
          },
          {
            "cpfCnpj": "00000000000000",
            "data": "2018-01-01",
            "dataProtesto": "2018-01-01",
            "dataVencimento": "",
            "valor": "16.000,00"
          }
        ]
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Validação de e-mail

Realiza uma verificação em tempo real do e-mail informado, aplicada a cenários
como prevenção à fraude, identificação correta de e-mail, marketing, campanhas e
envio de cobranças.

```json
{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "email@email.com"
}
```

Status possíveis:

| Status | Descrição |
| --- | --- |
| `VALID` | O e-mail é válido e não apresenta restrições |
| `INVALID` | O e-mail é inválido |
| `UNKNOWN` | A validação não foi concluída no tempo limite |

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.email` | E-mail |
| `result.status` | Status do e-mail |
| `result.normalizedEmail` | E-mail normalizado |
| `result.address` | Endereço |
| `result.account` | Conta do e-mail |
| `result.domain` | Domínio do e-mail |
| `result.disposable` | Indica se o e-mail é temporário |
| `result.roleAddress` | Indica se o e-mail referencia um grupo |
| `result.riskyAccount` | Indica padrão de conta de risco |
| `result.riskyDomain` | Indica padrão de domínio de risco |
| `result.junk` | Indica possibilidade de spam ou lixo eletrônico |
| `result.limited` | Indica regras de filtragem por volume |
| `result.acceptAll` | Indica se o domínio aceita qualquer e-mail |
| `result.possibleSpamTrap` | Indica possível e-mail armadilha |
| `result.wasSyntaxValid` | Indica se a sintaxe original é válida |
| `result.wasSyntaxNormalized` | Indica se a sintaxe foi normalizada |
| `result.wasOwnershipFound` | Indica se foi encontrada propriedade do domínio |
| `result.possibleStoogeDomain` | Indica possível domínio laranja |
| `result.domainType` | Tipo do domínio |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "service": "SERVICE_EMAIL_VALIDATION",
    "email": "usuario@example.com"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "email": "usuario@example.com",
    "status": "VALID",
    "normalizedEmail": "usuario@example.com",
    "address": "usuario@example.com",
    "account": "teste",
    "domain": "test.com",
    "disposable": false,
    "roleAddress": false,
    "riskyAccount": false,
    "riskyDomain": false,
    "junk": false,
    "limited": false,
    "acceptAll": false,
    "possibleSpamTrap": false,
    "wasSyntaxValid": true,
    "wasSyntaxNormalized": false,
    "wasSiteFound": true,
    "wasOwnershipFound": false,
    "possibleStoogeDomain": false,
    "domainType": "BLOG"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Validação de CPF com telefone

Verifica a associação entre CPF e número de telefone nas principais operadoras
do Brasil. Esse serviço pode apoiar redução de custos e validações antes de
envios de mensagens.

```json
{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}
```

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.phone` | Telefone |
| `result.operator` | Nome da operadora retornado no exemplo da API |
| `result.carrierName` | Nome da operadora, quando retornado com essa nomenclatura |
| `result.validCarrierPhone` | Indica se o telefone é válido |
| `result.matchRateCpfPhone` | Taxa de correspondência entre CPF e telefone |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_CPF_PHONE_VALIDATION",
    "cpf": "cpf",
    "phone": "11900000000"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "phone": "5561982358585",
    "operator": "OPERADORA EXEMPLO",
    "validCarrierPhone": true,
    "matchRateCpfPhone": 100
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Validação de CPF com endereço

Valida a associação entre CPF e endereço nas principais operadoras de telefonia
do Brasil. Essa consulta ajuda a verificar se o indivíduo está associado ao
endereço informado e também apoia verificações relacionadas à localização.

```json
{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": 13
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.zipcode` | CEP |
| `result.numberAddress` | Número do endereço |
| `result.carrierName` | Nome da operadora de telefonia |
| `result.zipCodeMatchRate` | Taxa de correspondência entre CPF e CEP |
| `result.numberMatchRate` | Taxa de correspondência entre CPF, CEP e número informado |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_CPF_ADDRESS_VALIDATION",
    "cpf": "cpf",
    "zipcode": "00000-000",
    "numberAddress": 13
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "message": "Customer not found",
    "carrierName": "CLARO S.A.",
    "zipcode": "00000000",
    "zipCodeMatchRate": -1,
    "numberMatchRate": -1,
    "numberAddress": "13"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de informações financeiras

Consulta informações financeiras associadas ao CPF informado.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
```

Body:

```json
{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FINANCIAL_INFORMATION",
    "cpf": "cpf"
  }'
```

Esse serviço não possui exemplo de body de resposta JSON nesta referência.

### Consulta de dados PIS

A consulta de dados do PIS busca informações do Programa de Integração Social
disponíveis no portal do Cadastro Nacional de Informações Sociais (CNIS).

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
Content-Type: application/json
```

Body:

```json
{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PIS_CONSULTATION",
    "cpf": "cpf"
  }'
```

Esse serviço aparece como indisponível nesta referência e não possui body de
resposta documentado.

### Validação do E-Social

A validação do E-Social consulta o status cadastral do indivíduo no E-Social.
Embora a consulta possa usar o NIT, esse campo não é obrigatório. Caso o NIT não
seja enviado, a API utiliza o dado disponível na base.

```http
POST /api/service-api
```

Autorização:

```http
Authorization: Bearer {jwt_token}
```

Body:

```json
{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.status` | Status da validação cadastral |
| `result.message` | Mensagem da consulta |
| `result.name` | Nome |
| `result.birthdate` | Data de nascimento |
| `result.pis` | Número do PIS |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
    "cpf": "cpf",
    "nit": "(opcional)"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "status": "VERIFIED",
    "message": "Os dados estão corretos.",
    "name": "NOME EXEMPLO",
    "birthdate": "1971-11-23",
    "pis": "12460888617"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Documentoscopia digital

Esse serviço realiza a extração das informações do documento enviado e executa
FaceMatch entre a selfie informada e o documento, podendo também comparar com
bases do governo.

```json
{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}
```

Campos de entrada:

| Campo | Descrição |
| --- | --- |
| `key` | Chave usada para consultar o resultado da documentoscopia. Pode ser um UUID ou outra chave definida pela integração |
| `image1` | Documento em base64, PDF ou imagem, com a parte frontal do RG ou CNH. Também pode conter a foto da CNH completa. Campo obrigatório |
| `image2` | Documento em base64 com a parte de trás do RG ou CNH. Campo opcional |
| `selfie1` | Selfie da pessoa do documento para FaceMatch. Campo opcional |

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.name` | Nome |
| `result.fatherName` | Nome do pai |
| `result.motherName` | Nome da mãe |
| `result.birthdate` | Data de nascimento |
| `result.cnhCategory` | Categoria da CNH |
| `result.expeditionDate` | Data de expedição |
| `result.rg` | Número do RG |
| `result.rgUf` | UF do RG |
| `result.reanch` | Número do RENACH |
| `result.place` | Local de emissão do documento |
| `result.validDate` | Data de validade |
| `result.biometry` | FaceMatch entre documento e selfie na base do governo |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
    "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
    "image1": "base64",
    "image2": "base64",
    "selfie1": "base64"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1984-05-21",
    "cnhCategory": "AD",
    "expeditionDate": "19/03/2021",
    "rg": "3261880",
    "rgUf": "DF",
    "reanch": "DF765309297",
    "place": "Distrito Federal, Goiás, Mato Grosso, Mato Grosso do Sul ou Tocantins",
    "validDate": "2026-02-24",
    "biometry": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta do resultado da documentoscopia digital

Consulta o resultado da documentoscopia digital usando a chave informada na
requisição de criação.

```json
{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF |
| `result.name` | Nome |
| `result.fatherName` | Nome do pai |
| `result.motherName` | Nome da mãe |
| `result.birthdate` | Data de nascimento |
| `result.cnhCategory` | Categoria da CNH |
| `result.cnhNumber` | Número da CNH |
| `result.expeditionDate` | Data de expedição |
| `result.rg` | Número do RG |
| `result.rgUf` | UF do RG |
| `result.doc` | Tipo de documento |
| `result.place` | Local de emissão do documento |
| `result.validDate` | Data de validade do documento |
| `result.reanch` | Número do RENACH |
| `result.biometry` | FaceMatch documento x selfie na base do governo |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
    "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "80246074507",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1992-01-05",
    "cnhCategory": "AB",
    "cnhNumber": "07796497926",
    "expeditionDate": "2020-04-13",
    "rg": "3451620",
    "rgUf": "DF",
    "doc": "CNH",
    "place": "BRASILIA-DISTRITO FEDERAL, DF",
    "validDate": "2021-02-13",
    "REANCH": "DF767732467",
    "biometry": 3
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de MEI

Consulta os MEIs que um CPF possui.

```json
{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.meis` | Empresas MEI do CPF informado |
| `result.meis.cpf` | CPF |
| `result.meis.cnpj` | CNPJ do MEI |
| `result.meis.companyName` | Nome da empresa |
| `result.meis.sector` | Setor da empresa |
| `result.meis.classification` | Classificação da empresa |
| `result.meis.startDate` | Data de início da empresa |
| `result.meis.endDate` | Data de fim da empresa |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_MEI",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "meis": [
      {
        "cpf": "34449772040",
        "cnpj": "22745099000193",
        "companyName": "EMPRESA MEI EXEMPLO",
        "sector": "PRIVATE - 9511800 - REPARACAO E MANUTENCAO DE COMPUTADORES E DE EQUIPAMENTOS PERIFERICOS",
        "classification": "SELF-EMPLOYED",
        "startDate": "2022-02-03",
        "endDate": "2022-02-10"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Processos jurídicos e administrativos

Consulta processos jurídicos e administrativos associados ao CPF informado.

```json
{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_JURIDICAL_PROCESSES",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "processes": [
      {
        "cpf": "",
        "numberLegalProcess": "",
        "trialCourt": "",
        "processDate": "",
        "mainSubjectProcess": "",
        "classification": "",
        "relatedParties": ""
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de servidores públicos

Consulta vínculos relacionados a servidores públicos para o CPF informado.

```json
{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.totalPublicPositions` | Total de vínculos ou posições públicas encontradas |
| `result.inServiceServices` | Total de vínculos públicos em serviço |
| `result.income` | Valor de renda retornado pela consulta |
| `result.isCurrentlyPublicServant` | Indica se a pessoa é atualmente servidora pública |
| `result.professionalHistory` | Histórico profissional relacionado ao serviço público |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PUBLIC_SERVANTS",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "totalPublicPositions": 6,
    "inServiceServices": 0,
    "income": 0,
    "isCurrentlyPublicServant": false,
    "professionalHistory": []
  },
  "status": {
    "code": 400,
    "message": "Failed to fetch information"
  }
}
```

### Consulta de endereços

Consulta endereços associados ao CPF informado.

```json
{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.addresses` | Lista de endereços associados ao CPF |
| `result.addresses.zipcode` | CEP |
| `result.addresses.country` | País |
| `result.addresses.address` | Logradouro |
| `result.addresses.city` | Cidade |
| `result.addresses.addressType` | Tipo do endereço |
| `result.addresses.neighborhood` | Bairro |
| `result.addresses.state` | UF |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ADDRESS",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "addresses": [
      {
        "zipcode": "",
        "country": "BRASIL",
        "address": "",
        "city": "SALVADOR",
        "addressType": "HOME",
        "neighborhood": "GRACA",
        "state": "BA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de relacionamentos econômicos

Consulta relacionamentos econômicos associados ao CPF informado.

```json
{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ECONOMIC_RELATIONSHIP",
    "cpf": "cpf"
  }'
```

O retorno desse serviço não foi informado no trecho atual da documentação antiga.

### Consulta do histórico profissional

Consulta histórico profissional associado ao CPF informado.

```json
{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}
```

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PROFESSIONAL_HISTORY",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "professionalHistory": [
      {
        "endDate": "2007-12-23",
        "companyName": "CRN CURSOS PROFISSIONALIZANTES LTDA",
        "cnpj": "05731652000209",
        "classification": "EMPLOYEE",
        "sector": "PRIVATE - 8599604 - TREINAMENTO EM DESENVOLVIMENTO PROFISSIONAL E GERENCIAL",
        "startDate": "2004-02-10"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de dados pelo telefone

Consulta dados da pessoa a partir do telefone informado.

```json
{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}
```

| Campo | Descrição |
| --- | --- |
| `cpf` | CPF |
| `name` | Nome da pessoa |
| `phone` | Telefone consultado |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_CONFIRM_PHONE",
    "phone": "+5561123456789"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cpf": "11111111111",
    "name": "NOME DA PESSOA",
    "phone": "+5561123456789"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de mandado de prisão

Consulta mandado de prisão associado aos dados informados.

```json
{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}
```

| Campo | Descrição |
| --- | --- |
| `message` | Mensagem de retorno |
| `arrestWarrantFound` | Indica se existe mandado de prisão |

### Consulta de débitos ativos

Consulta débitos ativos associados ao CPF informado.

```json
{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}
```

| Campo | Descrição |
| --- | --- |
| `result.totalDebtValue` | Valor total dos débitos |
| `result.totalDebts` | Quantidade total de débitos |
| `result.debts` | Lista de débitos |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

### Consulta de dados eleitorais de um candidato

Consulta dados eleitorais associados a um candidato.

```json
{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `hasRunForOffice` | Indica se o indivíduo já concorreu a algum cargo público |
| `hasBeenElected` | Indica se o indivíduo já foi eleito |
| `numberOfTimesRanForOffice` | Número de vezes que concorreu a cargos públicos |
| `numberOfTimesElected` | Número de vezes que foi eleito |
| `lastElectedRole` | Último cargo para o qual foi eleito |
| `electionData` | Dados detalhados sobre candidaturas e eleições |
| `accountability` | Dados de prestação de contas |
| `assetsList` | Lista de bens declarados |
| `suppliersRanking` | Ranking de fornecedores |
| `donorsRanking` | Ranking de doadores |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "hasRunForOffice": true,
    "hasBeenElected": true,
    "numberOfTimesRanForOffice": 1,
    "numberOfTimesElected": 1,
    "lastElectedRole": "Presidente",
    "firstElectionYearRanForOffice": "2000",
    "lastElectionYearRanForOffice": "2020",
    "firstElectionYearElected": "2000",
    "lastElectionYearElected": "2020",
    "electionData": [
      {
        "ballotName": "ROG***NHO",
        "ballotNumber": 77789,
        "fullName": "CAR***************************IRA",
        "normalizedName": "CAR***************************IRA",
        "docNumber": "832*****753",
        "voterNumber": "079******370",
        "url": "https://divulgacandcontas.tse.jus.br/divulga/rest/v1/candidatura/buscar/2020/58955/2030402020/candidato/190000751750",
        "electionYear": "2020",
        "electionType": "Municipal",
        "applicationRole": "Vereador",
        "applicationPlace": "SÃO FIDÉLIS",
        "applicationUf": "RJ",
        "campaignCNPJ": "38646823000161",
        "status": "Eleito por QP",
        "wasElected": true,
        "candidateSituation": "Consta da urna",
        "applicationSituation": "Deferido",
        "partyNumber": 77,
        "partyAcronym": "SOLIDARIEDADE",
        "partyName": "Sol*******ade",
        "campaignSpendingFirstRound": 122565.82,
        "totalAssetsValue": 93100,
        "assetsList": [
          {
            "description": "economia pessoal",
            "type": "Dinheiro em espécie - moeda nacional",
            "value": 8100
          }
        ],
        "accountability": {
          "accountabilityControlNumber": "777***************502",
          "consolidatedRevenueValues": {
            "totalReceivedResources": 13390.8,
            "totalFinancialResources": 9230
          },
          "consolidatedExpensesValues": {
            "expensesThreshold": 122565.82,
            "totalExpensesContracted": 9230
          }
        }
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de doações eleitorais

Consulta doações eleitorais realizadas por uma pessoa.

```json
{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `totalDonationsAmount` | Quantidade total de doações realizadas |
| `totalDonatedValue` | Valor total doado |
| `quantityOfDonationsLastElection` | Quantidade de doações na última eleição |
| `quantityOfDonationsLastTwoElections` | Quantidade de doações nas últimas duas eleições |
| `quantityOfDonationsLastThreeElection` | Quantidade de doações nas últimas três eleições |
| `donatedValueLastElection` | Valor doado na última eleição |
| `donatedValueLastTwoElections` | Valor doado nas últimas duas eleições |
| `donatedValueLastThreeElection` | Valor doado nas últimas três eleições |
| `partiesThatReceivedDonation` | Lista dos partidos que receberam doações |
| `maxDonationValue` | Valor máximo de uma doação |
| `averageDonationValue` | Valor médio das doações |
| `minDonationValue` | Valor mínimo de uma doação |
| `electionDonationData` | Dados detalhados das doações realizadas em eleições |
| `electionDonationData.politicianBallotNumber` | Número na urna do político que recebeu a doação |
| `electionDonationData.politicianFullName` | Nome completo do político que recebeu a doação |
| `electionDonationData.electionYear` | Ano da eleição em que a doação foi realizada |
| `electionDonationData.partyName` | Nome do partido que recebeu a doação |
| `electionDonationData.donationsAmount` | Quantidade de doações feitas para o político ou partido |
| `electionDonationData.totalDonationValue` | Valor total das doações feitas para o político ou partido |
| `electionDonationData.isCrowdfunding` | Indica se a doação foi realizada via crowdfunding |
| `electionDonationData.donationRecipient` | Destinatário da doação |
| `electionDonationData.isCrossDonation` | Indica se a doação foi cruzada |
| `electionDonationData.partyCrossDonationValue` | Valor da doação cruzada para o partido |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ELECTORAL_DONORS_CPF",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "totalDonationsAmount": 15,
    "totalDonatedValue": 57930428,
    "quantityOfDonationsLastElection": 0,
    "quantityOfDonationsLastTwoElections": 0,
    "quantityOfDonationsLastThreeElection": 1,
    "donatedValueLastElection": 0,
    "donatedValueLastTwoElections": 0,
    "donatedValueLastThreeElection": 25000000,
    "partiesThatReceivedDonation": [
      "PSDB",
      "PST",
      "PRP",
      "PFL",
      "MDB"
    ],
    "maxDonationValue": 57030000,
    "averageDonationValue": 8275775.5,
    "minDonationValue": 684,
    "electionDonationData": [
      {
        "politicianBallotNumber": 0,
        "politicianFullName": "HEN**********************LES",
        "electionYear": "2002",
        "partyName": "P**B",
        "donationsAmount": "6",
        "totalDonationValue": 887050.1,
        "isCrowdfunding": false,
        "donationRecipient": "CANDIDATE",
        "isCrossDonation": false,
        "partyCrossDonationValue": 0
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de envolvimento político

Consulta indicadores de envolvimento político de uma pessoa.

```json
{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}
```

| Campo | Descrição |
| --- | --- |
| `electionsCount` | Número de eleições nas quais o indivíduo participou |
| `isCurrentlyInOffice` | Indica se está atualmente em cargo público |
| `wasFormerlyElected` | Indica se já foi eleito anteriormente |
| `isPep` | Indica se é Pessoa Politicamente Exposta |
| `amountDonated` | Valor total doado |
| `amountReceived` | Valor total recebido |
| `politicalInvolvementScore` | Pontuação de envolvimento político |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_POLITICAL_INVOLVEMENT",
    "cpf": "cpf"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "electionsCount": 5,
    "isCurrentlyInOffice": true,
    "wasFormerlyElected": true,
    "isPep": true,
    "amountDonated": 19804076,
    "amountReceived": 20599420,
    "politicalInvolvementScore": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de histórico familiar político

Consulta histórico político familiar de uma pessoa.

```json
{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

> Nota:
  Alguns campos abaixo mantêm a grafia original retornada pela API, mesmo quando
  ela parece inconsistente. Isso evita divergência entre a documentação e o
  contrato real do response.

| Campo | Descrição |
| --- | --- |
| `totalMembers` | Número total de membros da família |
| `policalMembers` | Número de membros políticos na família |
| `currentlyElectedMembers` | Número de membros atualmente eleitos |
| `totalDisputedElections` | Total de eleições disputadas pela família |
| `totalWonElections` | Total de eleições ganhas |
| `familyFirstDisputedElectionYear` | Ano da primeira eleição disputada pela família |
| `familyFirstWonElectionYear` | Ano da primeira eleição ganha pela família |
| `familyLastDisputedElectionYear` | Ano da última eleição disputada pela família |
| `familyLastWonElectionYear` | Ano da última eleição ganha pela família |
| `relationshipTypeWithMoreWonElections` | Tipo de relação com mais eleições ganhas |
| `relationshipTypeWithMoreDisputedElections` | Tipo de relação com mais eleições disputadas |
| `highestDisputedPolicalPosition` | Posição política mais alta disputada |
| `highestHeldPolicalPosition` | Posição política mais alta ocupada |
| `electionsTimeline` | Linha do tempo de eleições disputadas |
| `disputedPoliticalPositionsDistribution` | Distribuição dos cargos disputados |
| `heldPoliticalPositionsDistribution` | Distribuição dos cargos ocupados |
| `totalDisputedElectionsByRelationshipType` | Total de eleições disputadas por tipo de relação |
| `totalWonElectionsByRelationshipType` | Total de eleições ganhas por tipo de relação |
| `totalDisputedElectionsByPartyAcronym` | Total de eleições disputadas por sigla partidária |
| `totalDisputedElectionsByRegion` | Total de eleições disputadas por região |

Exemplo de resposta:

```json
{
  "result": {
    "totalMembers": 10,
    "policalMembers": 3,
    "currentlyElectedMembers": 2,
    "totalDisputedElections": 22,
    "totalWonElections": 11,
    "familyFirstDisputedElectionYear": 1998,
    "familyFirstWonElectionYear": 1998,
    "familyLastDisputedElectionYear": 2022,
    "familyLastWonElectionYear": 2022,
    "relationshipTypeWithMoreWonElections": "SON",
    "relationshipTypeWithMoreDisputedElections": "SON",
    "highestDisputedPolicalPosition": "PRESIDENTE",
    "highestHeldPolicalPosition": "PRESIDENTE",
    "electionsTimeline": [
      {
        "eelationshipType": "SELF",
        "electionYear": 2022,
        "electionType": "FEDERAL",
        "electionRegion": "BRASIL - BR",
        "role": "PRESIDENTE",
        "partyAcronym": "PL",
        "wasElected": false
      }
    ],
    "disputedPoliticalPositionsDistribution": {
      "DEPUTADO FEDERAL": 9,
      "VEREADOR": 9,
      "PRESIDENTE": 2,
      "PREFEITO": 2
    },
    "heldPoliticalPositionsDistribution": {
      "DEPUTADO FEDERAL": 6,
      "VEREADOR": 4,
      "PRESIDENTE": 1
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de prestadores de serviço eleitorais

Consulta prestadores de serviço eleitorais associados à pessoa.

```json
{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `name` | Nome do indivíduo ou entidade |
| `partiesThatReceivedProvision` | Lista dos partidos que receberam provisões |
| `electionProvisionData` | Dados detalhados sobre provisões eleitorais |
| `politicianBallotNumber` | Número na urna do político que recebeu a provisão |
| `politicianFullName` | Nome completo do político que recebeu a provisão |
| `politicianDocNumber` | Número do documento do político |
| `partyName` | Nome do partido que recebeu a provisão |
| `provisionRequester` | Solicitante da provisão |
| `electionYear` | Ano da eleição |
| `applicationRole` | Cargo ao qual o candidato se candidatou |
| `numberOfProvisions` | Número de provisões feitas |
| `totalProvisionValue` | Valor total das provisões |
| `crossDonationFlagFound` | Indica se foi encontrada doação cruzada |
| `entityCrossDonationValue` | Valor da doação cruzada pela entidade |
| `entityCrossDonationYield` | Rendimento da doação cruzada pela entidade |
| `crossDonationRelationshipLevel` | Nível de relacionamento da doação cruzada |
| `minProvisionValue` | Valor mínimo de provisão |
| `maxProvisionValue` | Valor máximo de provisão |
| `avgProvisionValue` | Valor médio das provisões |

---

# Serviços de Pessoa Jurídica

URL: https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica
Fonte: guides/servicos-pessoa-juridica.mdx
Descrição: Serviços externos disponíveis para consultas de CNPJ

# Serviços de Pessoa Jurídica

Os serviços de pessoa jurídica permitem consultar, validar e enriquecer dados de
CNPJ em fluxos de onboarding PJ, análise cadastral, KYC empresarial, avaliação de
sócios, regularidade fiscal, débitos, protestos e compliance.

Assim como nos serviços de pessoa física, todos são executados pelo endpoint
central de serviços. O campo `service` define qual produto será processado.

Antes de montar o body, confira no produto do cliente qual alias está liberado.
Esse é o valor que deve ir no campo `service`.

```http
POST /api/service-api
```

Nos exemplos de `curl`, `{base_url}` representa a URL do ambiente escolhido:

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

Exemplo de requisição:

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

## Como usar este catálogo

Esta é a referência técnica completa de pessoa jurídica — use-a quando precisar
do contrato completo de um service. Para navegar por objetivo ou família de
produto primeiro, veja
[Escolha o serviço certo](/guides/escolha-o-servico-certo),
[Matriz de serviços](/guides/matriz-de-servicos) ou
[Famílias de serviços](/guides/service-api/familias-de-servicos).

Use esta página para consultar a lista completa de serviços de CNPJ, seus
códigos `service`, campos principais e exemplos mais extensos de request e
response.

## Guias relacionados

| Guia | Quando usar |
| --- | --- |
| [Famílias de serviços](/guides/service-api/familias-de-servicos) | Para navegar por grupo de produto. |
| [OCR via Service API](/guides/service-api/sobre-ocr-service-api) | Para payloads de cartão CNPJ, imagem, base64 e exemplos de retorno. |
| [API Reference](/api-reference/autorização/gerar-token-de-api) | Para detalhes endpoint a endpoint. |

> Atencao:
  Para protestos PJ, alguns produtos usam alias curto no body. Se
  `SERVICE_PROTEST_PJ` ou `SERVICE_PROTEST_PJ` estiverem
  documentados, mas o produto estiver configurado com alias curto, envie
  `SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ` no campo `service`.

Passo rápido para evitar erro:

1. Abra o produto do cliente no Backoffice.
2. Confirme o alias liberado para o serviço.
3. Envie esse alias no campo `service`.
4. Use os demais campos da tabela como entrada principal da consulta.

## Serviços disponíveis

### Cadastro e situação cadastral

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| Enriquecimento de dados de PJ | `SERVICE_CORPORATE_DATA_ENRICHMENT` | `cnpj` |
| Status do CNPJ na Receita Federal | `SERVICE_RFB_PJ` | `cnpj` |
| CNPJ na Receita Federal on-demand | `SERVICE_RFB_PJ_ON_DEMAND` | `cnpj` |
| Dados cadastrais de CNPJ | `SERVICE_REGISTRATION_DATA_CNPJ` | `cnpj` |
| SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` | `cnpj`, `uf` |
| Endereços estendidos de empresa | `SERVICE_ADDRESSES_EXTENDED_CNPJ` | `cnpj` |
| Domínios CNPJ | `SERVICE_DOMAINS_CNPJ` | `cnpj` |
| Doações eleitorais PJ | `SERVICE_ELECTORAL_DONORS_CNPJ` | `cnpj` |
| Fornecedores eleitorais PJ | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` | `cnpj` |
| DAS MEI na Receita | `SERVICE_DAS_MEI` | `cnpj` |
| Avaliações e Reputação | `SERVICE_REPUTATIONS_AND_REVIEWS` | `cnpj` |
| Dados de Fundos de Investimento | `SERVICE_INVESTMENT_FUND_DATA` | `cnpj` |
| Arrecadação Simples Nacional - MEI | `SERVICE_PGMEI` | `cnpj` |
| Marketplaces | `SERVICE_MARKETPLACE_DATA` | `cnpj` |
| Anúncios Online | `SERVICE_ONLINE_ADS` | `cnpj` |
| Histórico de Dados Básicos | `SERVICE_HISTORY_BASIC_DATA` | `cnpj` |
| Categoria Comercial | `SERVICE_MERCHANT_CATEGORY_DATA` | `cnpj` |
| Telefones | `SERVICE_PHONES_EXTENDED_COMPANY` | `cnpj` |
| Evolução da Empresa | `SERVICE_COMPANY_EVOLUTION` | `cnpj` |
| Projetos Públicos | `SERVICE_PUBLIC_PROJECTS` | `cnpj` |
| Obras Civis | `SERVICE_CIVIL_CONSTRUCTION` | `cnpj` |

### Risco e crédito

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| Score de Crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY` | `cnpj` |
| Score de Crédito Multidados PJ | `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` | `cnpj` |
| Dados Restritivos PJ | `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` | `cnpj` |
| Flags Negativos PJ | `SERVICE_QUOD_CREDIT_RISK_COMPANY` | `cnpj` |
| Score de Crédito Quantum PJ | `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` | `cnpj` |
| Risco de crédito PJ | `SERVICE_CREDIT_RISK_COMPANY` | `cnpj` |

### Sócios, relacionamentos e compliance

| Serviço | Código `service` | Campos principais |
| --- | --- | --- |
| Relacionamentos de uma empresa | `SERVICE_COMPANY_RELATIONSHIP` | `cnpj` |
| Sócios na Receita Federal | `SERVICE_COMPANY_RFB_OWNERS` | `cnpj` |
| Sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` | `cnpj` |
| Relacionamentos do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` | `cnpj` |
| Influência do Quadro Societário | `SERVICE_OWNERS_INFLUENCE` | `cnpj` |
| Receita Federal - QSA | `SERVICE_RF_QSA` | `cnpj` |
| Distribuição de Processos dos Sócios | `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` | `cnpj` |
| Processos jurídicos PJ | `SERVICE_JURIDICAL_PROCESSES_PJ` | `cnpj` |
| Processos jurídicos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` | `cnpj` |
| Distribuição de Processos Judiciais | `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` | `cnpj` |
| Ações Trabalhistas | `SERVICE_LABOR_LAWSUITS` | `cnpj` |
| KYC e compliance dos sócios | `SERVICE_COMPANY_KYC_OWNERS` | `cnpj` |
| KYC e Compliance dos Funcionários | `SERVICE_EMPLOYEES_KYC` | `cnpj` |
| Acordos Sindicais | `SERVICE_SYNDICATE_AGREEMENTS` | `cnpj` |
| Exposição e perfil na mídia dos sócios | `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` | `cnpj` |
| Doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` | `cnpj` |
| Débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` | `cnpj` |
| FGTS | `SERVICE_FGTS` | `cnpj` |
| Certidão negativa de protesto PJ | `SERVICE_PROTEST_PJ` | `cnpj` |
| Compliance de casas de apostas | `SERVICE_COMPLIANCE_BET` | `cnpj` |
| Compliance de casas de apostas PJ | `SERVICE_COMPLIANCE_BET_PJ` | `cnpj` |
| Beneficiários Finais | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` | `cnpj` |
| Percentual de Participação Societária | `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` | `cnpj` |
| Débitos com a PGFN | `SERVICE_PGFN_COMPANY` | `cnpj` |
| Cota de PCD | `SERVICE_PCD_COMPANY` | `cnpj` |
| Certidão Negativa Correcional CGU | `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` |
| Certidão Negativa CNJ | `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` | `cnpj` |
| Certidão Negativa de Débitos Estaduais | `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` | `cnpj` |
| Optante pelo Simples Nacional | `SERVICE_SIMPLES_COMPANY` | `cnpj` |
| KYC e Compliance do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` | `cnpj` |
| OCR de cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | `image1` |

## Consulta on-demand de CNPJ

O serviço `SERVICE_RFB_PJ_ON_DEMAND` executa a consulta do CNPJ na
Receita Federal em modo on-demand. Use quando a integração precisar buscar ou
atualizar a informação cadastral da empresa diretamente no momento da requisição.

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

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "30108283000150"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

> Nota:
  Este serviço executa a consulta on-demand, mas o response exposto atualmente
  pode ser mínimo. Para uma visão cadastral mais completa da empresa, use também
  `SERVICE_CORPORATE_DATA_ENRICHMENT`.

## Exemplos

### Enriquecimento de dados de pessoa jurídica

Retorna informações de uma pessoa jurídica existente na Receita Federal, como
razão social, nome fantasia, data de fundação, atividades, natureza jurídica e
capital social.

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

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_CORPORATE_DATA_ENRICHMENT",
    "cnpj": "cnpj"
  }'
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ |
| `result.status` | Status do CNPJ na Receita Federal |
| `result.statusDate` | Data de atualização do status |
| `result.name` | Razão social |
| `result.country` | País de criação da empresa |
| `result.fantasyName` | Nome fantasia |
| `result.origin` | Origem das informações |
| `result.regime` | Tipo de regime tributário |
| `result.age` | Idade da empresa em anos |
| `result.registrationStatusDate` | Data de atualização da situação cadastral |
| `result.foundedDate` | Data de fundação |
| `result.activities` | Atividades da empresa |
| `result.legalNatureCode` | Código da natureza jurídica |
| `result.legalNatureActivity` | Descrição da natureza jurídica |
| `result.capital` | Capital inicial por extenso |
| `result.capitalRS` | Capital inicial em reais |
| `result.nire` | Número de Identificação do Registro de Empresas |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "30108283000150",
    "status": "ATIVA",
    "statusDate": "2022-07-26T00:00:00Z",
    "name": "EMPRESA EXEMPLO LTDA",
    "country": "Brazil",
    "fantasyName": "EMPRESA EXEMPLO",
    "origin": "Receita Federal",
    "regime": "SIMPLES",
    "age": 4,
    "registrationStatusDate": "2018-04-04T00:00:00Z",
    "foundedDate": "2018-04-04T00:00:00Z",
    "activities": [
      {
        "IsMain": true,
        "Code": "6209100",
        "Activity": "SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO"
      },
      {
        "IsMain": false,
        "Code": "6201501",
        "Activity": "DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA"
      },
      {
        "IsMain": false,
        "Code": "6201502",
        "Activity": "WEB DESIGN"
      },
      {
        "IsMain": false,
        "Code": "6202300",
        "Activity": "DESENVOLVIMENTO E LICENCIAMENTO DE PROGRAMAS DE COMPUTADOR CUSTOMIZAVEIS"
      }
    ],
    "legalNatureCode": "2062",
    "legalNatureActivity": "SOCIEDADE EMPRESARIA LIMITADA",
    "capital": "DEZ MIL REAIS",
    "capitalRS": "10000.00",
    "nire": ""
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Status do CNPJ na Receita Federal

Retorna a situação cadastral de um CNPJ existente na Receita Federal.

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

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ |
| `result.status` | Status do CNPJ na Receita Federal |
| `result.statusDate` | Data de atualização do status |
| `result.origin` | Origem das informações |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

### Consulta de relacionamentos de uma empresa

Consulta relacionamentos da empresa, incluindo proprietários, empregados,
empresas possuídas e vínculos societários.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ |
| `result.isFamilyCompany` | Indica se os proprietários pertencem à mesma família |
| `result.isFamilyEmployees` | Indica se funcionários pertencem à família de algum proprietário |
| `result.relationshipTotal` | Número total de relacionamentos |
| `result.totalOwners` | Total de donos |
| `result.totalEmployees` | Total de empregados |
| `result.totalOwned` | Total de empresas possuídas |
| `result.companyRelationships` | Relacionamentos da empresa |
| `result.companyRelationships.cpf` | CPF relacionado |
| `result.companyRelationships.name` | Nome |
| `result.companyRelationships.relationshipName` | Nome do relacionamento |
| `result.companyRelationships.relationshipType` | Tipo de relacionamento |
| `result.companyRelationships.origin` | Origem da informação |

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "99244297000106",
    "isFamilyCompany": false,
    "isFamilyEmployees": false,
    "relationshipTotal": 1,
    "totalOwners": 1,
    "totalEmployees": 1,
    "totalOwned": 1,
    "companyRelationships": [
      {
        "cpf": "77272722314",
        "name": "NOME EXEMPLO",
        "country": "Brazil",
        "relationshipName": "SOCIO-ADMINISTRADOR",
        "relationshipType": "REPRESENTANTELEGAL",
        "origin": "RECEITA FEDERAL",
        "relationshipStartDate": "2021-03-01",
        "relationshipEndDate": "2021-03-01"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta do SINTEGRA

A consulta do SINTEGRA busca informações no Sistema Integrado de Informações
sobre Operações Interestaduais com Mercadorias e Serviços, no site oficial do
governo. O SINTEGRA controla operações interestaduais realizadas por
contribuintes de ICMS e apoia empresas na emissão de notas fiscais para
clientes.

```json
{
  "service": "SERVICE_SINTEGRA_CONSULTATION",
  "cnpj": "cnpj",
  "uf": "uf"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ |
| `result.status` | Status do CNPJ no SINTEGRA |
| `result.uf` | UF do estado do CNPJ |
| `result.cfdf` | Cadastro Fiscal do Distrito Federal, exclusivo para empresas com cadastro no DF |
| `result.origin` | Origem das informações |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de requisição:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_SINTEGRA_CONSULTATION",
    "cnpj": "cnpj",
    "uf": "uf (opcional)"
}'
```

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "30108283000000",
    "status": "NOT REGISTERED",
    "uf": "DF",
    "cfdf": "0785286100111",
    "origin": "Sintegra"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Endereços estendidos de empresa

Retorna a lista completa de endereços associados ao CNPJ consultado (atuais e
históricos), com dados normalizados de logradouro, bairro, cidade, UF, país,
CEP e tipo de endereço, além de um resumo agregado com totais e datas de
passagem. Use esta consulta quando a análise cadastral precisar ir além do
endereço principal retornado por consultas básicas de CNPJ.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ consultado |
| `result.addresses` | Lista de endereços associados à empresa (todos os valores vêm como texto/string) |
| `result.addresses.address` | Logradouro |
| `result.addresses.number` | Número |
| `result.addresses.complement` | Complemento, quando existir |
| `result.addresses.neighborhood` | Bairro |
| `result.addresses.city` | Cidade |
| `result.addresses.state` | UF |
| `result.addresses.country` | País |
| `result.addresses.zipcode` | CEP |
| `result.addresses.addressType` | Tipo de endereço (ex.: `COMMERCIAL`, `RESIDENTIAL`) |
| `result.addresses.isActive` | `"true"`/`"false"` — se o endereço está ativo atualmente |
| `result.addresses.isMainForEntity` | `"true"`/`"false"` — se é o endereço principal da empresa |
| `result.addressesExtendedTotal` | Total de endereços encontrados |
| `result.addressesExtendedTotalActive` | Quantos estão ativos |
| `result.addressesExtendedOldestPassageDate` / `result.addressesExtendedNewestPassageDate` | Data da passagem mais antiga e mais recente entre todos os endereços |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "30108283000150",
    "addresses": [
      {
        "address": "AVENIDA EXEMPLO",
        "number": "1000",
        "neighborhood": "CENTRO",
        "city": "SAO PAULO",
        "state": "SP",
        "country": "BRASIL",
        "zipcode": "01001000",
        "addressType": "COMMERCIAL",
        "isActive": "true",
        "isMainForEntity": "true"
      }
    ],
    "addressesExtendedTotal": 1,
    "addressesExtendedTotalActive": 1,
    "addressesExtendedOldestPassageDate": "2018-02-10",
    "addressesExtendedNewestPassageDate": "2026-05-12"
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}
```

### Consulta de sócios de primeiro nível

Busca os círculos de pessoas físicas agregadas relacionadas ao CNPJ informado.
Essas pessoas são recuperadas a partir dos dados do quadro societário das
empresas.

Observações:

- Pode existir círculo sem nenhum indivíduo participante.
- O retorno dos círculos fica contido no objeto principal de resultado.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.cnpj` | CNPJ |
| `result.circleType` | Tipo de círculo |
| `result.totalEntities` | Total de entidades relacionadas |
| `result.totalDistinctAddresses` | Total de endereços distintos relacionados |
| `result.totalDistinctPhones` | Total de telefones distintos relacionados |
| `result.totalDistinctEmails` | Total de e-mails distintos relacionados |
| `result.totalEmployedEntities` | Total de pessoas relacionadas que estão empregadas |
| `result.totalCompaniesOwned` | Total de empresas possuídas |
| `result.totalRelatedEntities` | Total de pessoas relacionadas |
| `result.totalPEPs` | Total de pessoas politicamente expostas |
| `result.totalPublicServants` | Total de servidores públicos relacionados |
| `result.totalClassMember` | Total de pessoas com registro em conselhos de classe |
| `result.totalLivingPeople` | Total de pessoas vivas nos círculos |
| `result.totalDeceasedPeople` | Total de pessoas falecidas nos círculos |
| `result.minAge` | Idade mínima dentre as entidades |
| `result.maxAge` | Idade máxima dentre as entidades |
| `result.avgAge` | Idade média entre as entidades |
| `result.circleTotalIncomeRange` | Faixa total de renda das entidades |
| `result.entitiesAvgIncomeRange` | Faixa de renda média das entidades |
| `result.avgGeographicDistance` | Distância geográfica média |
| `result.totalLawSuits` | Total de processos |
| `result.genderDistribution` | Distribuição por gênero |
| `result.ageRangeDistribution` | Distribuição por faixa de idade |
| `result.incomeRangeDistribution` | Distribuição por faixa de renda |
| `result.stateDistribution` | Distribuição por estado |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

Exemplo de requisição:

```bash
curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_FIRST_LEVEL_PARTNER",
    "cnpj": "cnpj"
}'
```

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "99244297000106",
    "circleType": "FIRST_LEVEL_OWNERS",
    "totalEntities": 2,
    "totalDistinctAddresses": 11,
    "totalDistinctPhones": 7,
    "totalDistinctEmails": 7,
    "totalEmployedEntities": 2,
    "totalCompaniesOwned": 4,
    "totalRelatedEntities": 4,
    "totalPEPs": 0,
    "totalPublicServants": 0,
    "totalClassMember": 0,
    "totalLivingPeople": 2,
    "totalDeceasedPeople": 0,
    "minAge": 28,
    "maxAge": 38,
    "avgAge": 33,
    "circleTotalIncomeRange": "ACIMA DE 20 SM",
    "entitiesAvgIncomeRange": "10 A 20 SM",
    "entitiesMaxIncomeRange": "10 A 20 SM",
    "entitiesMinIncomeRange": "4 A 10 SM",
    "minEducationLevel": "SEM INFORMACAO",
    "avgEducationLevel": "6 A 9 FUND",
    "maxEducationLevel": "MEDIO COMPL",
    "avgGeographicDistance": 11490.88926949,
    "maxGeographicDistance": 22580.48025219,
    "minGeographicDistance": 401.29828679,
    "maxEShopperLevel": "A",
    "totalEShopperLevel": "A",
    "minEShopperLevel": "A",
    "maxESellerLevel": "D",
    "minESellerLevel": "H",
    "totalESellerLevel": "F",
    "totalLawSuits": 0,
    "totalLawSuitsAsDefendant": 0,
    "totalLawSuitsAsAuthor": 0,
    "totalPassages": 50,
    "totalBadPassages": 4,
    "monthAveragePassages": 50,
    "firstPassageDate": "0001-01-01T00:00:00",
    "lastPassageDate": "0001-01-01T00:00:00",
    "last3MonthsPassages": -3,
    "last6MonthsPassages": -3,
    "last12MonthsPassages": -3,
    "last18MonthsPassages": -3,
    "genderDistribution": {
      "U": 0,
      "F": 0,
      "M": 2
    },
    "ageRangeDistribution": {
      "30-40": 1,
      "25-30": 1,
      "SEM INFORMACAO": 0
    },
    "incomeRangeDistribution": {
      "4 A 10 SM": 1,
      "10 A 20 SM": 1,
      "SEM INFORMACAO": 0
    },
    "educationLevelDistribution": {
      "MEDIO COMPL": 1,
      "SEM INFORMACAO": 1
    },
    "stateDistribution": {
      "DF": 1,
      "SP": 0,
      "RJ": 0,
      "BA": 0
    },
    "eShopperDistribution": {
      "A": 2,
      "B": 0,
      "C": 0
    },
    "eSellerDistribution": {
      "D": 1,
      "H": 1
    },
    "taxIdStatusDistribution": {
      "Regular": 2
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de DAS MEI na Receita

Consulta períodos de DAS MEI na Receita, retornando períodos pagos, URL do
boleto e código de barras.

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

| Campo | Descrição |
| --- | --- |
| `result.periodos` | Lista de períodos atrelados ao MEI |
| `result.periodos.url_das` | URL do boleto para pagamento da mensalidade do DAS |
| `result.periodos.codigo_barras_das` | Código de barras do boleto |

Exemplo de requisição:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_DAS_MEI",
    "cnpj": "cnpj"
}'
```

Exemplo de resposta:

```json
{
  "result": {
    "periodos": {
      "201707": {
        "mensagem": "Exemplo de texto",
        "mensagem_site": "Exemplo de texto",
        "url_das": "https://www.exemplo.com/exemplo-de-url",
        "codigo_barras_das": "",
        "periodo": "Julho/2017",
        "apurado": "Sim",
        "situacao": "",
        "principal": "",
        "multas": "",
        "juros": "",
        "total": "",
        "data_vencimento": "",
        "data_acolhimento": "",
        "data_pagamento": "",
        "icms": "",
        "iss": "",
        "inss": "",
        "numero_apuracao": "",
        "numero_das": "",
        "normalizado_principal": 0.0,
        "normalizado_multas": 0.0,
        "normalizado_juros": 0.0,
        "normalizado_total": 0.0,
        "normalizado_icms": 0.0,
        "normalizado_iss": 0.0,
        "normalizado_inss": 0.0
      },
      "201708": {
        "mensagem": "Exemplo de texto",
        "mensagem_site": "Exemplo de texto",
        "url_das": "https://www.exemplo.com/exemplo-de-url",
        "codigo_barras_das": "",
        "periodo": "Agosto/2017",
        "apurado": "Sim",
        "situacao": "",
        "principal": "",
        "multas": "",
        "juros": "",
        "total": "",
        "data_vencimento": "",
        "data_acolhimento": "",
        "data_pagamento": "",
        "icms": "",
        "iss": "",
        "inss": "",
        "numero_apuracao": "",
        "numero_das": "",
        "normalizado_principal": 0.0,
        "normalizado_multas": 0.0,
        "normalizado_juros": 0.0,
        "normalizado_total": 0.0,
        "normalizado_icms": 0.0,
        "normalizado_iss": 0.0,
        "normalizado_inss": 0.0
      }
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de processos jurídicos dos sócios

Consulta processos jurídicos e administrativos relacionados aos sócios.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.totalLawsuitsOwners` | Total de processos dos sócios |
| `result.totalLawsuitsReplaceOwners` | Total de processos de sócios substitutos |
| `result.totalLawsuitsAsAuthorOwners` | Total de processos como autor |
| `result.totalLawsuitsAsOtherOwners` | Total de processos em outros papéis |
| `result.avgLawsuitsOwners` | Média de processos dos sócios |
| `result.lawSuitsOwners` | Processos agrupados por sócio |

### Consulta de KYC e compliance dos sócios

Consulta informações de KYC e compliance de todos os sócios da empresa em uma
única chamada (pessoas físicas e jurídicas), incluindo exposição política
(PEP) e sanções em listas restritivas nacionais e internacionais.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.totalCurrentPep` | Quantidade de sócios atualmente classificados como PEP |
| `result.totalHistoricallyPEP` | Quantidade de sócios com histórico de PEP (inclui quem já foi PEP e não é mais) |
| `result.totalCurrentSanctioned` | Quantidade de sócios atualmente sancionados |
| `result.totalHistoricallySanctioned` | Quantidade de sócios com histórico de sanções |
| `result.averageSanctionsPerOwner` | Média de sanções por sócio (arredondada) |
| `result.pepPercentage` | Percentual de sócios classificados como PEP |
| `result.kycOwners` | Lista combinada com o detalhamento de KYC de cada sócio (pessoas físicas e jurídicas) |
| `result.companyOwners` / `result.peopleOwners` | O mesmo detalhamento de `kycOwners`, mas já separado por sócios pessoa jurídica e pessoa física |
| `kycOwners[].isPep` | Indica se o sócio é PEP atualmente |
| `kycOwners[].isCurrentlySanctioned` | Indica se o sócio está sancionado atualmente |
| `kycOwners[].sanctionsHistory` | Histórico completo de sanções do sócio |
| `kycOwners[].highConfidenceSanctionsHistory` | O mesmo histórico, filtrado para `matchRate` acima de 90 — use esta lista para decisões automáticas |
| `kycOwners[].pepHistories` | Histórico de cargos e exposição política do sócio |

Não existe um campo `partnersHistory` no retorno deste service — o detalhamento
por sócio vem em `kycOwners` (ou `companyOwners`/`peopleOwners`).

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

Consulta exposição pública e perfil de mídia dos sócios relacionados ao CNPJ.
O retorno traz uma lista em `results`, com um item por pessoa física encontrada.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `results.cpf` | CPF do sócio consultado |
| `results.mediaExposureLevel` | Nível de exposição em mídia |
| `results.celebrityLevel` | Nível de notoriedade pública |
| `results.unpopularityLevel` | Nível de impopularidade |
| `results.fullName` | Nome completo retornado |
| `results.shortName` | Nome curto retornado |
| `results.fullNameUniquenessScore` | Score de unicidade do nome completo |
| `results.shortNameUniquenessScore` | Score de unicidade do nome curto |
| `results.newsItems` | Notícias relacionadas encontradas |

### Consulta de débitos ativos

Consulta débitos da empresa com o governo.

```json
{
  "service": "SERVICE_ACTIVE_DEBT_PJ",
  "cnpj": "cnpj"
}
```

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `result.totalDebtValue` | Valor total dos débitos |
| `result.totalDebtValuePerOrigin` | Valor total dos débitos por origem |
| `result.totalDebts` | Quantidade total de débitos |
| `result.totalDebtsPerOrigin` | Quantidade de débitos por origem |
| `result.debts` | Lista de débitos |
| `status.code` | Código da mensagem de status |
| `status.message` | Mensagem do código de status |

### Certidão negativa de protesto PJ

Consulta informações de protestos em cartórios para pessoa jurídica. Quando não
existem protestos, retorna uma certidão emitida pelo Instituto de Estudos de
Protestos de Títulos do Brasil.

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

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PROTEST_PJ",
    "cnpj": "cnpj"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "77272722134",
    "protestos": [
      {
        "cartorio": "CARTÓRIO LARANJEIRAS - 32º OFÍCIO DE NOTAS DO RIO DE JANEIRO",
        "cidade": "RIO DE JANEIRO",
        "quantidadeTitulos": "",
        "endereco": "R. DAS LARANJEIRAS - LARANJEIRAS, RIO DE JANEIRO - RJ, 22221-060",
        "telefone": "19 3396-2809",
        "protestos": [
          {
            "cpfCnpj": "00000000000000",
            "data": "2017-10-10",
            "dataProtesto": "2017-10-10",
            "dataVencimento": "",
            "valor": "9.900,00"
          },
          {
            "cpfCnpj": "00000000000000",
            "data": "2018-01-01",
            "dataProtesto": "2018-01-01",
            "dataVencimento": "",
            "valor": "16.000,00"
          }
        ]
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

### Consulta de compliance de casas de apostas PJ

Consulta informações de compliance de casas de apostas relacionadas ao CNPJ
informado.

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

Campos principais do retorno:

| Campo | Descrição |
| --- | --- |
| `cnpj` | CNPJ da empresa |
| `status` | Status atual da empresa na Receita Federal |
| `statusDate` | Data da última atualização do status |
| `origin` | Origem das informações |
| `age` | Idade da empresa em anos |
| `foundedDate` | Data de fundação |
| `taxIdCountry` | País de emissão do CNPJ |
| `officialName` | Razão social completa |
| `tradeName` | Nome fantasia |
| `isHeadquarter` | Indica se o CNPJ é matriz |
| `isConglomerate` | Indica se faz parte de conglomerado |
| `taxRegime` | Regime tributário |
| `activities` | Atividades econômicas da empresa |
| `isBet` | Indica se a empresa está relacionada a apostas |
| `onlineBettingCompliance` | Lista de informações de conformidade de apostas online |
| `onlineBettingCompliance.SportsExposure` | Informações de exposição em esportes |
| `onlineBettingCompliance.ForbiddenBet` | Informações de restrições ou apostas proibidas |

Exemplo com `curl`:

```bash
curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_COMPLIANCE_BET_PJ",
    "cnpj": "cnpj"
  }'
```

Exemplo de resposta:

```json
{
  "result": {
    "cnpj": "00000000000000",
    "status": "ATIVA",
    "statusDate": "2024-06-08",
    "origin": "Receita Federal",
    "age": 6,
    "foundedDate": "2018-04-04T00:00:00Z",
    "taxIdCountry": "Brazil",
    "officialName": "NOME OFICIAL ANONIMIZADO",
    "tradeName": "NOME FANTASIA ANONIMIZADO",
    "isHeadquarter": true,
    "isConglomerate": false,
    "taxRegime": "SIMPLES",
    "taxIdStatusRegistrationDate": "2018-04-04T00:00:00Z",
    "taxRegimes": "SIMPLES",
    "activities": [
      {
        "IsMain": true,
        "Code": "6209100",
        "Activity": "SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO"
      },
      {
        "IsMain": false,
        "Code": "6201501",
        "Activity": "DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA"
      },
      {
        "IsMain": false,
        "Code": "6201502",
        "Activity": "WEB DESIGN"
      }
    ],
    "isBet": false,
    "onlineBettingCompliance": [
      {
        "SportsExposure": {
          "Sports": [
            {
              "SportName": "SO**ER",
              "Region": "BRAZIL",
              "TotalRelatedEntities": 1,
              "RelatedEntities": [
                {
                  "DocNumber": "00000000000000",
                  "DocType": "CPF",
                  "RelationshipLevel": "BUSINESS PARTNER",
                  "InstitutionName": "INSTITUICAO ANONIMIZADA",
                  "InstitutionActivity": "CLUBES SOCIAIS, ESPORTIVOS E SIMILARES",
                  "Role": "MANAGER",
                  "IsActive": true,
                  "StartDate": "0001-01-01T00:00:00",
                  "EndDate": "9999-12-31T23:59:59.9999999",
                  "Source": "FONTE ANONIMIZADA"
                }
              ]
            }
          ]
        },
        "ForbiddenBet": {
          "Name": "NOME ANONIMIZADO",
          "Age": "30",
          "IsFromMinisterioDaFazenda": false,
          "IsBookmakerOwner": false,
          "BookmakerOwnerMotives": [
            {
              "Source": "SIGAP",
              "CNPJ": "00000000000000",
              "CompanyName": "EMPRESA ANONIMIZADA",
              "EconomicActivityCodes": "6463800;7319004;9200399",
              "AdditionalDetails": {
                "SIGAPApplicationNumber": "000**024",
                "SIGAPRegistrationDate": "2024-05-26 22:35:16"
              }
            }
          ],
          "MinisterioDaFazendaMotives": {}
        }
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  },
  "externalId": "8e1ac243-4510-4ebf-ac7d-4b6d133dd619"
}
```

---

# Boas-vindas

URL: https://api-docs.idcerberus.com/api-reference/boas-vindas
Fonte: api-reference/boas-vindas.mdx
Descrição: Comece a implementar os endpoints da API idCerberus

# Boas-vindas

Comece sua integração técnica com a API idCerberus. Esta referência concentra os
endpoints, exemplos de request, exemplos de response, autenticação e estruturas
de retorno usadas para integrar produtos de onboarding, KYC, biometria, risco,
compliance e enriquecimento de dados.

Use esta seção quando estiver implementando no código. Para contexto de produto,
fluxos sugeridos e explicações por domínio, consulte os guias.


    Abra o endpoint `POST /api/token-generate` com request, response e exemplo
    em cURL.


    Crie o token usado para iniciar um fluxo de onboarding via SDK.


    Consulte o resultado consolidado de um processo de onboarding.


    Use `POST /api/service-api` para executar consultas de dados, risco,
    documentos, biometria e compliance.


    Veja payloads com imagem, base64, `documentType` e exemplos limpos em `result`.


    Consulte clientes pelo CPF ou CNPJ informado em `documentKey`.


    Ative ou desative registros de cliente pela API.


## Base URL

A API possui ambientes separados para homologação e produção. A estrutura dos
endpoints é a mesma; o que muda é a URL base.

Use o mesmo método, headers e payload nos dois ambientes. Para consumir produção,
troque somente a URL de HML pela URL de produção.

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

Exemplo de URL completa em HML:

```txt
POST https://backoffice-hml.idcerberus.com/api/service-api
```

Exemplo de URL completa em produção:

```txt
POST https://backoffice.idcerberus.com/api/service-api
```

## Autenticação

As chamadas protegidas exigem um token JWT no header `Authorization`.


    Envie `client` e `secret` para `POST /api/token-generate`.


    O retorno contém `access_token` e `expires_in`.


    Use o formato `Authorization: Bearer {jwt_token}`.


HML:

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

Produção:

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

Resposta:

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

## Primeiro request

Para executar consultas avulsas, use `POST /api/service-api`. O campo `service`
define o produto que será processado.

HML:

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

Produção:

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

## Como encontrar o exemplo certo

Dentro de `POST /api/service-api`, os exemplos estão separados pelo nome do produto.
Escolha o exemplo pelo código `service` e substitua os valores de teste pelos
dados reais.

O endpoint é único, mas os exemplos foram organizados como catálogo técnico. Na
prática, cada exemplo representa um produto diferente executado pelo mesmo
endpoint.

| Necessidade | Código `service` |
| --- | --- |
| Enriquecer dados de CPF | `SERVICE_PERSON_DATA_ENRICHMENT` |
| Consultar CPF na Receita Federal | `SERVICE_RFB_PF` |
| Ler documento por OCR | `SERVICE_OCR` |
| Comparar duas faces | `SERVICE_FACE_MATCH` |
| Consultar status de CNPJ | `SERVICE_RFB_PJ` |
| Consultar relacionamentos de empresa | `SERVICE_COMPANY_RELATIONSHIP` |
| Consultar débitos ativos PJ | `SERVICE_ACTIVE_DEBT_PJ` |
| Consultar compliance de apostas PJ | `SERVICE_COMPLIANCE_BET_PJ` |

Para navegar por todos os grupos, veja [Famílias de serviços](/guides/service-api/familias-de-servicos).

## Como ler o POST /api/service-api

| Parte | Como interpretar |
| --- | --- |
| `service` | Código do produto que será executado |
| Campos adicionais | Parâmetros exigidos pelo produto escolhido |
| Exemplo de request | Payload pronto para copiar e adaptar |
| Exemplo de response | Estrutura esperada do retorno daquele produto |
| Schemas | Estruturas genéricas e schemas de apoio para os retornos mais usados |

## Convenções da referência

| Convenção | Como aplicar |
| --- | --- |
| `{jwt_token}` | Substitua pelo token retornado em `POST /api/token-generate` |
| `cpf` e `cnpj` | Envie os documentos conforme o formato esperado pelo seu contrato de integração |
| `base64` | Envie somente o conteúdo codificado da imagem ou documento |
| Campos opcionais | Envie apenas quando o serviço exigir apoio para aumentar a assertividade |
| `status.code` | Use para tratar sucesso ou falha técnica do processamento |
| `result` | Use para mapear os dados de negócio retornados pelo produto |

## Padrão de resposta

A maioria das consultas retorna:

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

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

> Nota:
  Nem todos os endpoints retornam JSON. O download do relatório de onboarding
  retorna um arquivo PDF.

## Principais endpoints

| Operação | Endpoint |
| --- | --- |
| [Gerar token](/api-reference/autorização/gerar-token-de-api) | `POST /api/token-generate` |
| [Gerar TokenOnboarding](/api-reference/integração-via-sdk/gerar-tokenonboarding-para-sdk) | `POST /api/token-history-onboarding` |
| [Consultar onboarding](/api-reference/integração-via-sdk/consultar-resultado-de-onboarding) | `GET /api/onboarding/report/{tokenOnboarding}` |
| [Baixar PDF do onboarding](/api-reference/integração-via-sdk/baixar-relatório-pdf-do-onboarding) | `GET /api/history-onboarding-report/{tokenOnboarding}` |
| [Executar serviço externo](/api-reference/serviços--pessoas/executar-serviço-de-dados-risco-ou-compliance) | `POST /api/service-api` |
| [Consultar cliente](/api-reference/customers/consultar-cliente) | `GET /api/customer?documentKey={documentKey}` |
| [Alterar status de cliente](/api-reference/customers/alterar-status-de-cliente) | `POST /api/changeStatusOfCustomer` |

## Status e erros

Use `status.code` e `status.message` para interpretar o processamento técnico.
Quando houver falha, trate a mensagem retornada antes de repetir a chamada.

```json
{
  "status": {
    "code": 400,
    "message": "Failed to fetch information"
  }
}
```

## Caminho recomendado

1. Gere um token em `POST /api/token-generate`.
2. Abra o endpoint que deseja consumir.
3. Se for usar `POST /api/service-api`, selecione o exemplo pelo campo `service`.
4. Substitua os valores de teste pelos dados reais.
5. Valide o response esperado e mapeie os campos de `result`.
6. Use os guias quando precisar entender o contexto de negócio do produto.

---

# Como executar um service

URL: https://api-docs.idcerberus.com/api-reference/como-executar-service
Fonte: api-reference/como-executar-service.mdx
Descrição: Passo a passo para autenticar, escolher ambiente, montar o body e chamar um service da API idCerberus.

# Como executar um service

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

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

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

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

## Passo a passo

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

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

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

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

- [Services de pessoa física](/api-reference/services-pessoa-fisica)
- [Services de pessoa jurídica](/api-reference/services-pessoa-juridica)
- [Services por caso de uso](/api-reference/services-por-caso-de-uso)

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

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

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

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

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

## Erros comuns

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

---

# Services por caso de uso

URL: https://api-docs.idcerberus.com/api-reference/services-por-caso-de-uso
Fonte: api-reference/services-por-caso-de-uso.mdx
Descrição: Mapa rápido para encontrar o service certo a partir do objetivo da integração.

# Services por caso de uso

Use esta página quando souber o objetivo da integração, mas ainda não souber qual `service` chamar.

> Info:
Depois de escolher o service, abra o catálogo de pessoa física ou pessoa jurídica para copiar o request completo.


 CPF, dados cadastrais, OCR, biometria, risco, compliance e contatos.


 CNPJ, Receita Federal, risco de crédito, sócios, domínios, compliance e OCR.


 Fluxos prontos com payload, retorno esperado e erro comum.


## Como escolher

1. Comece pelo objetivo da consulta.
2. Copie o `service` indicado.
3. Abra o catálogo de pessoa física ou jurídica para ver payload e retorno.
4. Se for OCR, confira o guia de imagem antes de testar.
5. Se quiser um fluxo pronto, use [Receitas prontas](/guides/receitas-prontas).

## Biometria e documentos

| Objetivo | Service | Documento |
| --- | --- | --- |
| Busca de face na base | `SERVICE_FACE_INDEX` | CPF |
| Documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | CPF |
| FaceMatch | `SERVICE_FACE_MATCH` | CPF |
| OCR de cartão CNPJ | `SERVICE_OCR_CNPJ_CARD` | CNPJ |
| OCR de emancipação | `SERVICE_OCR_EMANCIPATION` | CPF |
| OCR React | `SERVICE_OCR` | CPF |
| Resultado da documentoscopia digital | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | CPF |
| Score biométrico | `SERVICE_DATAVALID_CNH` | CPF |

## Contatos, sites e relacionamentos

| Objetivo | Service | Documento |
| --- | --- | --- |
| Dados financeiros e endereços | `SERVICE_PF_FINANCIAL_AND_ADDRESS` | CPF |
| Dados pelo telefone | `SERVICE_CONFIRM_PHONE` | CPF |
| Distribuição de Processos dos Sócios | `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` | CNPJ |
| Doações eleitorais dos sócios | `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` | CNPJ |
| Domínios | `SERVICE_DOMAINS_CPF` | CPF |
| Domínios CNPJ | `SERVICE_DOMAINS_CNPJ` | CNPJ |
| E-mails de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_EMAILS` | CPF |
| Endereços | `SERVICE_ADDRESS` | CPF |
| Endereços de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_ADDRESSES` | CPF |
| Endereços estendidos | `SERVICE_ADDRESSES_EXTENDED_CNPJ` | CNPJ |
| Exposição e perfil na mídia dos sócios | `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` | CNPJ |
| Histórico de e-mails | `SERVICE_EMAILS_EXTENDED` | CPF |
| Histórico de telefones | `SERVICE_PHONE_HISTORY` | CPF |
| KYC e compliance dos sócios | `SERVICE_COMPANY_KYC_OWNERS` | CNPJ |
| OCR de comprovante de endereço | `SERVICE_OCR_PROOF_OF_ADDRESS` | CPF |
| Pessoas relacionadas | `SERVICE_RELATED_PEOPLE` | CPF |
| Processos jurídicos dos sócios | `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` | CNPJ |
| Receita Federal - QSA | `SERVICE_RF_QSA` | CNPJ |
| Relacionamentos da empresa | `SERVICE_COMPANY_RELATIONSHIP` | CNPJ |
| Relacionamentos do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` | CNPJ |
| Relacionamentos econômicos | `SERVICE_ECONOMIC_RELATIONSHIP` | CPF |
| Sócios de primeiro nível | `SERVICE_FIRST_LEVEL_PARTNER` | CNPJ |
| Sócios na Receita Federal | `SERVICE_COMPANY_RFB_OWNERS` | CNPJ |
| Telefones | `SERVICE_PHONES_EXTENDED_COMPANY` | CNPJ |
| Telefones de Pessoas Relacionadas | `SERVICE_RELATED_PEOPLE_PHONES` | CPF |
| Validação de CPF com endereço | `SERVICE_CPF_ADDRESS_VALIDATION` | CPF |
| Validação de CPF com telefone | `SERVICE_CPF_PHONE_VALIDATION` | CPF |
| Validação de e-mail | `SERVICE_EMAIL_VALIDATION` | CPF |

## Dados cadastrais e Receita Federal

| Objetivo | Service | Documento |
| --- | --- | --- |
| Arrecadação Simples Nacional - MEI | `SERVICE_PGMEI` | CNPJ |
| Cartão SUS | `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` | CPF |
| CNPJ na Receita Federal on-demand | `SERVICE_RFB_PJ_ON_DEMAND` | CNPJ |
| Consulta de MEI | `SERVICE_MEI` | CPF |
| CPF na Receita Federal on-demand | `SERVICE_RFB_PF_ON_DEMAND` | CPF |
| Dados cadastrais de CNPJ | `SERVICE_REGISTRATION_DATA_CNPJ` | CNPJ |
| Dados demográficos | `SERVICE_DEMOGRAPHIC_DATA_CPF` | CPF |
| Dados PIS | `SERVICE_PIS_CONSULTATION` | CPF |
| DAS MEI na Receita | `SERVICE_DAS_MEI` | CNPJ |
| Enriquecimento de dados | `SERVICE_PERSON_DATA_ENRICHMENT` | CPF |
| Enriquecimento de dados | `SERVICE_CORPORATE_DATA_ENRICHMENT` | CNPJ |
| Prêmios e certificações | `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF` | CPF |
| SINTEGRA | `SERVICE_SINTEGRA_CONSULTATION` | CNPJ |
| Status do CNPJ na Receita Federal | `SERVICE_RFB_PJ` | CNPJ |
| Status do CPF na Receita Federal | `SERVICE_RFB_PF` | CPF |
| TSE - Local de votação | `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` | CPF |
| Validação do E-Social | `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` | CPF |

## Dados eleitorais e PEP

| Objetivo | Service | Documento |
| --- | --- | --- |
| Dados eleitorais de candidato | `SERVICE_ELECTION_CANDIDATE_DATA_CPF` | CPF |
| Doações eleitorais | `SERVICE_ELECTORAL_DONORS_CPF` | CPF |
| Doações eleitorais | `SERVICE_ELECTORAL_DONORS_CNPJ` | CNPJ |
| Envolvimento político | `SERVICE_POLITICAL_INVOLVEMENT` | CPF |
| Envolvimento político PF | `SERVICE_POLITICAL_INVOLVEMENT_CPF` | CPF |
| Fornecedores eleitorais | `SERVICE_ELECTORAL_PROVIDERS_CNPJ` | CNPJ |
| Histórico familiar político | `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` | CPF |
| KYC e compliance | `SERVICE_PERSON_KYC` | CPF |
| KYC e Compliance do Grupo Econômico | `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` | CNPJ |
| KYC e Compliance dos Funcionários | `SERVICE_EMPLOYEES_KYC` | CNPJ |
| Pessoa politicamente exposta | `SERVICE_PEP` | CPF |
| Prestadores de serviço eleitorais | `SERVICE_ELECTORAL_PROVIDERS_CPF` | CPF |

## Jurídico, certidões e protestos

| Objetivo | Service | Documento |
| --- | --- | --- |
| Ações Trabalhistas | `SERVICE_LABOR_LAWSUITS` | CNPJ |
| Antecedentes criminais civis | `SERVICE_CRIMINAL_RECORD_CIVIL` | CPF |
| Antecedentes criminais federais | `SERVICE_CRIMINAL_RECORD_FEDERAL` | CPF |
| Certidão de Nada Consta | `SERVICE_NOTHING_RECORD_LAWSUITS` | CPF |
| Certidão negativa de protesto | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` | CPF |
| Certidão negativa de protesto | `SERVICE_PROTEST_PJ` | CNPJ |
| Certidão negativa de protesto PF | `SERVICE_PROTEST_PF` | CPF |
| Distribuição de Processos Judiciais | `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` | CNPJ |
| Mandado de prisão | `SERVICE_ARREST_WARRANT` | CPF |
| Processos jurídicos | `SERVICE_JURIDICAL_PROCESSES_PJ` | CNPJ |
| Processos jurídicos e administrativos | `SERVICE_JURIDICAL_PROCESSES` | CPF |

## KYC, compliance e exposição

| Objetivo | Service | Documento |
| --- | --- | --- |
| Compliance de casas de apostas | `SERVICE_COMPLIANCE_BET_PJ` | CNPJ |
| Compliance de casas de apostas (alias curto) | `SERVICE_COMPLIANCE_BET` | CNPJ |
| Exposição e perfil na mídia | `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` | CPF |
| Propensão a apostas online | `SEVICE_ONLINE_BETTING_PROPENSITY` | CPF |

## Outros services

| Objetivo | Service | Documento |
| --- | --- | --- |
| Acordos Sindicais | `SERVICE_SYNDICATE_AGREEMENTS` | CNPJ |
| Anúncios Online | `SERVICE_ONLINE_ADS` | CNPJ |
| Avaliações e Reputação | `SERVICE_REPUTATIONS_AND_REVIEWS` | CNPJ |
| Beneficiários Finais | `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` | CNPJ |
| Benefícios sociais estendidos | `SERVICE_SOCIAL_ASSISTANCE_EXTENDED` | CPF |
| Benefícios sociais familiares | `SERVICE_FAMILY_SOCIAL_BENEFITS` | CPF |
| Categoria Comercial | `SERVICE_MERCHANT_CATEGORY_DATA` | CNPJ |
| Certidão Negativa CNJ | `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` | CNPJ |
| Certidão Negativa Correcional CGU | `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` | CNPJ |
| Cota de PCD | `SERVICE_PCD_COMPANY` | CNPJ |
| Dados de Fundos de Investimento | `SERVICE_INVESTMENT_FUND_DATA` | CNPJ |
| Evolução da Empresa | `SERVICE_COMPANY_EVOLUTION` | CNPJ |
| FGTS | `SERVICE_FGTS` | CNPJ |
| Flags Negativos | `SERVICE_QUOD_CREDIT_RISK_PERSON` | CPF |
| Flags Negativos PJ | `SERVICE_QUOD_CREDIT_RISK_COMPANY` | CNPJ |
| Histórico de Dados Básicos | `SERVICE_HISTORY_BASIC_DATA` | CNPJ |
| Histórico profissional | `SERVICE_PROFESSIONAL_HISTORY` | CPF |
| Histórico profissional do titular | `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` | CPF |
| Indicadores de atividades | `SERVICE_ACTIVITIES_INDICATORS` | CPF |
| Influência do Quadro Societário | `SERVICE_OWNERS_INFLUENCE` | CNPJ |
| Marketplaces | `SERVICE_MARKETPLACE_DATA` | CNPJ |
| Modelagem de dados | `SERVICE_PERSON_DATA_MODELING` | CPF |
| Obras Civis | `SERVICE_CIVIL_CONSTRUCTION` | CNPJ |
| Optante pelo Simples Nacional | `SERVICE_SIMPLES_COMPANY` | CNPJ |
| Percentual de Participação Societária | `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` | CNPJ |
| Projetos Públicos | `SERVICE_PUBLIC_PROJECTS` | CNPJ |
| Prompt de IA para pessoa | `SERVICE_PERSON_AI_PROMPT` | CPF |
| Servidores públicos | `SERVICE_PUBLIC_SERVANTS` | CPF |

## Risco, crédito e dívidas

| Objetivo | Service | Documento |
| --- | --- | --- |
| Certidão Negativa de Débitos Estaduais | `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` | CNPJ |
| Dados Restritivos | `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` | CPF |
| Dados Restritivos PJ | `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` | CNPJ |
| Débitos ativos | `SERVICE_ACTIVE_DEBT_PJ` | CNPJ |
| Débitos com a PGFN | `SERVICE_PGFN_COMPANY` | CNPJ |
| Dívida ativa | `SERVICE_ACTIVE_DEBT_PF` | CPF |
| Informações financeiras | `SERVICE_FINANCIAL_INFORMATION` | CPF |
| Risco de crédito | `SERVICE_CREDIT_RISK_COMPANY` | CNPJ |
| Risco financeiro | `SERVICE_FINANCIAL_RISK_SCORE` | CPF |
| Score de crédito | `SERVICE_CREDIT_SCORE` | CPF |
| Score de Crédito | `SERVICE_QUOD_CREDIT_SCORE_PERSON` | CPF |
| Score de Crédito Multidados | `SERVICE_BOAVISTA_ONE_SCORE_PERSON` | CPF |
| Score de Crédito Multidados PJ | `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` | CNPJ |
| Score de Crédito PJ | `SERVICE_QUOD_CREDIT_SCORE_COMPANY` | CNPJ |
| Score de Crédito Quantum PJ | `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` | CNPJ |
| Score de inadimplência | `SERVICE_DEFAULT_RISK_SCORE` | CPF |
| Score de risco de fraude | `SERVICE_FRAUD_RISK_SCORE` | CPF |

---

# Services de pessoa física

URL: https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica
Fonte: api-reference/services-pessoa-fisica.mdx
Descrição: Catálogo explícito dos services de pessoa física disponíveis via API, com campos esperados e exemplos de request.

> Info:
Catálogo explícito dos services de pessoa física 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.

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

## Antes de testar


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


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


 Payloads para CNH, RG, comprovante, cartão CNPJ, base64 e erros de imagem.


 Exemplos completos para CPF, OCR, Face Index, risco e score.


## Como usar esta página


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


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


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


## Como interpretar qualquer retorno


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


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


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


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


## Famílias de services


 7 services: `SERVICE_FACE_INDEX`, `SERVICE_DIGITAL_DOCUMENTOSCOPY`, `SERVICE_FACE_MATCH` e mais 4.


 15 services: `SERVICE_PF_FINANCIAL_AND_ADDRESS`, `SERVICE_CONFIRM_PHONE`, `SERVICE_DOMAINS_CPF` e mais 12.


 10 services: `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`, `SERVICE_MEI`, `SERVICE_RFB_PF_ON_DEMAND` e mais 7.


 8 services: `SERVICE_ELECTION_CANDIDATE_DATA_CPF`, `SERVICE_ELECTORAL_DONORS_CPF`, `SERVICE_POLITICAL_INVOLVEMENT` e mais 5.


 7 services: `SERVICE_CRIMINAL_RECORD_CIVIL`, `SERVICE_CRIMINAL_RECORD_FEDERAL`, `SERVICE_NOTHING_RECORD_LAWSUITS` e mais 4.


 2 services: `SERVICE_MEDIA_PROFILE_EXPOSURE_PF`, `SEVICE_ONLINE_BETTING_PROPENSITY`.


 9 services: `SERVICE_SOCIAL_ASSISTANCE_EXTENDED`, `SERVICE_FAMILY_SOCIAL_BENEFITS`, `SERVICE_QUOD_CREDIT_RISK_PERSON` e mais 6.


 9 services: `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`, `SERVICE_ACTIVE_DEBT_PF`, `SERVICE_FINANCIAL_INFORMATION` e mais 6.


## Catálogo completo

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

**Service:** `SERVICE_FACE_INDEX`

**Quando usar:** Use para comparar duas imagens faciais e retornar a similaridade entre elas.

**O que retorna:** Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.


 Campos obrigatórios: `service`, `image1`.


 Principais campos em `result`: `cpf`, `faceFound`, `similarity`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `image1`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FACE_INDEX",
  "image1": "base64"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_INDEX",
  "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.cpf` | CPF relacionado ao resultado da consulta. |
| `result.faceFound` | Indica se a busca facial encontrou uma face correspondente na base. |
| `result.similarity` | Percentual de similaridade retornado em validações biométricas ou faciais. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "faceFound": true,
    "similarity": 98.42
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.

**Service:** `SERVICE_DIGITAL_DOCUMENTOSCOPY`

**Quando usar:** Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.

**O que retorna:** Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.


 Campos obrigatórios: `service`, `key`, `image1`, `image2`, `selfie1`.


 Principais campos em `result`: `key`, `status`, `documentData`, `validations`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `key`, `image1`, `image2`, `selfie1`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `key` | Sim | Chave da documentoscopia usada para iniciar ou consultar o processamento. |
| `image1` | Sim | Primeira imagem enviada em base64 ou referência equivalente, conforme o produto. |
| `image2` | Sim | Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens. |
| `selfie1` | Sim | Selfie enviada para validações de documentoscopia e biometria. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.key` | Campo retornado no objeto result para consumo do cliente. |
| `result.status` | Situação principal retornada pelo produto consultado. |
| `result.documentData` | Campo retornado no objeto result para consumo do cliente. |
| `result.validations` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "documentData": {
      "name": "Nome extraído",
      "cpf": "cpf"
    },
    "validations": [
      {
        "name": "faceMatch",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.

**Service:** `SERVICE_FACE_MATCH`

**Quando usar:** Use para comparar duas imagens faciais e retornar a similaridade entre elas.

**O que retorna:** Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.


 Campos obrigatórios: `service`, `image1`, `image2`.


 Principais campos em `result`: `match`, `similarity`, `status`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `image1`, `image2`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "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. |
| `image2` | Sim | Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.match` | Campo retornado no objeto result para consumo do cliente. |
| `result.similarity` | Percentual de similaridade retornado em validações biométricas ou faciais. |
| `result.status` | Situação principal retornada pelo produto consultado. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "match": true,
    "similarity": 98.2,
    "status": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.

**Service:** `SERVICE_OCR_EMANCIPATION`

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**O que retorna:** Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.


 Campos obrigatórios: `service`, `image1`.


 Principais campos em `result`: `docType`, `genericOcr`, `extractedFields`, `analysis`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `image1`

**Campos 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](/guides/service-api/sobre-ocr-service-api).

### Payload mínimo

```json
{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "BASE64_DO_DOCUMENTO"
}
```

### Retorno limpo esperado

```json
{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

### Erro comum

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Não foi possível ler o documento de emancipação"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}
```

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_EMANCIPATION",
  "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.docType` | Tipo de documento identificado no processamento. |
| `result.genericOcr` | Texto bruto extraído do documento por OCR. |
| `result.extractedFields` | Campo extraído do documento enviado para OCR. |
| `result.analysis` | Campo extraído do documento enviado para OCR. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.

**Service:** `SERVICE_OCR`

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**O que retorna:** Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.


 Campos obrigatórios: `service`, `documentType`, `image1`.


 Principais campos em `result`: `cpf`, `docType`, `name`, `birthDate`, `cnhCategory`, `cnhNumber`.


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


 `image2`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `documentType`, `image1`

**Campos opcionais:** `image2`

### Guia de OCR

Para payloads prontos, qualidade de imagem e diagnóstico de erro, consulte [OCR via Service API](/guides/service-api/sobre-ocr-service-api).

### Payload mínimo

```json
{
  "service": "SERVICE_OCR",
  "documentType": "CNH",
  "image1": "BASE64_DA_CNH"
}
```

### Retorno limpo esperado

```json
{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

### Erro comum

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Imagem do documento não encontrada"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}
```

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `documentType` | Sim | Parametro usado pelo service SERVICE_OCR. |
| `image1` | Sim | Primeira imagem enviada em base64 ou referência equivalente, conforme o produto. |
| `image2` | Não | Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.docType` | Tipo de documento identificado no processamento. |
| `result.name` | Nome completo retornado pela consulta quando disponível. |
| `result.birthDate` | Data retornada pela consulta, conforme o contexto do service. |
| `result.cnhCategory` | Campo extraído do documento enviado para OCR. |
| `result.cnhNumber` | Campo extraído do documento enviado para OCR. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.

**Service:** `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`

**Quando usar:** Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.

**O que retorna:** Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.


 Campos obrigatórios: `service`, `key`.


 Principais campos em `result`: `key`, `status`, `fields`, `rules`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `key`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `key` | Sim | Chave da documentoscopia usada para iniciar ou consultar o processamento. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.key` | Campo retornado no objeto result para consumo do cliente. |
| `result.status` | Situação principal retornada pelo produto consultado. |
| `result.fields` | Campo retornado no objeto result para consumo do cliente. |
| `result.rules` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "fields": [
      {
        "name": "cpf",
        "value": "cpf"
      }
    ],
    "rules": [
      {
        "name": "document",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.

**Service:** `SERVICE_DATAVALID_CNH`

**Quando usar:** Use para comparar a imagem enviada com bases biométricas disponíveis e retornar a similaridade.

**O que retorna:** Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.


 Campos obrigatórios: `service`, `cpf`, `image1`.


 Principais campos em `result`: `cpf`, `biometricScore`, `validated`, `validationStatus`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `image1`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `image1` | Sim | Primeira imagem enviada em base64 ou referência equivalente, conforme o produto. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.biometricScore` | Campo retornado no objeto result para consumo do cliente. |
| `result.validated` | Data retornada pela consulta, conforme o contexto do service. |
| `result.validationStatus` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "biometricScore": 0.98,
    "validated": true,
    "validationStatus": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.

**Service:** `SERVICE_PF_FINANCIAL_AND_ADDRESS`

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**O que retorna:** Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `estimatedIncome`, `addresses`, `financialIndicators`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.estimatedIncome` | Campo retornado no objeto result para consumo do cliente. |
| `result.addresses` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |
| `result.financialIndicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "addresses": [
      {
        "city": "Sao Paulo",
        "state": "SP"
      }
    ],
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.

**Service:** `SERVICE_CONFIRM_PHONE`

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**O que retorna:** Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.


 Campos obrigatórios: `service`, `phone`.


 Principais campos em `result`: `phone`, `matched`, `person`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `phone`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `phone` | Sim | Telefone usado para consulta ou validação, de preferência com DDD. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.phone` | Telefone, histórico de telefones ou validação de telefone retornada pela consulta. |
| `result.matched` | Campo retornado no objeto result para consumo do cliente. |
| `result.person` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "phone": "+5561123456789",
    "matched": true,
    "person": {
      "name": "Nome encontrado",
      "document": "cpf"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.

**Service:** `SERVICE_DOMAINS_CPF`

**Quando usar:** Use para consultar dados de sites vinculados à pessoa.

**O que retorna:** Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalDomains`, `domains`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "exemplo.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 CPF, incluindo quantidade e registros encontrados quando disponíveis.

**Service:** `SERVICE_RELATED_PEOPLE_EMAILS`

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**O que retorna:** Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalRelatedPeopleEmails`, `relatedPeopleEmailsList`, `relatedPeopleEmails`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalRelatedPeopleEmails` | Quantidade de e-mails encontrados para pessoas relacionadas ao CPF consultado. |
| `result.relatedPeopleEmailsList` | Lista resumida de e-mails encontrados para pessoas relacionadas ao CPF consultado. |
| `result.relatedPeopleEmails` | Lista estruturada dos e-mails de pessoas relacionadas, com relacionamento e sinais de uso de cada e-mail, usada para renderização em tabela. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeopleEmails": 2,
    "relatedPeopleEmailsList": "nome@email.com - NOME DA PESSOA - 00000000000 - CONJUGE",
    "relatedPeopleEmails": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "CONJUGE",
        "type": "PESSOAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "email": "nome@email.com",
        "domain": "email.com",
        "validationStatus": "VALID"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.

**Service:** `SERVICE_ADDRESS`

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**O que retorna:** Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalAddresses`, `addresses`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalAddresses` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |
| `result.addresses` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalAddresses": 2,
    "addresses": [
      {
        "address": "Rua Exemplo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "Sao Paulo",
        "state": "SP",
        "zipcode": "01001000"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.

**Service:** `SERVICE_RELATED_PEOPLE_ADDRESSES`

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**O que retorna:** Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalRelatedPeopleAddresses`, `relatedPeopleAddressesList`, `relatedPeopleAddresses`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "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.totalRelatedPeopleAddresses` | Quantidade de endereços encontrados para pessoas relacionadas ao CNPJ consultado. |
| `result.relatedPeopleAddressesList` | Lista resumida de endereços encontrados para pessoas relacionadas ao CNPJ consultado. |
| `result.relatedPeopleAddresses` | Lista estruturada dos endereços de pessoas relacionadas, com relacionamento e sinais de uso de cada endereço, usada para renderização em tabela. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalRelatedPeopleAddresses": 1,
    "relatedPeopleAddressesList": "RUA EXEMPLO, 100 - NOME DA PESSOA - 00000000000 - SOCIO",
    "relatedPeopleAddresses": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "SOCIO",
        "type": "RESIDENCIAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "address": "RUA EXEMPLO",
        "zipcode": "00000000",
        "state": "SP",
        "city": "SAO PAULO",
        "neighborhood": "CENTRO",
        "number": "100",
        "complement": "",
        "isRatified": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.

**Service:** `SERVICE_EMAILS_EXTENDED`

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**O que retorna:** Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.


 Campos obrigatórios: `service`, `cpf`, `limit`.


 Principais campos em `result`: `cpf`, `emails`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `limit`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `limit` | Sim | Quantidade máxima de registros que devem ser retornados quando o produto suporta limite. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.emails` | E-mail, histórico de e-mails ou validação de e-mail retornada pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "emails": [
      {
        "email": "email@exemplo.com",
        "priority": 1,
        "isValid": true,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.

**Service:** `SERVICE_PHONE_HISTORY`

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**O que retorna:** Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.


 Campos obrigatórios: `service`, `cpf`, `limit`.


 Principais campos em `result`: `cpf`, `phones`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `limit`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |
| `limit` | Sim | Quantidade máxima de registros que devem ser retornados quando o produto suporta limite. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.phones` | Telefone, histórico de telefones ou validação de telefone retornada pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "phones": [
      {
        "phone": "11900000000",
        "lineType": "MOBILE",
        "priority": 1,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.

**Service:** `SERVICE_OCR_PROOF_OF_ADDRESS`

**Quando usar:** Use para extrair dados de documentos enviados em base64 ou por URL.

**O que retorna:** Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.


 Campos obrigatórios: `service`, `image1`.


 Principais campos em `result`: `genericOcr`, `fullName`, `fullAddress`, `docType`, `dueDate`, `invoiceAmount`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `image1`

**Campos 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](/guides/service-api/sobre-ocr-service-api).

### Payload mínimo

```json
{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "BASE64_DO_COMPROVANTE"
}
```

### Retorno limpo esperado

```json
{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

### Erro comum

```json
{
  "result": {},
  "status": {
    "code": 400,
    "message": "Não foi possível ler o comprovante de endereço"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}
```

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "base64"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "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.genericOcr` | Texto bruto extraído do documento por OCR. |
| `result.fullName` | Nome completo retornado pela consulta quando disponível. |
| `result.fullAddress` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |
| `result.docType` | Tipo de documento identificado no processamento. |
| `result.dueDate` | Data retornada pela consulta, conforme o contexto do service. |
| `result.invoiceAmount` | Valor monetário, estimativa ou montante retornado pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.

**Service:** `SERVICE_RELATED_PEOPLE`

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.

**O que retorna:** Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `relatedPeople`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.relatedPeople` | Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "relatedPeople": [
      {
        "name": "Pessoa relacionada",
        "relationshipType": "FAMILIAR",
        "confidence": "HIGH"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.

**Service:** `SERVICE_ECONOMIC_RELATIONSHIP`

**Quando usar:** Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.

**O que retorna:** Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `relationships`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.relationships` | Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "relationships": [
      {
        "type": "OWNER",
        "relatedDocument": "cnpj",
        "relatedName": "Empresa relacionada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.

**Service:** `SERVICE_RELATED_PEOPLE_PHONES`

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**O que retorna:** Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalRelatedPeoplePhones`, `relatedPeoplePhonesList`, `relatedPeoplePhones`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalRelatedPeoplePhones` | Quantidade de telefones encontrados para pessoas relacionadas ao CPF consultado. |
| `result.relatedPeoplePhonesList` | Lista resumida de telefones encontrados para pessoas relacionadas ao CPF consultado. |
| `result.relatedPeoplePhones` | Lista estruturada dos telefones de pessoas relacionadas, com relacionamento e sinais de uso de cada telefone, usada para renderização em tabela. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeoplePhones": 1,
    "relatedPeoplePhonesList": "11900000000 - NOME DA PESSOA - 00000000000 - FILHO",
    "relatedPeoplePhones": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "FILHO",
        "type": "CELULAR",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "areaCode": "11",
        "number": "900000000",
        "phone": "11900000000",
        "isInDoNotCallList": false
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.

**Service:** `SERVICE_CPF_ADDRESS_VALIDATION`

**Quando usar:** Use para consultar ou validar endereços associados ao documento.

**O que retorna:** Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.


 Campos obrigatórios: `service`, `cpf`, `zipcode`, `numberAddress`.


 Principais campos em `result`: `cpf`, `zipcode`, `match`, `confidence`, `normalizedAddress`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `zipcode`, `numberAddress`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `zipcode` | Sim | CEP usado na validação de endereço. |
| `numberAddress` | Sim | Numero do endereço usado na validação. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.zipcode` | Campo retornado no objeto result para consumo do cliente. |
| `result.match` | Campo retornado no objeto result para consumo do cliente. |
| `result.confidence` | Campo retornado no objeto result para consumo do cliente. |
| `result.normalizedAddress` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "zipcode": "01001000",
    "match": true,
    "confidence": "HIGH",
    "normalizedAddress": "Rua Exemplo, 100"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.

**Service:** `SERVICE_CPF_PHONE_VALIDATION`

**Quando usar:** Use para consultar, validar ou enriquecer dados de telefone.

**O que retorna:** Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.


 Campos obrigatórios: `service`, `cpf`, `phone`.


 Principais campos em `result`: `cpf`, `phone`, `match`, `statusMessage`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `phone`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `phone` | Sim | Telefone usado para consulta ou validação, de preferência com DDD. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.phone` | Telefone, histórico de telefones ou validação de telefone retornada pela consulta. |
| `result.match` | Campo retornado no objeto result para consumo do cliente. |
| `result.statusMessage` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "phone": "11900000000",
    "match": true,
    "statusMessage": "Telefone associado ao documento"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.

**Service:** `SERVICE_EMAIL_VALIDATION`

**Quando usar:** Use para validar ou consultar histórico de e-mails relacionados ao documento.

**O que retorna:** Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.


 Campos obrigatórios: `service`, `email`.


 Principais campos em `result`: `email`, `validFormat`, `deliverable`, `domain`, `riskLevel`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `email`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "email@email.com"
}
```

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

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "email@email.com"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `email` | Sim | E-mail que será validado ou consultado. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.email` | E-mail, histórico de e-mails ou validação de e-mail retornada pela consulta. |
| `result.validFormat` | Campo retornado no objeto result para consumo do cliente. |
| `result.deliverable` | Campo retornado no objeto result para consumo do cliente. |
| `result.domain` | Campo retornado no objeto result para consumo do cliente. |
| `result.riskLevel` | Indicador de risco retornado pelo produto. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "email": "email@email.com",
    "validFormat": true,
    "deliverable": true,
    "domain": "email.com",
    "riskLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.

**Service:** `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`

**Quando usar:** Use este service quando precisar executar a consulta "Cartão SUS" via API.

**O que retorna:** Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `sus_card_success`, `sus_card_number`, `sus_card_source`, `sus_card_capture_date`, `sus_card_birth_date` e mais 6.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.sus_card_success` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_number` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_source` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_capture_date` | Data retornada pela consulta, conforme o contexto do service. |
| `result.sus_card_birth_date` | Data retornada pela consulta, conforme o contexto do service. |
| `result.sus_card_birth_city` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_birth_state` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_has_evidence` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_raw_result_file` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_raw_result_file_type` | Campo retornado no objeto result para consumo do cliente. |
| `result.sus_card_summary` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "sus_card_success": "Sim",
    "sus_card_number": "126000000000009",
    "sus_card_source": "BA",
    "sus_card_capture_date": "08/25/2025 20:07:36",
    "sus_card_birth_date": "03/13/1980 00:00:00",
    "sus_card_birth_city": "CHORROCHO",
    "sus_card_birth_state": "BA",
    "sus_card_has_evidence": "Não",
    "sus_card_raw_result_file": "https://example.com/documents/sus-card.pdf",
    "sus_card_raw_result_file_type": "pdf",
    "sus_card_summary": "Cartão SUS localizado"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.

**Service:** `SERVICE_MEI`

**Quando usar:** Use este service quando precisar executar a consulta "Consulta de MEI" via API.

**O que retorna:** Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `meiCompanies`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.meiCompanies` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "meiCompanies": [
      {
        "cnpj": "cnpj",
        "officialName": "MEI EXEMPLO",
        "status": "ATIVA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.

**Service:** `SERVICE_RFB_PF_ON_DEMAND`

**Quando usar:** Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.

**O que retorna:** Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `name`, `birthDate`, `registrationStatus`, `protocol`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.name` | Nome completo retornado pela consulta quando disponível. |
| `result.birthDate` | Data retornada pela consulta, conforme o contexto do service. |
| `result.registrationStatus` | Campo retornado no objeto result para consumo do cliente. |
| `result.protocol` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.

**Service:** `SERVICE_DEMOGRAPHIC_DATA_CPF`

**Quando usar:** Use para consultar dados demograficos associados à pessoa.

**O que retorna:** Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `demographicData`, `totalIndicators`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.demographicData` | Campo retornado no objeto result para consumo do cliente. |
| `result.totalIndicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "demographicData": [
      {
        "indicator": "Faixa de renda",
        "value": "Media"
      }
    ],
    "totalIndicators": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.

**Service:** `SERVICE_PIS_CONSULTATION`

**Quando usar:** Use este service quando precisar executar a consulta "Dados PIS" via API.

**O que retorna:** Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `pis`, `status`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.pis` | Campo retornado no objeto result para consumo do cliente. |
| `result.status` | Situação principal retornada pelo produto consultado. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "pis": "00000000000",
    "status": "FOUND"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.

**Service:** `SERVICE_PERSON_DATA_ENRICHMENT`

**Quando usar:** Use para complementar dados cadastrais da pessoa a partir do documento informado.

**O que retorna:** Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `name`, `birthDate`, `registrationStatus`, `motherName`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.name` | Nome completo retornado pela consulta quando disponível. |
| `result.birthDate` | Data retornada pela consulta, conforme o contexto do service. |
| `result.registrationStatus` | Campo retornado no objeto result para consumo do cliente. |
| `result.motherName` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "motherName": "Nome da mãe"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.

**Service:** `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`

**Quando usar:** Use este service quando precisar executar a consulta "Prêmios e certificações" via API.

**O que retorna:** Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalAwards`, `totalCertifications`, `awards`, `certifications`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalAwards` | Campo retornado no objeto result para consumo do cliente. |
| `result.totalCertifications` | Campo retornado no objeto result para consumo do cliente. |
| `result.awards` | Campo retornado no objeto result para consumo do cliente. |
| `result.certifications` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalAwards": 0,
    "totalCertifications": 0,
    "awards": [],
    "certifications": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.

**Service:** `SERVICE_RFB_PF`

**Quando usar:** Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.

**O que retorna:** Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `name`, `birthDate`, `registrationStatus`, `protocol`.


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


 `dataDeNascimento`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `dataDeNascimento`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `dataDeNascimento` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.name` | Nome completo retornado pela consulta quando disponível. |
| `result.birthDate` | Data retornada pela consulta, conforme o contexto do service. |
| `result.registrationStatus` | Campo retornado no objeto result para consumo do cliente. |
| `result.protocol` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.

**Service:** `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`

**Quando usar:** Use este service quando precisar executar a consulta "TSE - Local de votação" via API.

**O que retorna:** Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `status`, `pollingPlace`, `pollingPlaceAddress`, `city`, `uf` e mais 7.


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


 `birthDate`, `motherName`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`, `motherName`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |
| `motherName` | Não | Nome da mãe usado para aumentar a assertividade da consulta. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.status` | Situação principal retornada pelo produto consultado. |
| `result.pollingPlace` | Nome do local de votação retornado pelo TSE. |
| `result.pollingPlaceAddress` | Endereço vigente do local de votação retornado pelo TSE. |
| `result.city` | Campo retornado no objeto result para consumo do cliente. |
| `result.uf` | Campo retornado no objeto result para consumo do cliente. |
| `result.zipcode` | Campo retornado no objeto result para consumo do cliente. |
| `result.electoralZone` | Zona eleitoral do local de votação. |
| `result.electoralSection` | Seção eleitoral do local de votação. |
| `result.hasBiometrics` | Indica se o TSE retornou biometria cadastrada para a pessoa. |
| `result.queryDate` | Data retornada pela fonte de dados para a consulta. |
| `result.source` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "status": "REGULAR",
    "pollingPlace": "ESCOLA CLASSE 01",
    "pollingPlaceAddress": "QUADRA 01, BRASILIA - DF",
    "city": "BRASILIA",
    "uf": "DF",
    "zipcode": "70000000",
    "electoralZone": "001",
    "electoralSection": "0001",
    "hasBiometrics": true,
    "queryDate": "2026-08-01",
    "source": "TSE-LOCALVOTACAO",
    "onlineQuery": "Situação, local, endereço, zona e seção retornados com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.

**Service:** `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`

**Quando usar:** Use este service quando precisar executar a consulta "Validação do E-Social" via API.

**O que retorna:** Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `nit`, `qualified`, `inconsistencies`.


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


 `nit`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `nit`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `nit` | Não | NIT/PIS/PASEP usado na qualificação cadastral. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.nit` | Campo retornado no objeto result para consumo do cliente. |
| `result.qualified` | Campo retornado no objeto result para consumo do cliente. |
| `result.inconsistencies` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "nit": "nit",
    "qualified": true,
    "inconsistencies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.

**Service:** `SERVICE_ELECTION_CANDIDATE_DATA_CPF`

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**O que retorna:** Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `candidacies`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.candidacies` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "candidacies": [
      {
        "year": 2024,
        "role": "VEREADOR",
        "party": "PARTIDO",
        "status": "DEFERIDO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.

**Service:** `SERVICE_ELECTORAL_DONORS_CPF`

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**O que retorna:** Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `donations`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}
```

```bash
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_CPF",
  "cpf": "cpf"
}'
```

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.donations` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "500.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

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

**Service:** `SERVICE_POLITICAL_INVOLVEMENT`

**Quando usar:** Use este service quando precisar executar a consulta "Envolvimento político" via API.

**O que retorna:** Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `politicalInvolvement`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.politicalInvolvement` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "CANDIDACY",
        "year": 2024,
        "details": "Candidatura encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

**Service:** `SERVICE_POLITICAL_INVOLVEMENT_CPF`

**Quando usar:** Use este service quando precisar executar a consulta "Envolvimento político PF" via API.

**O que retorna:** Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `politicalInvolvement`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.politicalInvolvement` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "DONATION",
        "year": 2024,
        "details": "Doacao encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

**Service:** `SERVICE_FAMILY_POLITICAL_HISTORY_CPF`

**Quando usar:** Use este service quando precisar executar a consulta "Histórico familiar político" via API.

**O que retorna:** Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `familyPoliticalHistory`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.familyPoliticalHistory` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "familyPoliticalHistory": [
      {
        "relativeName": "Nome relacionado",
        "relationship": "PARENTE",
        "role": "Candidato"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.

**Service:** `SERVICE_PERSON_KYC`

**Quando usar:** Use para executar checagens de KYC e compliance da pessoa.

**O que retorna:** Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `isPep`, `sanctions`, `mediaExposure`, `riskAlerts`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.isPep` | Campo retornado no objeto result para consumo do cliente. |
| `result.sanctions` | Campo retornado no objeto result para consumo do cliente. |
| `result.mediaExposure` | Notícias, exposição em mídia ou indicadores públicos associados ao documento. |
| `result.riskAlerts` | Indicador de risco retornado pelo produto. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "sanctions": [],
    "mediaExposure": [],
    "riskAlerts": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.

**Service:** `SERVICE_PEP`

**Quando usar:** Use para verificar exposição política ou vínculo com Pessoa Politicamente Exposta.

**O que retorna:** Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `isPep`, `positions`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.isPep` | Campo retornado no objeto result para consumo do cliente. |
| `result.positions` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "positions": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.

**Service:** `SERVICE_ELECTORAL_PROVIDERS_CPF`

**Quando usar:** Use para consultar informações eleitorais relacionadas à pessoa.

**O que retorna:** Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `campos`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}
```

```bash
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_CPF",
  "cpf": "cpf"
}'
```

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.campos` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "800.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 CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.

**Service:** `SERVICE_CRIMINAL_RECORD_CIVIL`

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**O que retorna:** Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.


 Campos obrigatórios: `service`, `cpf`, `rg`, `uf`.


 Principais campos em `result`: `cpf`, `rg`, `state`, `hasRecords`, `records`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `rg`, `uf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `rg` | Sim | Numero do RG usado em certidões ou validações documentais. |
| `uf` | Sim | UF usada para limitar a consulta estadual ou jurídica. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.rg` | Campo retornado no objeto result para consumo do cliente. |
| `result.state` | Campo retornado no objeto result para consumo do cliente. |
| `result.hasRecords` | Campo retornado no objeto result para consumo do cliente. |
| `result.records` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "rg": "rg",
    "state": "SP",
    "hasRecords": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.

**Service:** `SERVICE_CRIMINAL_RECORD_FEDERAL`

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**O que retorna:** Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `hasFederalCriminalRecord`, `records`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.hasFederalCriminalRecord` | Campo retornado no objeto result para consumo do cliente. |
| `result.records` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "hasFederalCriminalRecord": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.

**Service:** `SERVICE_NOTHING_RECORD_LAWSUITS`

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**O que retorna:** Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.


 Campos obrigatórios: `service`, `cpf`, `court`, `uf`, `sphere`.


 Principais campos em `result`: `cpf`, `court`, `sphere`, `nothingFound`, `records`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `court`, `uf`, `sphere`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `court` | Sim | Tribunal ou órgão usado na consulta de certidão/processo. |
| `uf` | Sim | UF usada para limitar a consulta estadual ou jurídica. |
| `sphere` | Sim | Esfera da consulta, como civil, criminal ou federal. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.court` | Campo retornado no objeto result para consumo do cliente. |
| `result.sphere` | Campo retornado no objeto result para consumo do cliente. |
| `result.nothingFound` | Campo retornado no objeto result para consumo do cliente. |
| `result.records` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "court": "TRF1",
    "sphere": "CIVIL",
    "nothingFound": true,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.

**Service:** `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`

**Quando usar:** Use para consultar protestos associados ao documento da pessoa.

**O que retorna:** Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `hasProtests`, `protests`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.hasProtests` | Campo retornado no objeto result para consumo do cliente. |
| `result.protests` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.

**Service:** `SERVICE_PROTEST_PF`

**Quando usar:** Use para consultar protestos associados ao documento da pessoa.

**O que retorna:** Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `hasProtests`, `notaryOffices`, `protests`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

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

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

**Service:** `SERVICE_ARREST_WARRANT`

**Quando usar:** Use este service quando precisar executar a consulta "Mandado de prisão" via API.

**O que retorna:** Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.


 Campos obrigatórios: `service`, `nome`, `motherName`, `fatherName`, `birthDate`, `cpf`.


 Principais campos em `result`: `cpf`, `hasArrestWarrant`, `warrants`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `nome`, `motherName`, `fatherName`, `birthDate`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `nome` | Sim | Nome completo usado na consulta quando não ha documento suficiente. |
| `motherName` | Sim | Nome da mãe usado para aumentar a assertividade da consulta. |
| `fatherName` | Sim | Nome do pai usado para aumentar a assertividade da consulta. |
| `birthDate` | Sim | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.hasArrestWarrant` | Campo retornado no objeto result para consumo do cliente. |
| `result.warrants` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "hasArrestWarrant": false,
    "warrants": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.

**Service:** `SERVICE_JURIDICAL_PROCESSES`

**Quando usar:** Use para consultar certidões, processos ou informações jurídicas da pessoa.

**O que retorna:** Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalProcesses`, `processes`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}
```

```bash
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",
  "cpf": "cpf"
}'
```

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "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 e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.

**Service:** `SERVICE_MEDIA_PROFILE_EXPOSURE_PF`

**Quando usar:** Use este service quando precisar executar a consulta "Exposição e perfil na mídia" via API.

**O que retorna:** Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `mediaMentions`, `exposureLevel`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}
```

```bash
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_PF",
  "cpf": "cpf"
}'
```

```bash
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_PF",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "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 pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

**Service:** `SEVICE_ONLINE_BETTING_PROPENSITY`

**Quando usar:** Use este service quando precisar executar a consulta "Propensão a apostas online" via API.

**O que retorna:** Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `propensityScore`, `propensityLevel`, `indicators`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.propensityScore` | Campo retornado no objeto result para consumo do cliente. |
| `result.propensityLevel` | Campo retornado no objeto result para consumo do cliente. |
| `result.indicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "propensityScore": 78,
    "propensityLevel": "HIGH",
    "indicators": [
      "sinal encontrado"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.

**Service:** `SERVICE_SOCIAL_ASSISTANCE_EXTENDED`

**Quando usar:** Use este service quando precisar executar a consulta "Benefícios sociais estendidos" via API.

**O que retorna:** Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalBenefits`, `benefits`, `indicators`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalBenefits` | Campo retornado no objeto result para consumo do cliente. |
| `result.benefits` | Campo retornado no objeto result para consumo do cliente. |
| `result.indicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ],
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.

**Service:** `SERVICE_FAMILY_SOCIAL_BENEFITS`

**Quando usar:** Use este service quando precisar executar a consulta "Benefícios sociais familiares" via API.

**O que retorna:** Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalBenefits`, `benefits`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.totalBenefits` | Campo retornado no objeto result para consumo do cliente. |
| `result.benefits` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.

**Service:** `SERVICE_QUOD_CREDIT_RISK_PERSON`

**Quando usar:** Use este service quando precisar executar a consulta "Flags Negativos" via API.

**O que retorna:** Retorna flags negativos de crédito de pessoa física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.


 Campos obrigatórios: `service`, `cpf`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_QUOD_CREDIT_RISK_PERSON",
  "cpf": "cpf"
}
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "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 física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

**Service:** `SERVICE_PROFESSIONAL_HISTORY`

**Quando usar:** Use este service quando precisar executar a consulta "Histórico profissional" via API.

**O que retorna:** Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `professionalHistory`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.professionalHistory` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "professionalHistory": [
      {
        "companyName": "Empresa Exemplo",
        "role": "Analista",
        "startDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.

**Service:** `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`

**Quando usar:** Use este service quando precisar executar a consulta "Histórico profissional do titular" via API.

**O que retorna:** Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `ownerHistory`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.ownerHistory` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "ownerHistory": [
      {
        "companyName": "Empresa Exemplo",
        "cnpj": "cnpj",
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.

**Service:** `SERVICE_ACTIVITIES_INDICATORS`

**Quando usar:** Use este service quando precisar executar a consulta "Indicadores de atividades" via API.

**O que retorna:** Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `activityIndicators`, `hasActivityIndicators`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.activityIndicators` | Campo retornado no objeto result para consumo do cliente. |
| `result.hasActivityIndicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "activityIndicators": [
      {
        "type": "PROFESSIONAL",
        "description": "Indicador encontrado"
      }
    ],
    "hasActivityIndicators": true
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.

**Service:** `SERVICE_PERSON_DATA_MODELING`

**Quando usar:** Use este service quando precisar executar a consulta "Modelagem de dados" via API.

**O que retorna:** Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `profileSummary`, `contacts`, `addresses`, `relationships`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.profileSummary` | Campo retornado no objeto result para consumo do cliente. |
| `result.contacts` | Campo retornado no objeto result para consumo do cliente. |
| `result.addresses` | Endereço, lista de endereços ou validação de endereço retornada pela consulta. |
| `result.relationships` | Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "profileSummary": "Resumo consolidado",
    "contacts": [],
    "addresses": [],
    "relationships": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.

**Service:** `SERVICE_PERSON_AI_PROMPT`

**Quando usar:** Use este service quando precisar executar a consulta "Prompt de IA para pessoa" via API.

**O que retorna:** Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `answer`, `highlights`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.answer` | Campo retornado no objeto result para consumo do cliente. |
| `result.highlights` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "answer": "Resumo analitico gerado pela IA",
    "highlights": [
      "ponto relevante"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.

**Service:** `SERVICE_PUBLIC_SERVANTS`

**Quando usar:** Use este service quando precisar executar a consulta "Servidores públicos" via API.

**O que retorna:** Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `publicServantRecords`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.publicServantRecords` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "publicServantRecords": [
      {
        "agency": "Orgao publico",
        "role": "Cargo",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.

**Service:** `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `hasRestrictions`, `restrictionCount`, `creditBureauSummary`, `creditBureauDetails` e mais 2.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 705,
    "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 física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.

**Service:** `SERVICE_ACTIVE_DEBT_PF`

**Quando usar:** Use para consultar débitos ou dívidas associadas à pessoa.

**O que retorna:** Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `totalDebts`, `totalValue`, `debts`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}
```

```bash
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_PF",
  "cpf": "cpf"
}'
```

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "totalDebts": 2,
    "totalValue": "1234.56",
    "debts": [
      {
        "source": "PGFN",
        "value": "1234.56",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.

**Service:** `SERVICE_FINANCIAL_INFORMATION`

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**O que retorna:** Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `estimatedIncome`, `purchasingPower`, `financialIndicators`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.estimatedIncome` | Campo retornado no objeto result para consumo do cliente. |
| `result.purchasingPower` | Campo retornado no objeto result para consumo do cliente. |
| `result.financialIndicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "purchasingPower": "MEDIUM",
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.

**Service:** `SERVICE_FINANCIAL_RISK_SCORE`

**Quando usar:** Use para consultar informações financeiras associadas à pessoa.

**O que retorna:** Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `riskLevel`, `recommendation`.


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


 `birthDate`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** `birthDate`

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `birthDate` | Não | Data de nascimento usada para aumentar a precisão da consulta quando exigida. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.score` | Pontuação calculada pelo produto para o indicador consultado. |
| `result.riskLevel` | Indicador de risco retornado pelo produto. |
| `result.recommendation` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 681,
    "riskLevel": "MEDIUM",
    "recommendation": "REVIEW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.

**Service:** `SERVICE_CREDIT_SCORE`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `riskLevel`, `message`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.score` | Pontuação calculada pelo produto para o indicador consultado. |
| `result.riskLevel` | Indicador de risco retornado pelo produto. |
| `result.message` | Mensagem de leitura do resultado ou do processamento. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 750,
    "riskLevel": "LOW",
    "message": "Score calculado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.

**Service:** `SERVICE_QUOD_CREDIT_SCORE_PERSON`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna score de crédito de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `riskLevel`, `riskClassification`, `reasonCodes`, `creditBureauSummary` e mais 3.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 680,
    "riskLevel": "MEDIO",
    "riskClassification": "B",
    "reasonCodes": [
      "Tempo de relacionamento com o mercado",
      "Renda declarada baixa"
    ],
    "creditBureauSummary": "Score de crédito dentro da média do perfil",
    "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 física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

**Service:** `SERVICE_BOAVISTA_ONE_SCORE_PERSON`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna score de crédito multidados de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `riskLevel`, `riskClassification`, `reasonCodes`, `creditBureauSummary` e mais 3.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON",
  "cpf": "cpf"
}
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF 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


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 710,
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "reasonCodes": [
      "Bom histórico de pagamentos"
    ],
    "creditBureauSummary": "Score de crédito multidados acima da média do perfil",
    "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 física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

**Service:** `SERVICE_DEFAULT_RISK_SCORE`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.


 Campos obrigatórios: `service`, `cpf`.


 Principais campos em `result`: `cpf`, `score`, `riskLevel`, `defaultProbability`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}
```

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

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

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.score` | Pontuação calculada pelo produto para o indicador consultado. |
| `result.riskLevel` | Indicador de risco retornado pelo produto. |
| `result.defaultProbability` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "score": 690,
    "riskLevel": "MEDIUM",
    "defaultProbability": "8%"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.

**Service:** `SERVICE_FRAUD_RISK_SCORE`

**Quando usar:** Use para avaliar risco, score ou propensão associada à pessoa.

**O que retorna:** Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.


 Campos obrigatórios: `service`, `cpf`, `factor`.


 Principais campos em `result`: `cpf`, `factor`, `score`, `riskLevel`, `indicators`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cpf`, `factor`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

```json
{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}
```

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'
```

```bash
curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'
```

### Campos do body

| Campo | Obrigatório | Descrição |
| --- | --- | --- |
| `service` | Sim | Código exato do produto que será executado pelo endpoint central. |
| `cpf` | Sim | CPF da pessoa física consultada. |
| `factor` | Sim | Fator de risco solicitado no payload, como risco mínimo ou atrito mínimo. |

### Campos principais do result

| Campo | Descrição |
| --- | --- |
| `result.cpf` | CPF relacionado ao resultado da consulta. |
| `result.factor` | Fator, faixa ou classificação usada para interpretar o score. |
| `result.score` | Pontuação calculada pelo produto para o indicador consultado. |
| `result.riskLevel` | Indicador de risco retornado pelo produto. |
| `result.indicators` | Campo retornado no objeto result para consumo do cliente. |

### Como consumir o retorno


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


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


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


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


### Response resumido

```json
{
  "result": {
    "cpf": "cpf",
    "factor": "minRisk",
    "score": 720,
    "riskLevel": "LOW",
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Neste service, o objeto `result` representa: Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.

## Checklist antes de abrir chamado


 Confirme se o token pertence ao produto certo e se o service está ativo para API.


 Confirme o valor exato de `service` e os campos obrigatórios listados no accordion.


 Valide se a chamada foi feita em HML ou produção com o token do mesmo ambiente.


 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.

```json
{
  "status": {
    "code": 401,
    "message": "Unauthorized"
  }
}
```

```json
{
  "status": {
    "code": 400,
    "message": "Required field is missing or invalid"
  }
}
```

```json
{
  "status": {
    "code": 403,
    "message": "Service unavailable or not enabled for this client"
  }
}
```

---

# Services de pessoa jurídica

URL: https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica
Fonte: api-reference/services-pessoa-juridica.mdx
Descrição: Catálogo explícito dos services de pessoa jurídica disponíveis via API, com campos esperados e exemplos de request.

> Info:
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.

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

## Antes de testar


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


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


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


 Exemplos completos para CNPJ, risco, cadastro e OCR.


## Como usar esta página


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


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


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


## Como interpretar qualquer retorno


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


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


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


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


## Famílias de services


 1 service: `SERVICE_OCR_CNPJ_CARD`.


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


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


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


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


 2 services: `SERVICE_COMPLIANCE_BET_PJ`, `SERVICE_COMPLIANCE_BET`.


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


 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.

**Service:** `SERVICE_OCR_CNPJ_CARD`

**Quando 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.


 Campos obrigatórios: `service`, `image1`.


 Principais campos em `result`: `cnpj`, `docType`, `genericOcr`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `image1`

**Campos 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](/guides/service-api/sobre-ocr-service-api).

### Payload mínimo

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

### Retorno limpo esperado

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

### Erro comum

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

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `ownersDonations`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_DOMAINS_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalDomains`, `domains`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ADDRESSES_EXTENDED_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `mediaMentions`, `exposureLevel`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPANY_KYC_OWNERS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `ownersProcesses`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_RF_QSA`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPANY_RELATIONSHIP`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `owners`, `relatedCompanies`.


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


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


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


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


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


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

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

### Copiar e testar

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

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

```bash
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"
}'
```

```bash
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


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


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


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


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_FIRST_LEVEL_PARTNER`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `partners`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_FIRST_LEVEL_PARTNER",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPANY_RFB_OWNERS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `owners`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_COMPANY_RFB_OWNERS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PHONES_EXTENDED_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `phonesExtendedCompanyTotal`, `phonesExtendedCompanyTotalActive`, `phonesExtendedCompanySummary`, `phonesExtendedCompanyStats`, `phonesExtendedCompany`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PHONES_EXTENDED_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PGMEI`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `pgmeiStatus`, `pgmeiReferenceYear`, `pgmeiPendingGuides`, `pgmeiSummary`, `pgmeiGuides`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PGMEI",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_RFB_PJ_ON_DEMAND`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `officialName`, `status`, `openingDate`, `mainActivity`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_RFB_PJ_ON_DEMAND",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_REGISTRATION_DATA_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `officialName`, `tradeName`, `status`, `openingDate`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_DAS_MEI`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `meiStatus`, `periods`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_DAS_MEI",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_CORPORATE_DATA_ENRICHMENT`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `officialName`, `tradeName`, `status`, `mainActivity`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_CORPORATE_DATA_ENRICHMENT",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_SINTEGRA_CONSULTATION`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `stateRegistration`, `state`, `status`, `regime`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 `uf`


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** `uf`

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_SINTEGRA_CONSULTATION",
  "cnpj": "cnpj",
  "uf": "uf (opcional)"
}
```

```bash
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)"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_RFB_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `officialName`, `status`, `openingDate`, `mainActivity`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_RFB_PJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ELECTORAL_DONORS_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `donations`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ELECTORAL_DONORS_CNPJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ELECTORAL_PROVIDERS_CNPJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `campos`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CNPJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ECONOMIC_GROUP_KYC_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `economicGroupKycSummary`, `economicGroupTotalCurrentPep`, `economicGroupTotalHistoricalPep`, `economicGroupTotalCurrentSanctioned`, `economicGroupTotalHistoricalSanctioned` e mais 1.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_EMPLOYEES_KYC`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `employeesKycTotalEmployees`, `employeesKycCurrentlyPepCount`, `employeesKycCurrentlySanctionedCount`, `employeesKycPreviouslySanctionedCount`, `employeesKycFlaggedCount` e mais 2.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_EMPLOYEES_KYC",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_LABOR_LAWSUITS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `laborLawsuitsStatus`, `laborLawsuitsProtocol`, `laborLawsuitsCertificateNumber`, `laborLawsuitsIssuedDate`, `laborLawsuitsContent` e mais 3.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_LABOR_LAWSUITS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PROTEST_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `hasProtests`, `notaryOffices`, `protests`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PROTEST_PJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `companyLawsuitsTotal`, `companyLawsuitsFirstDate`, `companyLawsuitsLastDate`, `companyLawsuitsLast30Days`, `companyLawsuitsLast90Days` e mais 4.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_JURIDICAL_PROCESSES_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalProcesses`, `processes`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_JURIDICAL_PROCESSES_PJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPLIANCE_BET_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `hasBettingExposure`, `indicators`, `riskLevel`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_COMPLIANCE_BET_PJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPLIANCE_BET`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `hasBettingExposure`, `indicators`, `riskLevel`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_COMPLIANCE_BET",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_SYNDICATE_AGREEMENTS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `syndicateAgreementsTotal`, `syndicateAgreementsTotalActive`, `syndicateAgreementsSummary`, `syndicateAgreementsStats`, `syndicateAgreements`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_SYNDICATE_AGREEMENTS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ONLINE_ADS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `onlineAdsTotalPhones`, `onlineAdsSummary`, `onlineAds`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ONLINE_ADS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_REPUTATIONS_AND_REVIEWS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalReputationSources`, `reputationSummary`, `reputationAndReviews`, `reputationSummaryDetails`, `reputationSummaryByDataSources`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_REPUTATIONS_AND_REVIEWS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ULTIMATE_BENEFICIAL_OWNERS`

**Quando 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%.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `uboSummary`, `uboTotalCompaniesInGroup`, `uboTotalPeopleInGroup`, `uboNumberOfOwners`, `uboBeneficialOwners` e mais 1.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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%.

**Service:** `SERVICE_MERCHANT_CATEGORY_DATA`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `merchantCategoryHasDirectAssociation`, `merchantCategoryHasMultipleCodes`, `merchantCategorySummary`, `merchantCategoryCategories`, `merchantCategoryCnaeCategories`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_MERCHANT_CATEGORY_DATA",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `cnjSummary`, `cnjBaseStatus`, `cnjClearance`, `cnjIssueDate`, `cnjCertificateUrl`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `cguSummary`, `cguBaseStatus`, `cguClearance`, `cguValidUntil`, `cguIssueDate` e mais 1.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PCD_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `pcdSummary`, `pcdBaseStatus`, `pcdExpeditionDate`, `pcdCertificateUrl`, `pcdContent`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PCD_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_INVESTMENT_FUND_DATA`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalMovimentations`, `investmentFundDataSummary`, `investmentFundData`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_INVESTMENT_FUND_DATA",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_COMPANY_EVOLUTION`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `companyEvolutionSummary`, `companyEvolutionStats`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_COMPANY_EVOLUTION",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_FGTS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `fgtsStatus`, `fgtsCertificateNumber`, `fgtsCertificateValidity`, `fgtsCertificateText`, `fgtsSummary` e mais 1.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_FGTS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_QUOD_CREDIT_RISK_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `riskLevel`, `riskClassification`, `hasRestrictions`, `negativeFlagsCount`, `creditBureauSummary` e mais 3.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_QUOD_CREDIT_RISK_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_HISTORY_BASIC_DATA`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `historyBasicDataCurrentName`, `historyBasicDataAge`, `historyBasicDataTotalChanges`, `historyBasicDataSummary`, `historyBasicDataStats` e mais 5.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_HISTORY_BASIC_DATA",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_OWNERS_INFLUENCE`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `influenceScore`, `ownersInfluenceSummary`, `ownersInfluence`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_OWNERS_INFLUENCE",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_MARKETPLACE_DATA`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalMarketplacesUsed`, `totalStoresOperated`, `marketplaceWithMostProducts`, `marketplaceWithBestRating`, `totalProductsListed` e mais 2.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_MARKETPLACE_DATA",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_CIVIL_CONSTRUCTION`

**Quando 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).


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalCivilConstructionRecords`, `totalActiveCivilConstructionRecords`, `civilConstructionSummary`, `civilConstructionRecords`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_CIVIL_CONSTRUCTION",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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).

**Service:** `SERVICE_SIMPLES_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `simplesSummary`, `simplesOfficialName`, `simplesNationalStatus`, `simplesMeiStatus`, `simplesCertificateUrl`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_SIMPLES_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `numberOfOwners`, `numberOfPeopleAsOwners`, `numberOfCompaniesAsOwners`, `hasMajorityStakeHolder`, `averageParticipationPercentage` e mais 6.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PUBLIC_PROJECTS`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalPublicProjects`, `publicProjectsSummary`, `publicProjects`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PUBLIC_PROJECTS",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `stateDebtSummary`, `stateDebtBaseStatus`, `stateDebtClearance`, `stateDebtState`, `stateDebtRegistration` e mais 2.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `score`, `hasRestrictions`, `restrictionCount`, `creditBureauSummary`, `creditBureauDetails` e mais 2.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_ACTIVE_DEBT_PJ`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `totalDebts`, `totalValue`, `debts`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_ACTIVE_DEBT_PJ",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_PGFN_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `pgfnSummary`, `pgfnBaseStatus`, `pgfnClearance`, `pgfnEmissionDate`, `pgfnCertificateUrl`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_PGFN_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_CREDIT_RISK_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `creditRisk`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_CREDIT_RISK_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_BOAVISTA_ONE_SCORE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `score`, `riskLevel`, `riskClassification`, `reasonCodes`, `creditBureauSummary` e mais 3.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_QUOD_CREDIT_SCORE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `score`, `riskLevel`, `riskClassification`, `reasonCodes`, `creditBureauSummary` e mais 3.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_QUOD_CREDIT_SCORE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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.

**Service:** `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`

**Quando 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.


 Campos obrigatórios: `service`, `cnpj`.


 Principais campos em `result`: `cnpj`, `score`, `creditBureauSummary`, `creditBureauDetails`, `origin`, `queryDate`.


 Use `status.code` e `status.message` para entender se a consulta processou corretamente.


 Nenhum campo opcional mapeado neste exemplo.


**Endpoint:** `POST /api/service-api`

**Campos obrigatórios:** `service`, `cnpj`

**Campos opcionais:** Nenhum campo opcional mapeado neste exemplo.

### Passo a passo

1. Gere o token em `POST /api/token-generate` e envie no header `Authorization: Bearer {jwt_token}`.
2. Monte o body com o `service` exato e os campos obrigatórios listados abaixo.
3. Execute `POST /api/service-api` no ambiente escolhido.
4. Confira `status.code` e `status.message` para validar o processamento técnico.
5. Mapeie os campos de `result` conforme o resumo e o exemplo de response deste service.

### Copiar e testar

Use este body no Postman em `Body > raw > JSON`. Troque apenas os valores de teste.

```json
{
  "service": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY",
  "cnpj": "cnpj"
}
```

```bash
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"
}'
```

```bash
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


 Dados públicos do service. É o objeto principal para mapear no sistema do cliente.


 Status técnico da chamada, com `code` e `message`.


 Quando retornado, resume o desfecho operacional: `APPROVED`, `REFUSED` ou `ERROR`.


 Identificador para rastrear a consulta em suporte, logs ou auditoria.


### Response resumido

```json
{
  "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


 Confirme se o token pertence ao produto certo e se o service está ativo para API.


 Confirme o valor exato de `service` e os campos obrigatórios listados no accordion.


 Valide se a chamada foi feita em HML ou produção com o token do mesmo ambiente.


 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.

```json
{
  "status": {
    "code": 401,
    "message": "Unauthorized"
  }
}
```

```json
{
  "status": {
    "code": 400,
    "message": "Required field is missing or invalid"
  }
}
```

```json
{
  "status": {
    "code": 403,
    "message": "Service unavailable or not enabled for this client"
  }
}
```

---

# API Reference

URL: https://api-docs.idcerberus.com/api-reference/boas-vindas
Fonte: api-reference/openapi.json

## API Reference - services

A maioria das consultas usa `POST /api/service-api` e seleciona o produto pelo campo `service` no body.

- PF - Antecedentes criminais civis: `SERVICE_CRIMINAL_RECORD_CIVIL`

 ```yaml
 service: SERVICE_CRIMINAL_RECORD_CIVIL
 cpf: cpf
 rg: rg
 uf: uf
 ```

- PF - Antecedentes criminais federais: `SERVICE_CRIMINAL_RECORD_FEDERAL`

 ```yaml
 service: SERVICE_CRIMINAL_RECORD_FEDERAL
 cpf: cpf
 ```

- PF - Benefícios sociais estendidos: `SERVICE_SOCIAL_ASSISTANCE_EXTENDED`

 ```yaml
 service: SERVICE_SOCIAL_ASSISTANCE_EXTENDED
 cpf: cpf
 ```

- PF - Benefícios sociais familiares: `SERVICE_FAMILY_SOCIAL_BENEFITS`

 ```yaml
 service: SERVICE_FAMILY_SOCIAL_BENEFITS
 cpf: cpf
 ```

- PF - Busca de face na base: `SERVICE_FACE_INDEX`

 ```yaml
 service: SERVICE_FACE_INDEX
 image1: base64
 ```

- PF - Cartão SUS: `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`

 ```yaml
 service: SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF
 cpf: cpf
 ```

- PF - Certidão de Nada Consta: `SERVICE_NOTHING_RECORD_LAWSUITS`

 ```yaml
 service: SERVICE_NOTHING_RECORD_LAWSUITS
 cpf: cpf
 court: TRF1
 uf: uf
 sphere: CIVIL
 ```

- PF - Certidão negativa de protesto: `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`

 ```yaml
 service: SERVICE_PROTEST_CLEARANCE_CERTIFICATE
 cpf: cpf
 ```

- PF - Consulta de MEI: `SERVICE_MEI`

 ```yaml
 service: SERVICE_MEI
 cpf: cpf
 ```

- PF - CPF na Receita Federal on-demand: `SERVICE_RFB_PF_ON_DEMAND`

 ```yaml
 service: SERVICE_RFB_PF_ON_DEMAND
 cpf: cpf
 ```

- PF - Dados demográficos: `SERVICE_DEMOGRAPHIC_DATA_CPF`

 ```yaml
 service: SERVICE_DEMOGRAPHIC_DATA_CPF
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Dados eleitorais de candidato: `SERVICE_ELECTION_CANDIDATE_DATA_CPF`

 ```yaml
 service: SERVICE_ELECTION_CANDIDATE_DATA_CPF
 cpf: cpf
 ```

- PF - Dados financeiros e endereços: `SERVICE_PF_FINANCIAL_AND_ADDRESS`

 ```yaml
 service: SERVICE_PF_FINANCIAL_AND_ADDRESS
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Dados pelo telefone: `SERVICE_CONFIRM_PHONE`

 ```yaml
 service: SERVICE_CONFIRM_PHONE
 phone: "+5561123456789"
 ```

- PF - Dados PIS: `SERVICE_PIS_CONSULTATION`

 ```yaml
 service: SERVICE_PIS_CONSULTATION
 cpf: cpf
 ```

- PF - Dados Restritivos: `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`

 ```yaml
 service: SERVICE_BOAVISTA_CREDIT_SCORE_PERSON
 cpf: cpf
 ```

- PF - Dívida ativa: `SERVICE_ACTIVE_DEBT_PF`

 ```yaml
 service: SERVICE_ACTIVE_DEBT_PF
 cpf: cpf
 ```

- PF - Doações eleitorais: `SERVICE_ELECTORAL_DONORS_CPF`

 ```yaml
 service: SERVICE_ELECTORAL_DONORS_CPF
 cpf: cpf
 ```

- PF - Documentoscopia digital: `SERVICE_DIGITAL_DOCUMENTOSCOPY`

 ```yaml
 service: SERVICE_DIGITAL_DOCUMENTOSCOPY
 key: 84bfcd2e-2336-4e30-bcab-15348b7890b5
 image1: base64
 image2: base64
 selfie1: base64
 ```

- PF - Domínios: `SERVICE_DOMAINS_CPF`

 ```yaml
 service: SERVICE_DOMAINS_CPF
 cpf: cpf
 ```

- PF - E-mails de Pessoas Relacionadas: `SERVICE_RELATED_PEOPLE_EMAILS`

 ```yaml
 service: SERVICE_RELATED_PEOPLE_EMAILS
 cpf: cpf
 ```

- PF - Endereços: `SERVICE_ADDRESS`

 ```yaml
 service: SERVICE_ADDRESS
 cpf: cpf
 ```

- PF - Endereços de Pessoas Relacionadas: `SERVICE_RELATED_PEOPLE_ADDRESSES`

 ```yaml
 service: SERVICE_RELATED_PEOPLE_ADDRESSES
 cnpj: cnpj
 ```

- PF - Enriquecimento de dados: `SERVICE_PERSON_DATA_ENRICHMENT`

 ```yaml
 service: SERVICE_PERSON_DATA_ENRICHMENT
 cpf: cpf
 ```

- PF - Envolvimento político: `SERVICE_POLITICAL_INVOLVEMENT`

 ```yaml
 service: SERVICE_POLITICAL_INVOLVEMENT
 cpf: cpf
 ```

- PF - Exposição e perfil na mídia: `SERVICE_MEDIA_PROFILE_EXPOSURE_PF`

 ```yaml
 service: SERVICE_MEDIA_PROFILE_EXPOSURE_PF
 cpf: cpf
 ```

- PF - FaceMatch: `SERVICE_FACE_MATCH`

 ```yaml
 service: SERVICE_FACE_MATCH
 image1: base64
 image2: base64
 ```

- PF - Flags Negativos: `SERVICE_QUOD_CREDIT_RISK_PERSON`

 ```yaml
 service: SERVICE_QUOD_CREDIT_RISK_PERSON
 cpf: cpf
 ```

- PF - Histórico de e-mails: `SERVICE_EMAILS_EXTENDED`

 ```yaml
 service: SERVICE_EMAILS_EXTENDED
 cpf: cpf
 limit: 10
 ```

- PF - Histórico de telefones: `SERVICE_PHONE_HISTORY`

 ```yaml
 service: SERVICE_PHONE_HISTORY
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 limit: 10
 ```

- PF - Histórico familiar político: `SERVICE_FAMILY_POLITICAL_HISTORY_CPF`

 ```yaml
 service: SERVICE_FAMILY_POLITICAL_HISTORY_CPF
 cpf: cpf
 ```

- PF - Histórico profissional: `SERVICE_PROFESSIONAL_HISTORY`

 ```yaml
 service: SERVICE_PROFESSIONAL_HISTORY
 cpf: cpf
 ```

- PF - Histórico profissional do titular: `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`

 ```yaml
 service: SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Indicadores de atividades: `SERVICE_ACTIVITIES_INDICATORS`

 ```yaml
 service: SERVICE_ACTIVITIES_INDICATORS
 cpf: cpf
 ```

- PF - Informações financeiras: `SERVICE_FINANCIAL_INFORMATION`

 ```yaml
 service: SERVICE_FINANCIAL_INFORMATION
 cpf: cpf
 ```

- PF - KYC e compliance: `SERVICE_PERSON_KYC`

 ```yaml
 service: SERVICE_PERSON_KYC
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Mandado de prisão: `SERVICE_ARREST_WARRANT`

 ```yaml
 service: SERVICE_ARREST_WARRANT
 nome: nome
 motherName: nome da mãe
 fatherName: nome do pai
 birthDate: dd/MM/yyyy
 cpf: cpf
 ```

- PF - Modelagem de dados: `SERVICE_PERSON_DATA_MODELING`

 ```yaml
 service: SERVICE_PERSON_DATA_MODELING
 cpf: cpf
 ```

- PF - OCR de comprovante de endereço: `SERVICE_OCR_PROOF_OF_ADDRESS`

 ```yaml
 service: SERVICE_OCR_PROOF_OF_ADDRESS
 image1: base64
 ```

- PF - OCR de emancipação: `SERVICE_OCR_EMANCIPATION`

 ```yaml
 service: SERVICE_OCR_EMANCIPATION
 image1: base64
 ```

- PF - OCR React: `SERVICE_OCR`

 ```yaml
 service: SERVICE_OCR
 documentType: IDENTIFICATION_DOCUMENT
 image1: base64
 image2: base64 (opcional)
 ```

- PF - Pessoa politicamente exposta: `SERVICE_PEP`

 ```yaml
 service: SERVICE_PEP
 cpf: cpf
 ```

- PF - Pessoas relacionadas: `SERVICE_RELATED_PEOPLE`

 ```yaml
 service: SERVICE_RELATED_PEOPLE
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Prêmios e certificações: `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`

 ```yaml
 service: SERVICE_AWARDS_AND_CERTIFICATIONS_CPF
 cpf: cpf
 ```

- PF - Prestadores de serviço eleitorais: `SERVICE_ELECTORAL_PROVIDERS_CPF`

 ```yaml
 service: SERVICE_ELECTORAL_PROVIDERS_CPF
 cpf: cpf
 ```

- PF - Processos jurídicos e administrativos: `SERVICE_JURIDICAL_PROCESSES`

 ```yaml
 service: SERVICE_JURIDICAL_PROCESSES
 cpf: cpf
 ```

- PF - Prompt de IA para pessoa: `SERVICE_PERSON_AI_PROMPT`

 ```yaml
 service: SERVICE_PERSON_AI_PROMPT
 cpf: cpf
 ```

- PF - Propensão a apostas online: `SEVICE_ONLINE_BETTING_PROPENSITY`

 ```yaml
 service: SEVICE_ONLINE_BETTING_PROPENSITY
 cpf: cpf
 ```

- PF - Relacionamentos econômicos: `SERVICE_ECONOMIC_RELATIONSHIP`

 ```yaml
 service: SERVICE_ECONOMIC_RELATIONSHIP
 cpf: cpf
 ```

- PF - Resultado da documentoscopia digital: `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`

 ```yaml
 service: SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT
 key: de0cd562-5962-40bd-8f94-5a7184ecde0e
 ```

- PF - Risco financeiro: `SERVICE_FINANCIAL_RISK_SCORE`

 ```yaml
 service: SERVICE_FINANCIAL_RISK_SCORE
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 ```

- PF - Score biométrico: `SERVICE_DATAVALID_CNH`

 ```yaml
 service: SERVICE_DATAVALID_CNH
 cpf: cpf
 image1: "{base64Image}"
 ```

- PF - Score de crédito: `SERVICE_CREDIT_SCORE`

 ```yaml
 service: SERVICE_CREDIT_SCORE
 cpf: cpf
 ```

- PF - Score de Crédito: `SERVICE_QUOD_CREDIT_SCORE_PERSON`

 ```yaml
 service: SERVICE_QUOD_CREDIT_SCORE_PERSON
 cpf: cpf
 ```

- PF - Score de Crédito Multidados: `SERVICE_BOAVISTA_ONE_SCORE_PERSON`

 ```yaml
 service: SERVICE_BOAVISTA_ONE_SCORE_PERSON
 cpf: cpf
 ```

- PF - Score de inadimplência: `SERVICE_DEFAULT_RISK_SCORE`

 ```yaml
 service: SERVICE_DEFAULT_RISK_SCORE
 cpf: cpf
 ```

- PF - Score de risco de fraude: `SERVICE_FRAUD_RISK_SCORE`

 ```yaml
 service: SERVICE_FRAUD_RISK_SCORE
 cpf: cpf
 factor: minRisk or minattrition
 ```

- PF - Servidores públicos: `SERVICE_PUBLIC_SERVANTS`

 ```yaml
 service: SERVICE_PUBLIC_SERVANTS
 cpf: cpf
 ```

- PF - Status do CPF na Receita Federal: `SERVICE_RFB_PF`

 ```yaml
 service: SERVICE_RFB_PF
 cpf: cpf
 dataDeNascimento: yyyy-MM-dd (opcional)
 ```

- PF - Telefones de Pessoas Relacionadas: `SERVICE_RELATED_PEOPLE_PHONES`

 ```yaml
 service: SERVICE_RELATED_PEOPLE_PHONES
 cpf: cpf
 ```

- PF - TSE - Local de votação: `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`

 ```yaml
 service: SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF
 cpf: cpf
 birthDate: yyyy-MM-dd (opcional)
 motherName: nome da mãe (opcional)
 ```

- PF - Validação de CPF com endereço: `SERVICE_CPF_ADDRESS_VALIDATION`

 ```yaml
 service: SERVICE_CPF_ADDRESS_VALIDATION
 cpf: cpf
 zipcode: 00000-000
 numberAddress: 13
 ```

- PF - Validação de CPF com telefone: `SERVICE_CPF_PHONE_VALIDATION`

 ```yaml
 service: SERVICE_CPF_PHONE_VALIDATION
 cpf: cpf
 phone: "11900000000"
 ```

- PF - Validação de e-mail: `SERVICE_EMAIL_VALIDATION`

 ```yaml
 service: SERVICE_EMAIL_VALIDATION
 email: email@email.com
 ```

- PF - Validação do E-Social: `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`

 ```yaml
 service: SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION
 cpf: cpf
 nit: "(opcional)"
 ```

- PJ - Ações Trabalhistas: `SERVICE_LABOR_LAWSUITS`

 ```yaml
 service: SERVICE_LABOR_LAWSUITS
 cnpj: cnpj
 ```

- PJ - Acordos Sindicais: `SERVICE_SYNDICATE_AGREEMENTS`

 ```yaml
 service: SERVICE_SYNDICATE_AGREEMENTS
 cnpj: cnpj
 ```

- PJ - Anúncios Online: `SERVICE_ONLINE_ADS`

 ```yaml
 service: SERVICE_ONLINE_ADS
 cnpj: cnpj
 ```

- PJ - Arrecadação Simples Nacional - MEI: `SERVICE_PGMEI`

 ```yaml
 service: SERVICE_PGMEI
 cnpj: cnpj
 ```

- PJ - Avaliações e Reputação: `SERVICE_REPUTATIONS_AND_REVIEWS`

 ```yaml
 service: SERVICE_REPUTATIONS_AND_REVIEWS
 cnpj: cnpj
 ```

- PJ - Beneficiários Finais: `SERVICE_ULTIMATE_BENEFICIAL_OWNERS`

 ```yaml
 service: SERVICE_ULTIMATE_BENEFICIAL_OWNERS
 cnpj: cnpj
 ```

- PJ - Categoria Comercial: `SERVICE_MERCHANT_CATEGORY_DATA`

 ```yaml
 service: SERVICE_MERCHANT_CATEGORY_DATA
 cnpj: cnpj
 ```

- PJ - Certidão Negativa CNJ: `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`

 ```yaml
 service: SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY
 cnpj: cnpj
 ```

- PJ - Certidão Negativa Correcional CGU: `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`

 ```yaml
 service: SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY
 cnpj: cnpj
 ```

- PJ - Certidão Negativa de Débitos Estaduais: `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`

 ```yaml
 service: SERVICE_STATE_DEBT_CERTIFICATE_COMPANY
 cnpj: cnpj
 ```

- PJ - Certidão negativa de protesto: `SERVICE_PROTEST_PJ`

 ```yaml
 service: SERVICE_PROTEST_PJ
 cnpj: cnpj
 ```

- PJ - CNPJ na Receita Federal on-demand: `SERVICE_RFB_PJ_ON_DEMAND`

 ```yaml
 service: SERVICE_RFB_PJ_ON_DEMAND
 cnpj: cnpj
 ```

- PJ - Compliance de casas de apostas: `SERVICE_COMPLIANCE_BET_PJ`

 ```yaml
 service: SERVICE_COMPLIANCE_BET_PJ
 cnpj: cnpj
 ```

- PJ - Compliance de casas de apostas (alias curto): `SERVICE_COMPLIANCE_BET`

 ```yaml
 service: SERVICE_COMPLIANCE_BET
 cnpj: cnpj
 ```

- PJ - Cota de PCD: `SERVICE_PCD_COMPANY`

 ```yaml
 service: SERVICE_PCD_COMPANY
 cnpj: cnpj
 ```

- PJ - Dados cadastrais de CNPJ: `SERVICE_REGISTRATION_DATA_CNPJ`

 ```yaml
 service: SERVICE_REGISTRATION_DATA_CNPJ
 cnpj: cnpj
 ```

- PJ - Dados de Fundos de Investimento: `SERVICE_INVESTMENT_FUND_DATA`

 ```yaml
 service: SERVICE_INVESTMENT_FUND_DATA
 cnpj: cnpj
 ```

- PJ - Dados Restritivos PJ: `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`

 ```yaml
 service: SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY
 cnpj: cnpj
 ```

- PJ - DAS MEI na Receita: `SERVICE_DAS_MEI`

 ```yaml
 service: SERVICE_DAS_MEI
 cnpj: cnpj
 ```

- PJ - Débitos ativos: `SERVICE_ACTIVE_DEBT_PJ`

 ```yaml
 service: SERVICE_ACTIVE_DEBT_PJ
 cnpj: cnpj
 ```

- PJ - Débitos com a PGFN: `SERVICE_PGFN_COMPANY`

 ```yaml
 service: SERVICE_PGFN_COMPANY
 cnpj: cnpj
 ```

- PJ - Distribuição de Processos dos Sócios: `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`

 ```yaml
 service: SERVICE_OWNERS_LAWSUITS_DISTRIBUTION
 cnpj: cnpj
 ```

- PJ - Distribuição de Processos Judiciais: `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`

 ```yaml
 service: SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY
 cnpj: cnpj
 ```

- PJ - Doações eleitorais: `SERVICE_ELECTORAL_DONORS_CNPJ`

 ```yaml
 service: SERVICE_ELECTORAL_DONORS_CNPJ
 cnpj: cnpj
 ```

- PJ - Doações eleitorais dos sócios: `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`

 ```yaml
 service: SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ
 cnpj: cnpj
 ```

- PJ - Domínios CNPJ: `SERVICE_DOMAINS_CNPJ`

 ```yaml
 service: SERVICE_DOMAINS_CNPJ
 cnpj: cnpj
 ```

- PJ - Endereços estendidos: `SERVICE_ADDRESSES_EXTENDED_CNPJ`

 ```yaml
 service: SERVICE_ADDRESSES_EXTENDED_CNPJ
 cnpj: cnpj
 ```

- PJ - Enriquecimento de dados: `SERVICE_CORPORATE_DATA_ENRICHMENT`

 ```yaml
 service: SERVICE_CORPORATE_DATA_ENRICHMENT
 cnpj: cnpj
 ```

- PJ - Evolução da Empresa: `SERVICE_COMPANY_EVOLUTION`

 ```yaml
 service: SERVICE_COMPANY_EVOLUTION
 cnpj: cnpj
 ```

- PJ - Exposição e perfil na mídia dos sócios: `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`

 ```yaml
 service: SERVICE_MEDIA_PROFILE_EXPOSURE_PJ
 cnpj: cnpj
 ```

- PJ - FGTS: `SERVICE_FGTS`

 ```yaml
 service: SERVICE_FGTS
 cnpj: cnpj
 ```

- PJ - Flags Negativos PJ: `SERVICE_QUOD_CREDIT_RISK_COMPANY`

 ```yaml
 service: SERVICE_QUOD_CREDIT_RISK_COMPANY
 cnpj: cnpj
 ```

- PJ - Fornecedores eleitorais: `SERVICE_ELECTORAL_PROVIDERS_CNPJ`

 ```yaml
 service: SERVICE_ELECTORAL_PROVIDERS_CNPJ
 cnpj: cnpj
 ```

- PJ - Histórico de Dados Básicos: `SERVICE_HISTORY_BASIC_DATA`

 ```yaml
 service: SERVICE_HISTORY_BASIC_DATA
 cnpj: cnpj
 ```

- PJ - Influência do Quadro Societário: `SERVICE_OWNERS_INFLUENCE`

 ```yaml
 service: SERVICE_OWNERS_INFLUENCE
 cnpj: cnpj
 ```

- PJ - KYC e Compliance do Grupo Econômico: `SERVICE_ECONOMIC_GROUP_KYC_COMPANY`

 ```yaml
 service: SERVICE_ECONOMIC_GROUP_KYC_COMPANY
 cnpj: cnpj
 ```

- PJ - KYC e Compliance dos Funcionários: `SERVICE_EMPLOYEES_KYC`

 ```yaml
 service: SERVICE_EMPLOYEES_KYC
 cnpj: cnpj
 ```

- PJ - KYC e compliance dos sócios: `SERVICE_COMPANY_KYC_OWNERS`

 ```yaml
 service: SERVICE_COMPANY_KYC_OWNERS
 cnpj: cnpj
 ```

- PJ - Marketplaces: `SERVICE_MARKETPLACE_DATA`

 ```yaml
 service: SERVICE_MARKETPLACE_DATA
 cnpj: cnpj
 ```

- PJ - Obras Civis: `SERVICE_CIVIL_CONSTRUCTION`

 ```yaml
 service: SERVICE_CIVIL_CONSTRUCTION
 cnpj: cnpj
 ```

- PJ - OCR de cartão CNPJ: `SERVICE_OCR_CNPJ_CARD`

 ```yaml
 service: SERVICE_OCR_CNPJ_CARD
 image1: base64
 ```

- PJ - Optante pelo Simples Nacional: `SERVICE_SIMPLES_COMPANY`

 ```yaml
 service: SERVICE_SIMPLES_COMPANY
 cnpj: cnpj
 ```

- PJ - Percentual de Participação Societária: `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`

 ```yaml
 service: SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY
 cnpj: cnpj
 ```

- PJ - Processos jurídicos: `SERVICE_JURIDICAL_PROCESSES_PJ`

 ```yaml
 service: SERVICE_JURIDICAL_PROCESSES_PJ
 cnpj: cnpj
 ```

- PJ - Processos jurídicos dos sócios: `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`

 ```yaml
 service: SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS
 cnpj: cnpj
 ```

- PJ - Projetos Públicos: `SERVICE_PUBLIC_PROJECTS`

 ```yaml
 service: SERVICE_PUBLIC_PROJECTS
 cnpj: cnpj
 ```

- PJ - Receita Federal - QSA: `SERVICE_RF_QSA`

 ```yaml
 service: SERVICE_RF_QSA
 cnpj: cnpj
 ```

- PJ - Relacionamentos da empresa: `SERVICE_COMPANY_RELATIONSHIP`

 ```yaml
 service: SERVICE_COMPANY_RELATIONSHIP
 cnpj: cnpj
 ```

- PJ - Relacionamentos do Grupo Econômico: `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`

 ```yaml
 service: SERVICE_ECONOMIC_GROUP_RELATIONSHIPS
 cnpj: cnpj
 ```

- PJ - Risco de crédito: `SERVICE_CREDIT_RISK_COMPANY`

 ```yaml
 service: SERVICE_CREDIT_RISK_COMPANY
 cnpj: cnpj
 ```

- PJ - Score de Crédito Multidados PJ: `SERVICE_BOAVISTA_ONE_SCORE_COMPANY`

 ```yaml
 service: SERVICE_BOAVISTA_ONE_SCORE_COMPANY
 cnpj: cnpj
 ```

- PJ - Score de Crédito PJ: `SERVICE_QUOD_CREDIT_SCORE_COMPANY`

 ```yaml
 service: SERVICE_QUOD_CREDIT_SCORE_COMPANY
 cnpj: cnpj
 ```

- PJ - Score de Crédito Quantum PJ: `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`

 ```yaml
 service: SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY
 cnpj: cnpj
 ```

- PJ - SINTEGRA: `SERVICE_SINTEGRA_CONSULTATION`

 ```yaml
 service: SERVICE_SINTEGRA_CONSULTATION
 cnpj: cnpj
 uf: uf (opcional)
 ```

- PJ - Sócios de primeiro nível: `SERVICE_FIRST_LEVEL_PARTNER`

 ```yaml
 service: SERVICE_FIRST_LEVEL_PARTNER
 cnpj: cnpj
 ```

- PJ - Sócios na Receita Federal: `SERVICE_COMPANY_RFB_OWNERS`

 ```yaml
 service: SERVICE_COMPANY_RFB_OWNERS
 cnpj: cnpj
 ```

- PJ - Status do CNPJ na Receita Federal: `SERVICE_RFB_PJ`

 ```yaml
 service: SERVICE_RFB_PJ
 cnpj: cnpj
 ```

- PJ - Telefones: `SERVICE_PHONES_EXTENDED_COMPANY`

 ```yaml
 service: SERVICE_PHONES_EXTENDED_COMPANY
 cnpj: cnpj
 ```


## API Reference operacional para LLM

# idCerberus API Reference - resumo operacional para LLM

Use este arquivo para gerar exemplos de request, explicar chamadas da API e escolher o `service` correto sem depender do OpenAPI completo.

## Regras obrigatórias

- Não invente endpoints, parâmetros ou services.
- Use homologação para testes: `https://backoffice-hml.idcerberus.com`.
- Use produção somente quando o usuário pedir explicitamente: `https://backoffice.idcerberus.com`.
- Nunca exponha `client`, `secret`, JWT real, CPF real, CNPJ real ou imagens reais em exemplos.
- Quando faltar um service no catálogo, diga que ele precisa ser confirmado antes de documentar ou integrar.

## Autenticação

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/token-generate' \
--header 'Content-Type: application/json' \
--data '{
 "client": "{client}",
 "secret": "{secret}"
}'
```

## Pessoa Física

### Antecedentes criminais civis

- Service: `SERVICE_CRIMINAL_RECORD_CIVIL`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `rg`, `uf`
- Termos de busca: PF - Antecedentes criminais civis
- Retorno principal: Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "rg": "rg",
    "state": "SP",
    "hasRecords": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}'
```

### Antecedentes criminais federais

- Service: `SERVICE_CRIMINAL_RECORD_FEDERAL`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Antecedentes criminais federais
- Retorno principal: Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "hasFederalCriminalRecord": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}'
```

### Benefícios sociais estendidos

- Service: `SERVICE_SOCIAL_ASSISTANCE_EXTENDED`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Benefícios sociais estendidos
- Retorno principal: Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ],
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}'
```

### Benefícios sociais familiares

- Service: `SERVICE_FAMILY_SOCIAL_BENEFITS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Benefícios sociais familiares
- Retorno principal: Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}'
```

### Busca de face na base

- Service: `SERVICE_FACE_INDEX`
- Endpoint: `POST /api/service-api`
- Campos do request: `image1`
- Termos de busca: PF - Busca de face na base, comparação facial biometria selfie rosto, face index busca facial selfie CPF base de faces
- Retorno principal: Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "faceFound": true,
    "similarity": 98.42
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_INDEX",
  "image1": "base64"
}'
```

### Cartão SUS

- Service: `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Cartão SUS
- Retorno principal: Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "sus_card_success": "Sim",
    "sus_card_number": "126000000000009",
    "sus_card_source": "BA",
    "sus_card_capture_date": "08/25/2025 20:07:36",
    "sus_card_birth_date": "03/13/1980 00:00:00",
    "sus_card_birth_city": "CHORROCHO",
    "sus_card_birth_state": "BA",
    "sus_card_has_evidence": "Não",
    "sus_card_raw_result_file": "https://example.com/documents/sus-card.pdf",
    "sus_card_raw_result_file_type": "pdf",
    "sus_card_summary": "Cartão SUS localizado"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}'
```

### Certidão de Nada Consta

- Service: `SERVICE_NOTHING_RECORD_LAWSUITS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `court`, `uf`, `sphere`
- Termos de busca: PF - Certidão de Nada Consta, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "court": "TRF1",
    "sphere": "CIVIL",
    "nothingFound": true,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'
```

### Certidão negativa de protesto

- Service: `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Certidão negativa de protesto
- Retorno principal: Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}'
```

### Certidão negativa de protesto PF

- Service: `SERVICE_PROTEST_PF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Certidão negativa de protesto PF
- Retorno principal: Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "notaryOffices": [],
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}'
```

### Consulta de MEI

- Service: `SERVICE_MEI`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Consulta de MEI
- Retorno principal: Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "meiCompanies": [
      {
        "cnpj": "cnpj",
        "officialName": "MEI EXEMPLO",
        "status": "ATIVA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}'
```

### CPF na Receita Federal on-demand

- Service: `SERVICE_RFB_PF_ON_DEMAND`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - CPF na Receita Federal on-demand
- Retorno principal: Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}'
```

### Dados demográficos

- Service: `SERVICE_DEMOGRAPHIC_DATA_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: CPF Receita Federal, PF - Dados demográficos
- Retorno principal: Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "demographicData": [
      {
        "indicator": "Faixa de renda",
        "value": "Media"
      }
    ],
    "totalIndicators": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Dados eleitorais de candidato

- Service: `SERVICE_ELECTION_CANDIDATE_DATA_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Dados eleitorais de candidato
- Retorno principal: Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "candidacies": [
      {
        "year": 2024,
        "role": "VEREADOR",
        "party": "PARTIDO",
        "status": "DEFERIDO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}'
```

### Dados financeiros e endereços

- Service: `SERVICE_PF_FINANCIAL_AND_ADDRESS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: PF - Dados financeiros e endereços
- Retorno principal: Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "addresses": [
      {
        "city": "Sao Paulo",
        "state": "SP"
      }
    ],
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Dados pelo telefone

- Service: `SERVICE_CONFIRM_PHONE`
- Endpoint: `POST /api/service-api`
- Campos do request: `phone`
- Termos de busca: PF - Dados pelo telefone, telefone celular validação contato
- Retorno principal: Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.

Response resumido:

```json
{
  "result": {
    "phone": "+5561123456789",
    "matched": true,
    "person": {
      "name": "Nome encontrado",
      "document": "cpf"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'
```

### Dados PIS

- Service: `SERVICE_PIS_CONSULTATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Dados PIS
- Retorno principal: Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "pis": "00000000000",
    "status": "FOUND"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}'
```

### Dados Restritivos

- Service: `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Dados Restritivos, score risco crédito rating inadimplência
- Retorno principal: Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 705,
    "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}"
}
```

Curl de homologação:

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Dívida ativa

- Service: `SERVICE_ACTIVE_DEBT_PF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Dívida ativa, dívida ativa débito cobrança inadimplência
- Retorno principal: Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalDebts": 2,
    "totalValue": "1234.56",
    "debts": [
      {
        "source": "PGFN",
        "value": "1234.56",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_PF",
  "cpf": "cpf"
}'
```

### Doações eleitorais

- Service: `SERVICE_ELECTORAL_DONORS_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Doações eleitorais, dados eleitorais campanha doações candidato
- Retorno principal: Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "500.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_CPF",
  "cpf": "cpf"
}'
```

### Documentoscopia digital

- Service: `SERVICE_DIGITAL_DOCUMENTOSCOPY`
- Endpoint: `POST /api/service-api`
- Campos do request: `key`, `image1`, `image2`, `selfie1`
- Termos de busca: PF - Documentoscopia digital, documentoscopia documento selfie validação
- Retorno principal: Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.

Response resumido:

```json
{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "documentData": {
      "name": "Nome extraído",
      "cpf": "cpf"
    },
    "validations": [
      {
        "name": "faceMatch",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'
```

### Domínios

- Service: `SERVICE_DOMAINS_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Domínios, domínios sites presença digital
- Retorno principal: Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "exemplo.com.br",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}'
```

### E-mails de Pessoas Relacionadas

- Service: `SERVICE_RELATED_PEOPLE_EMAILS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - E-mails de Pessoas Relacionadas, email validação contato
- Retorno principal: Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeopleEmails": 2,
    "relatedPeopleEmailsList": "nome@email.com - NOME DA PESSOA - 00000000000 - CONJUGE",
    "relatedPeopleEmails": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "CONJUGE",
        "type": "PESSOAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "email": "nome@email.com",
        "domain": "email.com",
        "validationStatus": "VALID"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}'
```

### Endereços

- Service: `SERVICE_ADDRESS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Endereços
- Retorno principal: Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalAddresses": 2,
    "addresses": [
      {
        "address": "Rua Exemplo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "Sao Paulo",
        "state": "SP",
        "zipcode": "01001000"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}'
```

### Endereços de Pessoas Relacionadas

- Service: `SERVICE_RELATED_PEOPLE_ADDRESSES`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PF - Endereços de Pessoas Relacionadas
- Retorno principal: Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalRelatedPeopleAddresses": 1,
    "relatedPeopleAddressesList": "RUA EXEMPLO, 100 - NOME DA PESSOA - 00000000000 - SOCIO",
    "relatedPeopleAddresses": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "SOCIO",
        "type": "RESIDENCIAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "address": "RUA EXEMPLO",
        "zipcode": "00000000",
        "state": "SP",
        "city": "SAO PAULO",
        "neighborhood": "CENTRO",
        "number": "100",
        "complement": "",
        "isRatified": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}'
```

### Enriquecimento de dados

- Service: `SERVICE_PERSON_DATA_ENRICHMENT`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Enriquecimento de dados
- Retorno principal: Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "motherName": "Nome da mãe"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}'
```

### Envolvimento político

- Service: `SERVICE_POLITICAL_INVOLVEMENT`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Envolvimento político
- Retorno principal: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "CANDIDACY",
        "year": 2024,
        "details": "Candidatura encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}'
```

### Envolvimento político PF

- Service: `SERVICE_POLITICAL_INVOLVEMENT_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Envolvimento político PF
- Retorno principal: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "DONATION",
        "year": 2024,
        "details": "Doacao encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}'
```

### Exposição e perfil na mídia

- Service: `SERVICE_MEDIA_PROFILE_EXPOSURE_PF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Exposição e perfil na mídia
- Retorno principal: Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "mediaMentions": [
      {
        "title": "Noticia encontrada",
        "source": "Fonte",
        "sentiment": "NEUTRAL"
      }
    ],
    "exposureLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_PF",
  "cpf": "cpf"
}'
```

### FaceMatch

- Service: `SERVICE_FACE_MATCH`
- Endpoint: `POST /api/service-api`
- Campos do request: `image1`, `image2`
- Termos de busca: PF - FaceMatch, comparação facial biometria selfie rosto
- Retorno principal: Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.

Response resumido:

```json
{
  "result": {
    "match": true,
    "similarity": 98.2,
    "status": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}'
```

### Flags Negativos

- Service: `SERVICE_QUOD_CREDIT_RISK_PERSON`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Flags Negativos
- Retorno principal: Retorna flags negativos de crédito de pessoa física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "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}"
}
```

Curl de homologação:

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Histórico de e-mails

- Service: `SERVICE_EMAILS_EXTENDED`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `limit`
- Termos de busca: PF - Histórico de e-mails, email validação contato
- Retorno principal: Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "emails": [
      {
        "email": "email@exemplo.com",
        "priority": 1,
        "isValid": true,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}'
```

### Histórico de telefones

- Service: `SERVICE_PHONE_HISTORY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`, `limit`
- Termos de busca: PF - Histórico de telefones, telefone celular validação contato
- Retorno principal: Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "phones": [
      {
        "phone": "11900000000",
        "lineType": "MOBILE",
        "priority": 1,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'
```

### Histórico familiar político

- Service: `SERVICE_FAMILY_POLITICAL_HISTORY_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Histórico familiar político
- Retorno principal: Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "familyPoliticalHistory": [
      {
        "relativeName": "Nome relacionado",
        "relationship": "PARENTE",
        "role": "Candidato"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}'
```

### Histórico profissional

- Service: `SERVICE_PROFESSIONAL_HISTORY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Histórico profissional
- Retorno principal: Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "professionalHistory": [
      {
        "companyName": "Empresa Exemplo",
        "role": "Analista",
        "startDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}'
```

### Histórico profissional do titular

- Service: `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: PF - Histórico profissional do titular
- Retorno principal: Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "ownerHistory": [
      {
        "companyName": "Empresa Exemplo",
        "cnpj": "cnpj",
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Indicadores de atividades

- Service: `SERVICE_ACTIVITIES_INDICATORS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Indicadores de atividades
- Retorno principal: Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "activityIndicators": [
      {
        "type": "PROFESSIONAL",
        "description": "Indicador encontrado"
      }
    ],
    "hasActivityIndicators": true
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}'
```

### Informações financeiras

- Service: `SERVICE_FINANCIAL_INFORMATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Informações financeiras
- Retorno principal: Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "purchasingPower": "MEDIUM",
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}'
```

### KYC e compliance

- Service: `SERVICE_PERSON_KYC`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: PF - KYC e compliance, compliance KYC sanções PEP mídia
- Retorno principal: Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "sanctions": [],
    "mediaExposure": [],
    "riskAlerts": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Mandado de prisão

- Service: `SERVICE_ARREST_WARRANT`
- Endpoint: `POST /api/service-api`
- Campos do request: `nome`, `motherName`, `fatherName`, `birthDate`, `cpf`
- Termos de busca: PF - Mandado de prisão
- Retorno principal: Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "hasArrestWarrant": false,
    "warrants": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'
```

### Modelagem de dados

- Service: `SERVICE_PERSON_DATA_MODELING`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Modelagem de dados
- Retorno principal: Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "profileSummary": "Resumo consolidado",
    "contacts": [],
    "addresses": [],
    "relationships": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}'
```

### OCR de comprovante de endereço

- Service: `SERVICE_OCR_PROOF_OF_ADDRESS`
- Endpoint: `POST /api/service-api`
- Campos do request: `image1`
- Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR de comprovante de endereço, comprovante de endereço conta fatura endereço
- Retorno principal: Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.

Response resumido:

```json
{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "base64"
}'
```

### OCR de emancipação

- Service: `SERVICE_OCR_EMANCIPATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `image1`
- Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR de emancipação, documento emancipação cartório certidão declaração
- Retorno principal: Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.

Response resumido:

```json
{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}'
```

### OCR React

- Service: `SERVICE_OCR`
- Endpoint: `POST /api/service-api`
- Campos do request: `documentType`, `image1`, `image2`
- Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR React
- Retorno principal: Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}'
```

### Pessoa politicamente exposta

- Service: `SERVICE_PEP`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Pessoa politicamente exposta
- Retorno principal: Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "positions": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}'
```

### Pessoas relacionadas

- Service: `SERVICE_RELATED_PEOPLE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: PF - Pessoas relacionadas
- Retorno principal: Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "relatedPeople": [
      {
        "name": "Pessoa relacionada",
        "relationshipType": "FAMILIAR",
        "confidence": "HIGH"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Prêmios e certificações

- Service: `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Prêmios e certificações
- Retorno principal: Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalAwards": 0,
    "totalCertifications": 0,
    "awards": [],
    "certifications": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}'
```

### Prestadores de serviço eleitorais

- Service: `SERVICE_ELECTORAL_PROVIDERS_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: CPF Receita Federal, PF - Prestadores de serviço eleitorais, dados eleitorais campanha doações candidato
- Retorno principal: Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "800.00",
        "serviceType": "Servico"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_CPF",
  "cpf": "cpf"
}'
```

### Processos jurídicos e administrativos

- Service: `SERVICE_JURIDICAL_PROCESSES`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Processos jurídicos e administrativos, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalProcesses": 1,
    "processes": [
      {
        "court": "TJSP",
        "processNumber": "0000000-00.0000.0.00.0000",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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",
  "cpf": "cpf"
}'
```

### Prompt de IA para pessoa

- Service: `SERVICE_PERSON_AI_PROMPT`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Prompt de IA para pessoa
- Retorno principal: Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "answer": "Resumo analitico gerado pela IA",
    "highlights": [
      "ponto relevante"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}'
```

### Propensão a apostas online

- Service: `SEVICE_ONLINE_BETTING_PROPENSITY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Propensão a apostas online, apostas bets compliance bet
- Retorno principal: Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "propensityScore": 78,
    "propensityLevel": "HIGH",
    "indicators": [
      "sinal encontrado"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}'
```

### Relacionamentos econômicos

- Service: `SERVICE_ECONOMIC_RELATIONSHIP`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Relacionamentos econômicos
- Retorno principal: Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "relationships": [
      {
        "type": "OWNER",
        "relatedDocument": "cnpj",
        "relatedName": "Empresa relacionada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}'
```

### Resultado da documentoscopia digital

- Service: `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`
- Endpoint: `POST /api/service-api`
- Campos do request: `key`
- Termos de busca: PF - Resultado da documentoscopia digital, documentoscopia documento selfie validação
- Retorno principal: Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.

Response resumido:

```json
{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "fields": [
      {
        "name": "cpf",
        "value": "cpf"
      }
    ],
    "rules": [
      {
        "name": "document",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'
```

### Risco financeiro

- Service: `SERVICE_FINANCIAL_RISK_SCORE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`
- Termos de busca: PF - Risco financeiro, score risco crédito rating inadimplência
- Retorno principal: Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 681,
    "riskLevel": "MEDIUM",
    "recommendation": "REVIEW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'
```

### Score biométrico

- Service: `SERVICE_DATAVALID_CNH`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `image1`
- Termos de busca: PF - Score biométrico, score risco crédito rating inadimplência
- Retorno principal: Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "biometricScore": 0.98,
    "validated": true,
    "validationStatus": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}'
```

### Score de crédito

- Service: `SERVICE_CREDIT_SCORE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Score de crédito, score risco crédito rating inadimplência
- Retorno principal: Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 750,
    "riskLevel": "LOW",
    "message": "Score calculado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "cpf"
}'
```

### Score de Crédito

- Service: `SERVICE_QUOD_CREDIT_SCORE_PERSON`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Score de Crédito, score risco crédito rating inadimplência
- Retorno principal: Retorna score de crédito de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 680,
    "riskLevel": "MEDIO",
    "riskClassification": "B",
    "reasonCodes": [
      "Tempo de relacionamento com o mercado",
      "Renda declarada baixa"
    ],
    "creditBureauSummary": "Score de crédito dentro da média do perfil",
    "creditBureauDetails": {},
    "origin": "Quod",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Score de Crédito Multidados

- Service: `SERVICE_BOAVISTA_ONE_SCORE_PERSON`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Score de Crédito Multidados, score risco crédito rating inadimplência
- Retorno principal: Retorna score de crédito multidados de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 710,
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "reasonCodes": [
      "Bom histórico de pagamentos"
    ],
    "creditBureauSummary": "Score de crédito multidados acima da média do perfil",
    "creditBureauDetails": {},
    "origin": "Boa Vista",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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_PERSON",
  "cpf": "cpf"
}'
```

### Score de inadimplência

- Service: `SERVICE_DEFAULT_RISK_SCORE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Score de inadimplência, score risco crédito rating inadimplência
- Retorno principal: Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "score": 690,
    "riskLevel": "MEDIUM",
    "defaultProbability": "8%"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}'
```

### Score de risco de fraude

- Service: `SERVICE_FRAUD_RISK_SCORE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `factor`
- Termos de busca: PF - Score de risco de fraude, score risco crédito rating inadimplência
- Retorno principal: Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "factor": "minRisk",
    "score": 720,
    "riskLevel": "LOW",
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'
```

### Servidores públicos

- Service: `SERVICE_PUBLIC_SERVANTS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Servidores públicos
- Retorno principal: Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "publicServantRecords": [
      {
        "agency": "Orgao publico",
        "role": "Cargo",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}'
```

### Status do CPF na Receita Federal

- Service: `SERVICE_RFB_PF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `dataDeNascimento`
- Termos de busca: CPF Receita Federal, PF - Status do CPF na Receita Federal
- Retorno principal: Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'
```

### Telefones de Pessoas Relacionadas

- Service: `SERVICE_RELATED_PEOPLE_PHONES`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`
- Termos de busca: PF - Telefones de Pessoas Relacionadas, telefone celular validação contato
- Retorno principal: Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeoplePhones": 1,
    "relatedPeoplePhonesList": "11900000000 - NOME DA PESSOA - 00000000000 - FILHO",
    "relatedPeoplePhones": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "FILHO",
        "type": "CELULAR",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "areaCode": "11",
        "number": "900000000",
        "phone": "11900000000",
        "isInDoNotCallList": false
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}'
```

### TSE - Local de votação

- Service: `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `birthDate`, `motherName`
- Termos de busca: CPF Receita Federal, PF - TSE - Local de votação
- Retorno principal: Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "status": "REGULAR",
    "pollingPlace": "ESCOLA CLASSE 01",
    "pollingPlaceAddress": "QUADRA 01, BRASILIA - DF",
    "city": "BRASILIA",
    "uf": "DF",
    "zipcode": "70000000",
    "electoralZone": "001",
    "electoralSection": "0001",
    "hasBiometrics": true,
    "queryDate": "2026-08-01",
    "source": "TSE-LOCALVOTACAO",
    "onlineQuery": "Situação, local, endereço, zona e seção retornados com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'
```

### Validação de CPF com endereço

- Service: `SERVICE_CPF_ADDRESS_VALIDATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `zipcode`, `numberAddress`
- Termos de busca: CPF Receita Federal, PF - Validação de CPF com endereço
- Retorno principal: Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "zipcode": "01001000",
    "match": true,
    "confidence": "HIGH",
    "normalizedAddress": "Rua Exemplo, 100"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'
```

### Validação de CPF com telefone

- Service: `SERVICE_CPF_PHONE_VALIDATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `phone`
- Termos de busca: CPF Receita Federal, PF - Validação de CPF com telefone, telefone celular validação contato
- Retorno principal: Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "phone": "11900000000",
    "match": true,
    "statusMessage": "Telefone associado ao documento"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}'
```

### Validação de e-mail

- Service: `SERVICE_EMAIL_VALIDATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `email`
- Termos de busca: PF - Validação de e-mail, email validação contato
- Retorno principal: Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.

Response resumido:

```json
{
  "result": {
    "email": "email@email.com",
    "validFormat": true,
    "deliverable": true,
    "domain": "email.com",
    "riskLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "email@email.com"
}'
```

### Validação do E-Social

- Service: `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cpf`, `nit`
- Termos de busca: PF - Validação do E-Social
- Retorno principal: Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.

Response resumido:

```json
{
  "result": {
    "cpf": "cpf",
    "nit": "nit",
    "qualified": true,
    "inconsistencies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'
```

## Pessoa Jurídica

### Ações Trabalhistas

- Service: `SERVICE_LABOR_LAWSUITS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Ações Trabalhistas, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Acordos Sindicais

- Service: `SERVICE_SYNDICATE_AGREEMENTS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Acordos Sindicais
- Retorno principal: Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "syndicateAgreementsTotal": 1,
    "syndicateAgreementsTotalActive": 1,
    "syndicateAgreementsSummary": "Empresa com 1 acordo sindical ativo",
    "syndicateAgreementsStats": [],
    "syndicateAgreements": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Anúncios Online

- Service: `SERVICE_ONLINE_ADS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Anúncios Online
- Retorno principal: Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "onlineAdsTotalPhones": 0,
    "onlineAdsSummary": "Nenhum anúncio online encontrado",
    "onlineAds": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Arrecadação Simples Nacional - MEI

- Service: `SERVICE_PGMEI`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Arrecadação Simples Nacional - MEI
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Avaliações e Reputação

- Service: `SERVICE_REPUTATIONS_AND_REVIEWS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Avaliações e Reputação
- Retorno principal: 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.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalReputationSources": 2,
    "reputationSummary": "Empresa possui avaliações em 2 plataformas",
    "reputationAndReviews": [],
    "reputationSummaryDetails": {},
    "reputationSummaryByDataSources": {}
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Beneficiários Finais

- Service: `SERVICE_ULTIMATE_BENEFICIAL_OWNERS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Beneficiários Finais
- Retorno principal: 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%.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Categoria Comercial

- Service: `SERVICE_MERCHANT_CATEGORY_DATA`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Categoria Comercial
- Retorno principal: 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.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "merchantCategoryHasDirectAssociation": "false",
    "merchantCategoryHasMultipleCodes": "false",
    "merchantCategorySummary": "Categoria comercial inferida pelo CNAE",
    "merchantCategoryCategories": [],
    "merchantCategoryCnaeCategories": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Certidão Negativa CNJ

- Service: `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Certidão Negativa CNJ
- Retorno principal: Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Certidão Negativa Correcional CGU

- Service: `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Certidão Negativa Correcional CGU
- Retorno principal: Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Certidão Negativa de Débitos Estaduais

- Service: `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Certidão Negativa de Débitos Estaduais, dívida ativa débito cobrança inadimplência
- Retorno principal: Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Certidão negativa de protesto

- Service: `SERVICE_PROTEST_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Certidão negativa de protesto
- Retorno principal: Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "hasProtests": false,
    "notaryOffices": [],
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### CNPJ na Receita Federal on-demand

- Service: `SERVICE_RFB_PJ_ON_DEMAND`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, CPF Receita Federal, PJ - CNPJ na Receita Federal on-demand
- Retorno principal: Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Compliance de casas de apostas

- Service: `SERVICE_COMPLIANCE_BET_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Compliance de casas de apostas, apostas bets compliance bet
- Retorno principal: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "hasBettingExposure": true,
    "indicators": [
      "atividade relacionada"
    ],
    "riskLevel": "MEDIUM"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Compliance de casas de apostas (alias curto)

- Service: `SERVICE_COMPLIANCE_BET`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Compliance de casas de apostas (alias curto), apostas bets compliance bet
- Retorno principal: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "hasBettingExposure": true,
    "indicators": [
      "atividade relacionada"
    ],
    "riskLevel": "MEDIUM"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Cota de PCD

- Service: `SERVICE_PCD_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Cota de PCD
- Retorno principal: Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Dados cadastrais de CNPJ

- Service: `SERVICE_REGISTRATION_DATA_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Dados cadastrais de CNPJ
- Retorno principal: Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "tradeName": "EMPRESA EXEMPLO",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Dados de Fundos de Investimento

- Service: `SERVICE_INVESTMENT_FUND_DATA`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Dados de Fundos de Investimento
- Retorno principal: Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalMovimentations": 0,
    "investmentFundDataSummary": "Nenhuma movimentação de fundo de investimento encontrada",
    "investmentFundData": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Dados Restritivos PJ

- Service: `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Dados Restritivos PJ, score risco crédito rating inadimplência
- Retorno principal: Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### DAS MEI na Receita

- Service: `SERVICE_DAS_MEI`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CPF Receita Federal, PJ - DAS MEI na Receita
- Retorno principal: Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "meiStatus": "ACTIVE",
    "periods": [
      {
        "period": "2026-01",
        "paid": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Débitos ativos

- Service: `SERVICE_ACTIVE_DEBT_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Débitos ativos, dívida ativa débito cobrança inadimplência
- Retorno principal: Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalDebts": 1,
    "totalValue": "9800.00",
    "debts": [
      {
        "source": "PGFN",
        "value": "9800.00",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Débitos com a PGFN

- Service: `SERVICE_PGFN_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Débitos com a PGFN, dívida ativa débito cobrança inadimplência
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Distribuição de Processos dos Sócios

- Service: `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Distribuição de Processos dos Sócios, processos judiciais jurídicos tribunal certidão
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Distribuição de Processos Judiciais

- Service: `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Distribuição de Processos Judiciais, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Doações eleitorais

- Service: `SERVICE_ELECTORAL_DONORS_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Doações eleitorais, dados eleitorais campanha doações candidato
- Retorno principal: Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "1000.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Doações eleitorais dos sócios

- Service: `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Doações eleitorais dos sócios, dados eleitorais campanha doações candidato
- Retorno principal: Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "ownersDonations": [
      {
        "ownerName": "Nome do sócio",
        "year": 2024,
        "recipient": "Candidato",
        "amount": "300.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Domínios CNPJ

- Service: `SERVICE_DOMAINS_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Domínios CNPJ, domínios sites presença digital
- Retorno principal: Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "empresa.com.br",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Endereços estendidos

- Service: `SERVICE_ADDRESSES_EXTENDED_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Endereços estendidos
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Enriquecimento de dados

- Service: `SERVICE_CORPORATE_DATA_ENRICHMENT`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Enriquecimento de dados
- Retorno principal: Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "tradeName": "EMPRESA EXEMPLO",
    "status": "ATIVA",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Evolução da Empresa

- Service: `SERVICE_COMPANY_EVOLUTION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Evolução da Empresa
- Retorno principal: Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "companyEvolutionSummary": "Empresa com tendência de crescimento estável",
    "companyEvolutionStats": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Exposição e perfil na mídia dos sócios

- Service: `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Exposição e perfil na mídia dos sócios
- Retorno principal: Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "mediaMentions": [
      {
        "title": "Noticia encontrada",
        "source": "Fonte",
        "sentiment": "NEUTRAL"
      }
    ],
    "exposureLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### FGTS

- Service: `SERVICE_FGTS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - FGTS
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Flags Negativos PJ

- Service: `SERVICE_QUOD_CREDIT_RISK_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Flags Negativos PJ
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Fornecedores eleitorais

- Service: `SERVICE_ELECTORAL_PROVIDERS_CNPJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, PJ - Fornecedores eleitorais, dados eleitorais campanha doações candidato
- Retorno principal: Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "2500.00",
        "serviceType": "Servico"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Histórico de Dados Básicos

- Service: `SERVICE_HISTORY_BASIC_DATA`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Histórico de Dados Básicos
- Retorno principal: Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Influência do Quadro Societário

- Service: `SERVICE_OWNERS_INFLUENCE`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Influência do Quadro Societário
- Retorno principal: 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.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "influenceScore": 0,
    "ownersInfluenceSummary": "Baixa influência do quadro societário",
    "ownersInfluence": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### KYC e Compliance do Grupo Econômico

- Service: `SERVICE_ECONOMIC_GROUP_KYC_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - KYC e Compliance do Grupo Econômico, compliance KYC sanções PEP mídia
- Retorno principal: 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.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "economicGroupKycSummary": "Consulta realizada",
    "economicGroupTotalCurrentPep": "0",
    "economicGroupTotalHistoricalPep": "1",
    "economicGroupTotalCurrentSanctioned": "0",
    "economicGroupTotalHistoricalSanctioned": "0",
    "economicGroupAverageSanctions": "0"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### KYC e Compliance dos Funcionários

- Service: `SERVICE_EMPLOYEES_KYC`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - KYC e Compliance dos Funcionários, compliance KYC sanções PEP mídia
- Retorno principal: Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### KYC e compliance dos sócios

- Service: `SERVICE_COMPANY_KYC_OWNERS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - KYC e compliance dos sócios, compliance KYC sanções PEP sancionado interpol ofac
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Marketplaces

- Service: `SERVICE_MARKETPLACE_DATA`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Marketplaces
- Retorno principal: Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Obras Civis

- Service: `SERVICE_CIVIL_CONSTRUCTION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Obras Civis
- Retorno principal: Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO).

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### OCR de cartão CNPJ

- Service: `SERVICE_OCR_CNPJ_CARD`
- Endpoint: `POST /api/service-api`
- Campos do request: `image1`
- Termos de busca: CNPJ Receita Federal, OCR cartão CNPJ comprovante inscrição empresa, OCR documento imagem base64 leitura extração, PJ - OCR de cartão CNPJ
- Retorno principal: Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "docType": "CNPJ_CARD",
    "genericOcr": "texto extraído do cartão CNPJ"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Optante pelo Simples Nacional

- Service: `SERVICE_SIMPLES_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Optante pelo Simples Nacional
- Retorno principal: Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Percentual de Participação Societária

- Service: `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Percentual de Participação Societária
- Retorno principal: Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Processos jurídicos

- Service: `SERVICE_JURIDICAL_PROCESSES_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Processos jurídicos, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "totalProcesses": 1,
    "processes": [
      {
        "court": "TJSP",
        "processNumber": "0000000-00.0000.0.00.0000",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Processos jurídicos dos sócios

- Service: `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Processos jurídicos dos sócios, processos judiciais jurídicos tribunal certidão
- Retorno principal: Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "ownersProcesses": [
      {
        "ownerName": "Nome do sócio",
        "totalProcesses": 1,
        "processes": []
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Projetos Públicos

- Service: `SERVICE_PUBLIC_PROJECTS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Projetos Públicos
- Retorno principal: Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Receita Federal - QSA

- Service: `SERVICE_RF_QSA`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CPF Receita Federal, PJ - Receita Federal - QSA
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Relacionamentos da empresa

- Service: `SERVICE_COMPANY_RELATIONSHIP`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Relacionamentos da empresa
- Retorno principal: Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "owners": [
      {
        "name": "Nome do sócio",
        "document": "cpf",
        "share": "50%"
      }
    ],
    "relatedCompanies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Relacionamentos do Grupo Econômico

- Service: `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Relacionamentos do Grupo Econômico
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Risco de crédito

- Service: `SERVICE_CREDIT_RISK_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Risco de crédito, score risco crédito rating inadimplência
- Retorno principal: Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "creditRisk": {
      "status": "APPROVED",
      "score": "720",
      "rating": "B",
      "expectedDefault": "MEDIUM",
      "legalProcess": false
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Score de Crédito Multidados PJ

- Service: `SERVICE_BOAVISTA_ONE_SCORE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Score de Crédito Multidados PJ, score risco crédito rating inadimplência
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Score de Crédito PJ

- Service: `SERVICE_QUOD_CREDIT_SCORE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Score de Crédito PJ, score risco crédito rating inadimplência
- Retorno principal: 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.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Score de Crédito Quantum PJ

- Service: `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Score de Crédito Quantum PJ, score risco crédito rating inadimplência
- Retorno principal: Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito.

Response resumido:

```json
{
  "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}"
}
```

Curl de homologação:

```bash
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"
}'
```

### SINTEGRA

- Service: `SERVICE_SINTEGRA_CONSULTATION`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`, `uf`
- Termos de busca: PJ - SINTEGRA
- Retorno principal: Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "stateRegistration": "000000000",
    "state": "SP",
    "status": "HABILITADO",
    "regime": "NORMAL"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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)"
}'
```

### Sócios de primeiro nível

- Service: `SERVICE_FIRST_LEVEL_PARTNER`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Sócios de primeiro nível
- Retorno principal: Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "partners": [
      {
        "name": "Nome do sócio",
        "document": "cpf",
        "level": 1,
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Sócios na Receita Federal

- Service: `SERVICE_COMPANY_RFB_OWNERS`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CPF Receita Federal, PJ - Sócios na Receita Federal
- Retorno principal: 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.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "owners": [
      {
        "name": "Nome do sócio",
        "qualification": "SOCIO-ADMINISTRADOR",
        "entryDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Status do CNPJ na Receita Federal

- Service: `SERVICE_RFB_PJ`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: CNPJ Receita Federal, CPF Receita Federal, PJ - Status do CNPJ na Receita Federal
- Retorno principal: Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "officialName": "EMPRESA EXEMPLO LTDA",
    "status": "ATIVA",
    "openingDate": "yyyy-MM-dd",
    "mainActivity": "CNAE principal"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

### Telefones

- Service: `SERVICE_PHONES_EXTENDED_COMPANY`
- Endpoint: `POST /api/service-api`
- Campos do request: `cnpj`
- Termos de busca: PJ - Telefones, telefone celular validação contato
- Retorno principal: Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem.

Response resumido:

```json
{
  "result": {
    "cnpj": "cnpj",
    "phonesExtendedCompanyTotal": 2,
    "phonesExtendedCompanyTotalActive": 1,
    "phonesExtendedCompanySummary": "Empresa com 2 telefones encontrados, 1 ativo",
    "phonesExtendedCompanyStats": [],
    "phonesExtendedCompany": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}
```

Curl de homologação:

```bash
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"
}'
```

## OpenAPI bruto

```yaml
openapi: 3.0.0

info:
  title: API idCerberus
  version: 1.0.0
  description: |
    Referência técnica da API idCerberus para integração com produtos de
    onboarding digital, KYC, biometria, prevenção à fraude, análise de risco,
    compliance, enriquecimento cadastral e consultas de pessoa física e pessoa
    jurídica.

    Use esta referência quando já souber qual endpoint ou serviço deseja
    implementar. Para entender fluxos, ambientes, boas práticas e critérios de
    escolha entre serviços, consulte primeiro os guias.

    A maioria das consultas de dados é executada por `POST /api/service-api`.
    Nesse endpoint, a rota permanece a mesma e o produto executado é definido
    pelo campo `service` enviado no body.

    Na prática, o endpoint central funciona como um executor de produtos:
    o método, a URL e os headers são iguais; o que muda é o valor de `service`
    e os campos obrigatórios do produto escolhido.

    O valor enviado em `service` precisa existir no produto liberado para o
    cliente. Em alguns produtos, o alias de chamada configurado no produto é
    mais curto que outro alias exibido no catálogo. Nesses casos, envie
    o alias de chamada no body.

    - Serviços de pessoa física normalmente usam `cpf`.
    - Serviços de pessoa jurídica normalmente usam `cnpj`.
    - Serviços de biometria e documentos usam imagens em base64 ou URLs.
    - Alguns serviços exigem campos complementares, como `birthDate`, `uf`,
      `rg`, `phone`, `email`, `image1` ou `image2`.

    Se estiver em dúvida sobre qual `service` usar, consulte os guias
    "Escolha o serviço certo", "Matriz de serviços" e "Índice de services".

    Termos úteis para busca: CPF Receita, RFB PF, CNPJ Receita, RFB PJ, KYC PF,
    KYC PJ, OCR, FaceMatch, Liveness, score de fraude, risco financeiro,
    dados eleitorais, débitos ativos e protestos.

servers:
  - url: https://backoffice-hml.idcerberus.com
    description: Ambiente de homologação
  - url: https://backoffice.idcerberus.com
    description: Ambiente de produção

tags:
  - name: Autorização
    description: |
      Gere o token JWT usado nas chamadas protegidas. Antes de consumir
      onboarding, serviços externos ou customers, gere um token com `client` e
      `secret` e envie-o no header `Authorization`.
  - name: Integração via SDK
    description: |
      Endpoints usados no fluxo de onboarding via SDK. Use esta seção para
      gerar o `tokenOnboarding`, consultar o resultado processado e baixar o
      relatório final em PDF.
  - name: Serviços - Pessoas
    description: |
      Serviços de pessoa física executados por `POST /api/service-api`.
      Inclui enriquecimento de CPF, Receita Federal, OCR, biometria,
      FaceMatch, Liveness, risco, compliance, certidões, contatos, dados
      eleitorais e outros produtos definidos pelo campo `service`.
  - name: Serviços - Empresas
    description: |
      Serviços de pessoa jurídica executados por `POST /api/service-api`.
      Inclui enriquecimento de CNPJ, Receita Federal, SINTEGRA, sócios,
      relacionamentos, débitos, protestos, KYC dos sócios e compliance.
  - name: Customers
    description: |
      Operações para consultar clientes cadastrados e alterar o status ativo ou
      inativo de um ou mais registros.

paths:
  /api/token-generate:
    post:
      tags:
        - Autorização
      summary: Gerar token de API
      description: |
        Gera o token JWT usado nas chamadas protegidas da API idCerberus.

        Envie o `client` e o `secret` fornecidos pela idCerberus. O retorno
        contém `access_token` e `expires_in`. Use o token retornado no header:

        `Authorization: Bearer {jwt_token}`

        Quando o token expirar, gere um novo token usando as mesmas credenciais.

        Ambientes disponíveis:

        | Ambiente | URL |
        | --- | --- |
        | Homologação | `https://backoffice-hml.idcerberus.com/api/token-generate` |
        | Produção | `https://backoffice.idcerberus.com/api/token-generate` |
      requestBody:
        description: |
          Envie as credenciais da aplicação para gerar um token JWT.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenRequest'
            example:
              client: "{client}"
              secret: "{secret}"
      responses:
        '201':
          description: Token gerado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
              example:
                access_token: "{jwt_token}"
                expires_in: "300"
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'

  /api/token-history-onboarding:
    post:
      tags:
        - Integração via SDK
      summary: Gerar TokenOnboarding para SDK
      description: |
        Cria um novo `tokenOnboarding` para iniciar um fluxo de cadastro via SDK.

        O token gerado deve ser entregue ao SDK e será usado posteriormente para
        consultar o resultado processado pelo backoffice e baixar o relatório em
        PDF.

        Use `documentFiles` quando quiser enviar documentos ou URLs de arquivos
        já no início do processo.
      security:
        - bearerAuth: []
      requestBody:
        description: |
          Informe os dados iniciais do usuário e, quando aplicável, arquivos ou
          URLs de documentos que devem ser vinculados ao onboarding.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenOnboardingRequest'
            example:
              document: cpf
              cpf: cpf
              cnpj: cnpj
              name: name
              documentFiles:
                - documentFileType: OTHER
                  document: data:image/jpeg;base64
                  documentUrl: url
      responses:
        '200':
          description: TokenOnboarding gerado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenOnboardingResponse'
              example:
                tokenOnboarding: 56950dae-2d19-4092-a918-a612b3ca8f68
                dateHourProcess: 2023-02-17T16:49:41.577364Z
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

  /api/onboarding/report/{tokenOnboarding}:
    get:
      tags:
        - Integração via SDK
      summary: Consultar resultado de onboarding
      description: |
        Retorna o status, resultado, campos capturados e serviços executados em
        um onboarding.

        Informe o `tokenOnboarding` gerado anteriormente e entregue ao SDK. O
        retorno pode incluir dados capturados durante o cadastro, URLs de
        documentos, mensagens de processamento, regras avaliadas e status dos
        serviços executados.

        Use este endpoint quando precisar consultar o resultado estruturado do
        onboarding em JSON.
      security:
        - bearerAuth: []
      parameters:
        - name: tokenOnboarding
          in: path
          required: true
          description: UUID do onboarding retornado ao SDK.
          schema:
            type: string
      responses:
        '200':
          description: Resultado do onboarding.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingReportResponse'
              example:
                tokenOnboarding: bb6adc72-0132-4b27-a723-98fe9f20cb81
                createdDate: 2022-06-15T19:02:04.877688Z
                numberSteps: 4
                status: APPROVED
                result: AUT_APPROVED
                fields:
                  - field: selfie_liveness_3d
                    name: Selfie Liveness 3D
                    step: "1"
                    value: https://bucket-onboarding.s3.amazonaws.com/arquivo
                  - field: button_cnh
                    name: CNH - Carteira Nacional de Habilitação
                    step: "2"
                services:
                  - serviceName: service_liveness_ft
                    createdDate: 2022-06-15T19:02:06.233020Z
                    status: APPROVED
                    statusMessage: USER PASSED THE LIVENESS CHALLENGE
                    fields: []
                    rules: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

  /api/history-onboarding-report/{tokenOnboarding}:
    get:
      tags:
        - Integração via SDK
      summary: Baixar relatório PDF do onboarding
      description: |
        Realiza o download do relatório final do onboarding em PDF.

        Este endpoint não retorna um body JSON. Use-o quando precisar armazenar,
        auditar ou apresentar o relatório final do processo de cadastro.
      security:
        - bearerAuth: []
      parameters:
        - name: tokenOnboarding
          in: path
          required: true
          description: UUID do onboarding retornado ao SDK.
          schema:
            type: string
      responses:
        '200':
          description: Arquivo PDF do relatório.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

  /api/service-api:
    post:
      tags:
        - Serviços - Pessoas
        - Serviços - Empresas
      summary: Executar serviço de dados, risco ou compliance
      description: |
        Endpoint central para executar produtos de dados, risco, biometria,
        documentos e compliance de pessoa física e pessoa jurídica.

        A rota é sempre `POST /api/service-api`. O produto executado é definido
        pelo campo `service` enviado no body. Os demais campos variam conforme o
        serviço escolhido.

        O valor de `service` é validado contra os services liberados no produto
        do cliente. Se o produto estiver configurado com alias curto, use esse
        alias no body, mesmo que o catálogo mostre outro alias documentado.

        Exemplos comuns de alias de chamada:

        | Service |
        | --- |
        | `SERVICE_DIGITAL_DOCUMENTOSCOPY` | `SERVICE_DOCUMENTOSCOPY` |
        | `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` | `SERVICE_DIGITAL_DOCUMENTOSCOPY` |
        | `SERVICE_ECONOMIC_RELATIONSHIP` | `economic_relationships` |
        | `SERVICE_EMAIL_VALIDATION` | `SERVICE_EMAIL_VALIDATION1` |
        | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE`, `SERVICE_PROTEST_PF` | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` |
        | `SERVICE_PROTEST_PJ` | `SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ` |

        Este endpoint atende serviços de pessoa física e pessoa jurídica. Nos
        exemplos, use os itens com prefixo `PF -` para consultas por CPF e os
        itens com prefixo `PJ -` para consultas por CNPJ.

        Campos mais comuns:

        | Campo | Uso |
        | --- | --- |
        | `service` | Código do produto que será executado |
        | `cpf` | Documento principal em serviços de pessoa física |
        | `cnpj` | Documento principal em serviços de pessoa jurídica |
        | `image1`, `image2` | Imagens em base64 para OCR, biometria ou documentos |
        | `image1Url`, `image2Url` | URLs de imagens, quando o serviço aceitar URL |
        | `selfie1` | Selfie usada em documentoscopia e FaceMatch |
        | `key` | Chave de consulta em fluxos assíncronos |

        Exemplos:

        - consulta de CPF normalmente usa `cpf`;
        - consulta de CNPJ normalmente usa `cnpj`;
        - OCR, FaceMatch e documentoscopia usam imagens em base64 ou URL;
        - serviços assíncronos usam `key` para consultar o resultado depois.
        - payloads curtos ajudam a validar acesso ao produto, mas services de
          documento, OCR e biometria precisam de massa real para retornar dados
          completos.

        A maioria das respostas retorna:

        - `result`: dados de negócio da consulta;
        - `status.code`: código técnico do processamento;
        - `status.message`: mensagem técnica do processamento;
        - `externalId`: identificador externo, quando disponível.

        Use a lista de exemplos desta operação para selecionar rapidamente o
        payload do produto desejado.
      security:
        - bearerAuth: []
      requestBody:
        description: |
          Informe o código do serviço no campo `service` e os parâmetros
          exigidos por essa consulta. O campo `service` é obrigatório em todos
          os casos. Os demais campos dependem do produto selecionado.

          Use os exemplos para copiar o payload inicial do serviço desejado.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceApiRequest'
            examples:
              enriquecimentoPessoaFisica:
                summary: PF - Enriquecimento de dados
                value:
                  service: SERVICE_PERSON_DATA_ENRICHMENT
                  cpf: cpf
              statusCpfReceitaFederal:
                summary: PF - Status do CPF na Receita Federal
                value:
                  service: SERVICE_RFB_PF
                  cpf: cpf
                  dataDeNascimento: yyyy-MM-dd (opcional)
              statusCpfReceitaFederalOnDemand:
                summary: PF - CPF na Receita Federal on-demand
                value:
                  service: SERVICE_RFB_PF_ON_DEMAND
                  cpf: cpf
              cartaoSus:
                summary: PF - Cartão SUS
                value:
                  service: SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF
                  cpf: cpf
              modelagemDadosPessoa:
                summary: PF - Modelagem de dados
                value:
                  service: SERVICE_PERSON_DATA_MODELING
                  cpf: cpf
              promptIaPessoa:
                summary: PF - Prompt de IA para pessoa
                value:
                  service: SERVICE_PERSON_AI_PROMPT
                  cpf: cpf
              ocrDocumentos:
                summary: PF - OCR React
                value:
                  service: SERVICE_OCR
                  documentType: IDENTIFICATION_DOCUMENT
                  image1: base64
                  image2: base64 (opcional)
              faceMatch:
                summary: PF - FaceMatch
                value:
                  service: SERVICE_FACE_MATCH
                  image1: base64
                  image2: base64
              emailsPessoasRelacionadas:
                summary: PF - E-mails de Pessoas Relacionadas
                value:
                  service: SERVICE_RELATED_PEOPLE_EMAILS
                  cpf: cpf
              telefonesPessoasRelacionadas:
                summary: PF - Telefones de Pessoas Relacionadas
                value:
                  service: SERVICE_RELATED_PEOPLE_PHONES
                  cpf: cpf
              enderecosPessoasRelacionadas:
                summary: PF - Endereços de Pessoas Relacionadas
                value:
                  service: SERVICE_RELATED_PEOPLE_ADDRESSES
                  cnpj: cnpj
              scoreCreditoPf:
                summary: PF - Score de Crédito
                value:
                  service: SERVICE_QUOD_CREDIT_SCORE_PERSON
                  cpf: cpf
              scoreCreditoMultidadosPf:
                summary: PF - Score de Crédito Multidados
                value:
                  service: SERVICE_BOAVISTA_ONE_SCORE_PERSON
                  cpf: cpf
              dadosRestritivosPf:
                summary: PF - Dados Restritivos
                value:
                  service: SERVICE_BOAVISTA_CREDIT_SCORE_PERSON
                  cpf: cpf
              flagsNegativosPf:
                summary: PF - Flags Negativos
                value:
                  service: SERVICE_QUOD_CREDIT_RISK_PERSON
                  cpf: cpf
              tseLocalVotacao:
                summary: PF - TSE - Local de votação
                value:
                  service: SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
                  motherName: nome da mãe (opcional)
              pessoaPoliticamenteExposta:
                summary: PF - Pessoa politicamente exposta
                value:
                  service: SERVICE_PEP
                  cpf: cpf
              dividaAtivaPessoaFisica:
                summary: PF - Dívida ativa
                value:
                  service: SERVICE_ACTIVE_DEBT_PF
                  cpf: cpf
              scoreRiscoFraude:
                summary: PF - Score de risco de fraude
                value:
                  service: SERVICE_FRAUD_RISK_SCORE
                  cpf: cpf
                  factor: minRisk or minattrition
              riscoFinanceiro:
                summary: PF - Risco financeiro
                value:
                  service: SERVICE_FINANCIAL_RISK_SCORE
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              scoreInadimplencia:
                summary: PF - Score de inadimplência
                value:
                  service: SERVICE_DEFAULT_RISK_SCORE
                  cpf: cpf
              scoreBiometrico:
                summary: PF - Score biométrico
                value:
                  service: SERVICE_DATAVALID_CNH
                  cpf: cpf
                  image1: "{base64Image}"
              validacaoCnhDatavalid:
                summary: PF - Validação de CNH no DataValid
                value:
                  service: SERVICE_DATAVALID_CNH
                  cpf: cpf
                  image1: base64
              nadaConstaAcoesJudiciais:
                summary: PF - Certidão de Nada Consta
                value:
                  service: SERVICE_NOTHING_RECORD_LAWSUITS
                  cpf: cpf
                  court: TRF1
                  uf: uf
                  sphere: CIVIL
              antecedentesCriminaisFederal:
                summary: PF - Antecedentes criminais federais
                value:
                  service: SERVICE_CRIMINAL_RECORD_FEDERAL
                  cpf: cpf
              antecedentesCriminaisCivil:
                summary: PF - Antecedentes criminais civis
                value:
                  service: SERVICE_CRIMINAL_RECORD_CIVIL
                  cpf: cpf
                  rg: rg
                  uf: uf
              certidaoNegativaProtesto:
                summary: PF - Certidão negativa de protesto
                value:
                  service: SERVICE_PROTEST_CLEARANCE_CERTIFICATE
                  cpf: cpf
              validacaoEmail:
                summary: PF - Validação de e-mail
                value:
                  service: SERVICE_EMAIL_VALIDATION
                  email: email@email.com
              validacaoCpfTelefone:
                summary: PF - Validação de CPF com telefone
                value:
                  service: SERVICE_CPF_PHONE_VALIDATION
                  cpf: cpf
                  phone: "11900000000"
              validacaoCpfEndereco:
                summary: PF - Validação de CPF com endereço
                value:
                  service: SERVICE_CPF_ADDRESS_VALIDATION
                  cpf: cpf
                  zipcode: 00000-000
                  numberAddress: 13
              documentoscopiaDigital:
                summary: PF - Documentoscopia digital
                value:
                  service: SERVICE_DIGITAL_DOCUMENTOSCOPY
                  key: 84bfcd2e-2336-4e30-bcab-15348b7890b5
                  image1: base64
                  image2: base64
                  selfie1: base64
              resultadoDocumentoscopiaDigital:
                summary: PF - Resultado da documentoscopia digital
                value:
                  service: SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT
                  key: de0cd562-5962-40bd-8f94-5a7184ecde0e
              consultaMei:
                summary: PF - Consulta de MEI
                value:
                  service: SERVICE_MEI
                  cpf: cpf
              processosJuridicosAdministrativos:
                summary: PF - Processos jurídicos e administrativos
                value:
                  service: SERVICE_JURIDICAL_PROCESSES
                  cpf: cpf
              servidoresPublicos:
                summary: PF - Servidores públicos
                value:
                  service: SERVICE_PUBLIC_SERVANTS
                  cpf: cpf
              consultaEnderecos:
                summary: PF - Endereços
                value:
                  service: SERVICE_ADDRESS
                  cpf: cpf
              historicoTelefones:
                summary: PF - Histórico de telefones
                value:
                  service: SERVICE_PHONE_HISTORY
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
                  limit: 10
              pessoasRelacionadas:
                summary: PF - Pessoas relacionadas
                value:
                  service: SERVICE_RELATED_PEOPLE
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              historicoEmails:
                summary: PF - Histórico de e-mails
                value:
                  service: SERVICE_EMAILS_EXTENDED
                  cpf: cpf
                  limit: 10
              relacionamentosEconomicos:
                summary: PF - Relacionamentos econômicos
                value:
                  service: SERVICE_ECONOMIC_RELATIONSHIP
                  cpf: cpf
              historicoProfissional:
                summary: PF - Histórico profissional
                value:
                  service: SERVICE_PROFESSIONAL_HISTORY
                  cpf: cpf
              historicoProfissionalTitular:
                summary: PF - Histórico profissional do titular
                value:
                  service: SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              dadosFinanceirosEnderecosPf:
                summary: PF - Dados financeiros e endereços
                value:
                  service: SERVICE_PF_FINANCIAL_AND_ADDRESS
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              propensaoApostasOnline:
                summary: PF - Propensão a apostas online
                value:
                  service: SEVICE_ONLINE_BETTING_PROPENSITY
                  cpf: cpf
              dadosPeloTelefone:
                summary: PF - Dados pelo telefone
                value:
                  service: SERVICE_CONFIRM_PHONE
                  phone: "+5561123456789"
              mandadoPrisao:
                summary: PF - Mandado de prisão
                value:
                  service: SERVICE_ARREST_WARRANT
                  nome: nome
                  motherName: nome da mãe
                  fatherName: nome do pai
                  birthDate: dd/MM/yyyy
                  cpf: cpf
              debitosAtivosPf:
                summary: PF - Débitos ativos
                value:
                  service: SERVICE_ACTIVE_DEBT_PF
                  cpf: cpf
              dadosEleitoraisCandidato:
                summary: PF - Dados eleitorais de candidato
                value:
                  service: SERVICE_ELECTION_CANDIDATE_DATA_CPF
                  cpf: cpf
              doacoesEleitorais:
                summary: PF - Doações eleitorais
                value:
                  service: SERVICE_ELECTORAL_DONORS_CPF
                  cpf: cpf
              envolvimentoPolitico:
                summary: PF - Envolvimento político
                value:
                  service: SERVICE_POLITICAL_INVOLVEMENT
                  cpf: cpf
              kycCompliancePessoaFisica:
                summary: PF - KYC e compliance
                value:
                  service: SERVICE_PERSON_KYC
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              exposicaoPerfilMidiaPf:
                summary: PF - Exposição e perfil na mídia
                value:
                  service: SERVICE_MEDIA_PROFILE_EXPOSURE_PF
                  cpf: cpf
              historicoFamiliarPolitico:
                summary: PF - Histórico familiar político
                value:
                  service: SERVICE_FAMILY_POLITICAL_HISTORY_CPF
                  cpf: cpf
              prestadoresServicoEleitorais:
                summary: PF - Prestadores de serviço eleitorais
                value:
                  service: SERVICE_ELECTORAL_PROVIDERS_CPF
                  cpf: cpf
              indicadoresAtividades:
                summary: PF - Indicadores de atividades
                value:
                  service: SERVICE_ACTIVITIES_INDICATORS
                  cpf: cpf
              premiosCertificacoes:
                summary: PF - Prêmios e certificações
                value:
                  service: SERVICE_AWARDS_AND_CERTIFICATIONS_CPF
                  cpf: cpf
              scoreCredito:
                summary: PF - Score de crédito
                value:
                  service: SERVICE_CREDIT_SCORE
                  cpf: cpf
              scoreRiscoinadimplência:
                summary: PF - Score de inadimplência
                value:
                  service: SERVICE_DEFAULT_RISK_SCORE
                  cpf: cpf
              dadosDemograficos:
                summary: PF - Dados demográficos
                value:
                  service: SERVICE_DEMOGRAPHIC_DATA_CPF
                  cpf: cpf
                  birthDate: yyyy-MM-dd (opcional)
              dominiosPessoaFisica:
                summary: PF - Domínios
                value:
                  service: SERVICE_DOMAINS_CPF
                  cpf: cpf
              faceIndex:
                summary: PF - Busca de face na base
                value:
                  service: SERVICE_FACE_INDEX
                  image1: base64
              beneficiosSociaisFamiliares:
                summary: PF - Benefícios sociais familiares
                value:
                  service: SERVICE_FAMILY_SOCIAL_BENEFITS
                  cpf: cpf
              ocrReact:
                summary: PF - OCR React
                value:
                  service: SERVICE_OCR
                  documentType: CNH
                  image1: base64
                  image2: base64 (obrigatorio para RG)
              ocrEmancipacao:
                summary: PF - OCR de emancipação
                value:
                  service: SERVICE_OCR_EMANCIPATION
                  image1: base64
              ocrComprovanteEndereco:
                summary: PF - OCR de comprovante de endereço
                value:
                  service: SERVICE_OCR_PROOF_OF_ADDRESS
                  image1: base64
              beneficiosSociaisEstendidos:
                summary: PF - Benefícios sociais estendidos
                value:
                  service: SERVICE_SOCIAL_ASSISTANCE_EXTENDED
                  cpf: cpf
              dasMeiReceita:
                summary: PJ - DAS MEI na Receita
                value:
                  service: SERVICE_DAS_MEI
                  cnpj: cnpj
              processosJuridicosSocios:
                summary: PJ - Processos jurídicos dos sócios
                value:
                  service: SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS
                  cnpj: cnpj
              complianceBet:
                summary: PJ - Compliance de casas de apostas (alias curto)
                value:
                  service: SERVICE_COMPLIANCE_BET
                  cnpj: cnpj
              riscoCreditoEmpresa:
                summary: PJ - Risco de crédito
                value:
                  service: SERVICE_CREDIT_RISK_COMPANY
                  cnpj: cnpj
              dominiosCnpj:
                summary: PJ - Domínios CNPJ
                value:
                  service: SERVICE_DOMAINS_CNPJ
                  cnpj: cnpj
              processosJuridicosPj:
                summary: PJ - Processos jurídicos
                value:
                  service: SERVICE_JURIDICAL_PROCESSES_PJ
                  cnpj: cnpj
              ocrCartaoCnpj:
                summary: PJ - OCR de cartão CNPJ
                value:
                  service: SERVICE_OCR_CNPJ_CARD
                  image1: base64
              dadosCadastraisCnpj:
                summary: PJ - Dados cadastrais de CNPJ
                value:
                  service: SERVICE_REGISTRATION_DATA_CNPJ
                  cnpj: cnpj
              enriquecimentoPessoaJuridica:
                summary: PJ - Enriquecimento de dados
                value:
                  service: SERVICE_CORPORATE_DATA_ENRICHMENT
                  cnpj: cnpj
              statusCnpjReceitaFederal:
                summary: PJ - Status do CNPJ na Receita Federal
                value:
                  service: SERVICE_RFB_PJ
                  cnpj: cnpj
              statusCnpjReceitaFederalOnDemand:
                summary: PJ - CNPJ na Receita Federal on-demand
                value:
                  service: SERVICE_RFB_PJ_ON_DEMAND
                  cnpj: cnpj
              relacionamentosEmpresa:
                summary: PJ - Relacionamentos da empresa
                value:
                  service: SERVICE_COMPANY_RELATIONSHIP
                  cnpj: cnpj
              sociosReceitaFederal:
                summary: PJ - Sócios na Receita Federal
                value:
                  service: SERVICE_COMPANY_RFB_OWNERS
                  cnpj: cnpj
              doacoesEleitoraisPj:
                summary: PJ - Doações eleitorais
                value:
                  service: SERVICE_ELECTORAL_DONORS_CNPJ
                  cnpj: cnpj
              doacoesEleitoraisSocios:
                summary: PJ - Doações eleitorais dos sócios
                value:
                  service: SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ
                  cnpj: cnpj
              fornecedoresEleitoraisPj:
                summary: PJ - Fornecedores eleitorais
                value:
                  service: SERVICE_ELECTORAL_PROVIDERS_CNPJ
                  cnpj: cnpj
              sintegra:
                summary: PJ - SINTEGRA
                value:
                  service: SERVICE_SINTEGRA_CONSULTATION
                  cnpj: cnpj
                  uf: uf (opcional)
              enderecosEstendidosEmpresa:
                summary: PJ - Endereços estendidos
                value:
                  service: SERVICE_ADDRESSES_EXTENDED_CNPJ
                  cnpj: cnpj
              sociosPrimeiroNivel:
                summary: PJ - Sócios de primeiro nível
                value:
                  service: SERVICE_FIRST_LEVEL_PARTNER
                  cnpj: cnpj
              kycComplianceSocios:
                summary: PJ - KYC e compliance dos sócios
                value:
                  service: SERVICE_COMPANY_KYC_OWNERS
                  cnpj: cnpj
              exposicaoPerfilMidiaPj:
                summary: PJ - Exposição e perfil na mídia dos sócios
                value:
                  service: SERVICE_MEDIA_PROFILE_EXPOSURE_PJ
                  cnpj: cnpj
              debitosAtivosPj:
                summary: PJ - Débitos ativos
                value:
                  service: SERVICE_ACTIVE_DEBT_PJ
                  cnpj: cnpj
              certidaoNegativaProtestoPj:
                summary: PJ - Certidão negativa de protesto
                value:
                  service: SERVICE_PROTEST_PJ
                  cnpj: cnpj
              complianceCasasApostasPj:
                summary: PJ - Compliance de casas de apostas
                value:
                  service: SERVICE_COMPLIANCE_BET_PJ
                  cnpj: cnpj
              scoreCreditoPj:
                summary: PJ - Score de Crédito PJ
                value:
                  service: SERVICE_QUOD_CREDIT_SCORE_COMPANY
                  cnpj: cnpj
              scoreCreditoMultidadosPj:
                summary: PJ - Score de Crédito Multidados PJ
                value:
                  service: SERVICE_BOAVISTA_ONE_SCORE_COMPANY
                  cnpj: cnpj
              dadosRestritivosPj:
                summary: PJ - Dados Restritivos PJ
                value:
                  service: SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY
                  cnpj: cnpj
              flagsNegativosPj:
                summary: PJ - Flags Negativos PJ
                value:
                  service: SERVICE_QUOD_CREDIT_RISK_COMPANY
                  cnpj: cnpj
              scoreCreditoQuantumPj:
                summary: PJ - Score de Crédito Quantum PJ
                value:
                  service: SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY
                  cnpj: cnpj
              beneficiariosFinais:
                summary: PJ - Beneficiários Finais
                value:
                  service: SERVICE_ULTIMATE_BENEFICIAL_OWNERS
                  cnpj: cnpj
              percentualParticipacaoSocietaria:
                summary: PJ - Percentual de Participação Societária
                value:
                  service: SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY
                  cnpj: cnpj
              projetosPublicos:
                summary: PJ - Projetos Públicos
                value:
                  service: SERVICE_PUBLIC_PROJECTS
                  cnpj: cnpj
              obrasCivis:
                summary: PJ - Obras Civis
                value:
                  service: SERVICE_CIVIL_CONSTRUCTION
                  cnpj: cnpj
              debitosPgfn:
                summary: PJ - Débitos com a PGFN
                value:
                  service: SERVICE_PGFN_COMPANY
                  cnpj: cnpj
              cotaPcd:
                summary: PJ - Cota de PCD
                value:
                  service: SERVICE_PCD_COMPANY
                  cnpj: cnpj
              certidaoCgu:
                summary: PJ - Certidão Negativa Correcional CGU
                value:
                  service: SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY
                  cnpj: cnpj
              certidaoCnj:
                summary: PJ - Certidão Negativa CNJ
                value:
                  service: SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY
                  cnpj: cnpj
              certidaoDebitosEstaduais:
                summary: PJ - Certidão Negativa de Débitos Estaduais
                value:
                  service: SERVICE_STATE_DEBT_CERTIFICATE_COMPANY
                  cnpj: cnpj
              optanteSimples:
                summary: PJ - Optante pelo Simples Nacional
                value:
                  service: SERVICE_SIMPLES_COMPANY
                  cnpj: cnpj
              kycGrupoEconomico:
                summary: PJ - KYC e Compliance do Grupo Econômico
                value:
                  service: SERVICE_ECONOMIC_GROUP_KYC_COMPANY
                  cnpj: cnpj
              relacionamentosGrupoEconomico:
                summary: PJ - Relacionamentos do Grupo Econômico
                value:
                  service: SERVICE_ECONOMIC_GROUP_RELATIONSHIPS
                  cnpj: cnpj
              avaliacoesReputacao:
                summary: PJ - Avaliações e Reputação
                value:
                  service: SERVICE_REPUTATIONS_AND_REVIEWS
                  cnpj: cnpj
              dadosFundosInvestimento:
                summary: PJ - Dados de Fundos de Investimento
                value:
                  service: SERVICE_INVESTMENT_FUND_DATA
                  cnpj: cnpj
              influenciaQuadroSocietario:
                summary: PJ - Influência do Quadro Societário
                value:
                  service: SERVICE_OWNERS_INFLUENCE
                  cnpj: cnpj
              arrecadacaoSimplesMei:
                summary: PJ - Arrecadação Simples Nacional - MEI
                value:
                  service: SERVICE_PGMEI
                  cnpj: cnpj
              fgtsRegularidade:
                summary: PJ - FGTS
                value:
                  service: SERVICE_FGTS
                  cnpj: cnpj
              marketplaces:
                summary: PJ - Marketplaces
                value:
                  service: SERVICE_MARKETPLACE_DATA
                  cnpj: cnpj
              anunciosOnline:
                summary: PJ - Anúncios Online
                value:
                  service: SERVICE_ONLINE_ADS
                  cnpj: cnpj
              receitaFederalQsa:
                summary: PJ - Receita Federal - QSA
                value:
                  service: SERVICE_RF_QSA
                  cnpj: cnpj
              distribuicaoProcessosSocios:
                summary: PJ - Distribuição de Processos dos Sócios
                value:
                  service: SERVICE_OWNERS_LAWSUITS_DISTRIBUTION
                  cnpj: cnpj
              distribuicaoProcessosJudiciais:
                summary: PJ - Distribuição de Processos Judiciais
                value:
                  service: SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY
                  cnpj: cnpj
              acoesTrabalhistas:
                summary: PJ - Ações Trabalhistas
                value:
                  service: SERVICE_LABOR_LAWSUITS
                  cnpj: cnpj
              kycComplianceFuncionarios:
                summary: PJ - KYC e Compliance dos Funcionários
                value:
                  service: SERVICE_EMPLOYEES_KYC
                  cnpj: cnpj
              historicoDadosBasicos:
                summary: PJ - Histórico de Dados Básicos
                value:
                  service: SERVICE_HISTORY_BASIC_DATA
                  cnpj: cnpj
              categoriaComercial:
                summary: PJ - Categoria Comercial
                value:
                  service: SERVICE_MERCHANT_CATEGORY_DATA
                  cnpj: cnpj
              acordosSindicais:
                summary: PJ - Acordos Sindicais
                value:
                  service: SERVICE_SYNDICATE_AGREEMENTS
                  cnpj: cnpj
              telefonesEmpresa:
                summary: PJ - Telefones
                value:
                  service: SERVICE_PHONES_EXTENDED_COMPANY
                  cnpj: cnpj
              evolucaoEmpresa:
                summary: PJ - Evolução da Empresa
                value:
                  service: SERVICE_COMPANY_EVOLUTION
                  cnpj: cnpj
              informacoesFinanceiras:
                summary: PF - Informações financeiras
                value:
                  service: SERVICE_FINANCIAL_INFORMATION
                  cpf: cpf
              dadosPis:
                summary: PF - Dados PIS
                value:
                  service: SERVICE_PIS_CONSULTATION
                  cpf: cpf
              validacaoEsocial:
                summary: PF - Validação do E-Social
                value:
                  service: SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION
                  cpf: cpf
                  nit: "(opcional)"
      responses:
        '200':
          description: |
            Resultado do serviço executado. A estrutura de `result` varia de
            acordo com o código `service`, mas o objeto `status` segue o padrão
            técnico da API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceApiResponse'
              examples:
                enriquecimentoPessoaFisica:
                  summary: PF - Enriquecimento de dados
                  value:
                    result:
                      cpf: "06319423196"
                      status: REGULAR
                      statusDate: "2022-05-29T00:00:00"
                      name: NOME DA PESSOA
                      motherName: NOME DA MÃE
                      birthdate: "1998-07-05"
                      birthCountry: BRASILEIRA
                      dead: false
                      gender: M
                      age: 24
                      origin: RECEITA FEDERAL
                      fiscalRegion: DF-GO-MS-MT-TO
                      numberOfPeopleWithTheSameName: "3"
                      nameWordCount: "3"
                      nameUniqueScore: "0.994"
                    status:
                      code: 200
                      message: Success
                statusCpfReceitaFederal:
                  summary: PF - Status do CPF na Receita Federal
                  value:
                    result:
                      cpf: "123414124"
                      status: REGULAR
                      name: NOME EXEMPLO
                      birthDate: yyyy-MM-ddT00:00
                      dead: false
                      origin: RECEITA FEDERAL
                      age: 30
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                    externalId: 1782ea0a-8663-41a8-b156-688527f5363b
                statusCpfReceitaFederalOnDemand:
                  summary: PF - CPF na Receita Federal on-demand
                  value:
                    result:
                      cpf: "123414124"
                      status: REGULAR
                      name: NOME EXEMPLO
                      birthDate: "1994-05-21T00:00"
                      dead: false
                      origin: RECEITA FEDERAL
                      age: 30
                    status:
                      code: 200
                      message: Success
                modelagemDadosPessoa:
                  summary: PF - Modelagem de dados
                  value:
                    result:
                      modelData: Dados de modelagem consolidados para o CPF consultado.
                    results:
                      - modelData: Dados de modelagem consolidados para o CPF consultado.
                    status:
                      code: 200
                      message: Success
                promptIaPessoa:
                  summary: PF - Prompt de IA para pessoa
                  value:
                    result:
                      modelData: Resumo analítico gerado a partir dos dados consolidados da pessoa consultada.
                    results:
                      - modelData: Resumo analítico gerado a partir dos dados consolidados da pessoa consultada.
                    status:
                      code: 200
                      message: Success
                ocrDocumentos:
                  summary: PF - OCR React
                  value:
                    result:
                      cpf: "06319423196"
                      name: NOME DA PESSOA
                      fatherName: NOME DO PAI
                      motherName: NOME DA MÃE
                      birthdate: "1992-01-05"
                      cnhCategory: AB
                      cnhNumber: "07796497926"
                      emissionPlace: DETRAN DE
                      expeditionDate: "13/04/2020"
                      rg: "3451620"
                      rgUf: DF
                      doc: CNH
                      orgEmission: DETRAN
                      place: BRASILIA-DISTRITO FEDERAL, DF
                      side: C
                      validDate: "13/02/2021"
                      paidActivity: "False"
                      REANCH: DF767732467
                    status:
                      code: 200
                      message: Success
                faceMatch:
                  summary: PF - FaceMatch
                  value:
                    result:
                      status: Face picture match
                      similarity: 99.95
                    status:
                      code: 200
                      message: Success
                emailsPessoasRelacionadas:
                  summary: PF - E-mails de Pessoas Relacionadas
                  value:
                    result:
                      cpf: "06319423196"
                      totalRelatedPeopleEmails: 2
                      relatedPeopleEmailsList: "nome@email.com - NOME DA PESSOA - 00000000000 - CONJUGE"
                      relatedPeopleEmails:
                        - relatedCpf: "00000000000"
                          relatedName: NOME DA PESSOA
                          relationship: CONJUGE
                          type: PESSOAL
                          isMain: true
                          isRecent: true
                          isActive: true
                          email: nome@email.com
                          domain: email.com
                          validationStatus: VALID
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                telefonesPessoasRelacionadas:
                  summary: PF - Telefones de Pessoas Relacionadas
                  value:
                    result:
                      cpf: "06319423196"
                      totalRelatedPeoplePhones: 1
                      relatedPeoplePhonesList: "11900000000 - NOME DA PESSOA - 00000000000 - FILHO"
                      relatedPeoplePhones:
                        - relatedCpf: "00000000000"
                          relatedName: NOME DA PESSOA
                          relationship: FILHO
                          type: CELULAR
                          isMain: true
                          isRecent: true
                          isActive: true
                          areaCode: "11"
                          number: "900000000"
                          phone: "11900000000"
                          isInDoNotCallList: false
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                enderecosPessoasRelacionadas:
                  summary: PF - Endereços de Pessoas Relacionadas
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalRelatedPeopleAddresses: 1
                      relatedPeopleAddressesList: "RUA EXEMPLO, 100 - NOME DA PESSOA - 00000000000 - SOCIO"
                      relatedPeopleAddresses:
                        - relatedCpf: "00000000000"
                          relatedName: NOME DA PESSOA
                          relationship: SOCIO
                          type: RESIDENCIAL
                          isMain: true
                          isRecent: true
                          isActive: true
                          address: RUA EXEMPLO
                          zipcode: "00000000"
                          state: SP
                          city: SAO PAULO
                          neighborhood: CENTRO
                          number: "100"
                          complement: ""
                          isRatified: true
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                scoreCreditoPf:
                  summary: PF - Score de Crédito
                  value:
                    result:
                      cpf: "06319423196"
                      score: 680
                      riskLevel: MEDIO
                      riskClassification: B
                      reasonCodes:
                        - Tempo de relacionamento com o mercado
                        - Renda declarada baixa
                      creditBureauSummary: Score de crédito dentro da média do perfil
                      creditBureauDetails: {}
                      origin: Quod
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                scoreCreditoMultidadosPf:
                  summary: PF - Score de Crédito Multidados
                  value:
                    result:
                      cpf: "06319423196"
                      score: 710
                      riskLevel: BAIXO
                      riskClassification: A
                      reasonCodes:
                        - Bom histórico de pagamentos
                      creditBureauSummary: Score de crédito multidados acima da média do perfil
                      creditBureauDetails: {}
                      origin: Boa Vista
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                dadosRestritivosPf:
                  summary: PF - Dados Restritivos
                  value:
                    result:
                      cpf: "06319423196"
                      score: 705
                      hasRestrictions: false
                      restrictionCount: 0
                      creditBureauSummary: Nenhuma restrição de crédito encontrada
                      creditBureauDetails: {}
                      origin: Boa Vista
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                flagsNegativosPf:
                  summary: PF - Flags Negativos
                  value:
                    result:
                      cpf: "06319423196"
                      riskLevel: BAIXO
                      riskClassification: A
                      hasRestrictions: false
                      negativeFlagsCount: 0
                      creditBureauSummary: Nenhum flag negativo encontrado
                      creditBureauDetails: {}
                      origin: Quod
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                tseLocalVotacao:
                  summary: PF - TSE - Local de votação
                  value:
                    result:
                      cpf: "06319423196"
                      status: REGULAR
                      pollingPlace: ESCOLA CLASSE 01
                      pollingPlaceAddress: QUADRA 01, BRASILIA - DF
                      city: BRASILIA
                      uf: DF
                      zipcode: "70000000"
                      electoralZone: "001"
                      electoralSection: "0001"
                      hasBiometrics: true
                      queryDate: "2026-08-01"
                      source: TSE-LOCALVOTACAO
                      onlineQuery: Situação, local, endereço, zona e seção retornados com sucesso
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                pessoaPoliticamenteExposta:
                  summary: PF - Pessoa politicamente exposta
                  value:
                    result:
                      cpf: "74768289096"
                      status: Pessoa não exposta politicamente
                    status:
                      code: 200
                      message: success
                dividaAtivaPessoaFisica:
                  summary: PF - Dívida ativa
                  value:
                    result:
                      cpf: "88154726068"
                      status: NEGATIVA
                      statusDate: "2022-08-16"
                      origin: Receita-Federal PGFN
                      validDate: "0001-01-01"
                    status:
                      code: 200
                      message: Success
                scoreRiscoFraude:
                  summary: PF - Score de risco de fraude
                  value:
                    result:
                      cpf: "80246074507"
                      score: "8.0691"
                      factor: MEDIUM RISK
                      message: Success calculating score
                    status:
                      code: 200
                      message: Success
                riscoFinanceiro:
                  summary: PF - Risco financeiro
                  value:
                    result:
                      cpf: "80246074507"
                      score: "650"
                      message: "Score: 650 | Análise: RISCO MÉDIO"
                    status:
                      code: 200
                      message: Success
                scoreInadimplencia:
                  summary: PF - Score de inadimplência
                  value:
                    result:
                      cpf: "{80246074507}"
                      status: REGULAR
                      origin: Datarisk
                      score: "462"
                      rank: E
                      expectedDefault: "58.94%"
                      processType: SEM PROCESSOS
                    status:
                      code: 200
                      message: Success
                scoreBiometrico:
                  summary: PF - Score biométrico
                  value:
                    result:
                      cpf: "73583960149"
                      status: Altíssima probabilidade
                      message: Biometrics exist at the base of the Government
                      similarity: 99.66
                    status:
                      code: 200
                      message: Success
                nadaConstaAcoesJudiciais:
                  summary: PF - Certidão de Nada Consta
                  value:
                    result:
                      cpf: "80246074507"
                      status: NADA CONSTA
                      origin: NadaConsta
                      state: TRF1
                      name: Fulano
                      certificateNumber: "212312312311231"
                      certificateText: A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998
                      expirationDate: "2022-10-20"
                      emissionDate: "2022-10-20"
                      type: CIVEL E CRIMINAL
                    status:
                      code: 200
                      message: Success
                antecedentesCriminaisCivil:
                  summary: PF - Antecedentes criminais civis
                  value:
                    result:
                      cpf: "80246074507"
                      status: NADA CONSTA
                      uf: BA
                      emissionDate: 00:00 de 20/12/2022
                      certificateNumber: A5FD4A36-3F31-4F75-8AF0-103B7BB66212
                      certificateText: "Antecedentes Criminais CERTIFICADO DE ANTECEDENTES CRIMINAIS Nome: NOME DA PESSOA Número do Rg: 14781688 Nome do Pai: NOME DO PAI Nome da Mãe: NOME DA MÃE Data de Nascimento: 19/6/1997 Naturalidade: \"Certifico que o requerente acima qualificado NÃO registra antecedentes criminais até a presente data no Centro de Documentação e Estatística Policial (CEDEP), da Polícia Civil \". IMPORTANTE: Este certificado é válido somente com a apresentação da cédula de Identidade expedida pelo Instituto de Identificação Pedro Melo/DPT/SSP. Este certificado foi emitido terça-feira, 20 de dezembro de 2022 e está disponível para consulta no endereço http://www.ba.gov.br/antecedentes/validar_atestado.asp, informando o código A5FD4A36-3F31-4F75-8AF0-103B7BB66212 Obs: Este certificado tem validade até a data 20/3/2023 Imprimir Fechar Janela"
                      origin: PoliciaCivilAntecedentes
                    status:
                      code: 200
                      message: Success
                validacaoEmail:
                  summary: PF - Validação de e-mail
                  value:
                    result:
                      email: usuario@example.com
                      status: VALID
                      normalizedEmail: usuario@example.com
                      address: usuario@example.com
                      account: teste
                      domain: test.com
                      disposable: false
                      roleAddress: false
                      riskyAccount: false
                      riskyDomain: false
                      junk: false
                      limited: false
                      acceptAll: false
                      possibleSpamTrap: false
                      wasSyntaxValid: true
                      wasSyntaxNormalized: false
                      wasSiteFound: true
                      wasOwnershipFound: false
                      possibleStoogeDomain: false
                      domainType: BLOG
                    status:
                      code: 200
                      message: Success
                validacaoEsocial:
                  summary: PF - Validação do E-Social
                  value:
                    result:
                      cpf: "80246074507"
                      status: VERIFIED
                      message: Os dados estão corretos.
                      name: NOME EXEMPLO
                      birthdate: "1971-11-23"
                      pis: "12460888617"
                    status:
                      code: 200
                      message: Success
                antecedentesCriminaisFederal:
                  summary: PF - Antecedentes criminais federais
                  value:
                    result:
                      cpf: "80246074507"
                      status: NADA CONSTA
                      certificateNumber: "79222652022"
                      certificateText: A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998
                      expirationDate: "2022-10-20"
                    status:
                      code: 200
                      message: Success
                validacaoCpfTelefone:
                  summary: PF - Validação de CPF com telefone
                  value:
                    result:
                      cpf: "80246074507"
                      phone: "5561982358585"
                      operator: OPERADORA EXEMPLO
                      validCarrierPhone: true
                      matchRateCpfPhone: 100
                    status:
                      code: 200
                      message: Success
                validacaoCpfEndereco:
                  summary: PF - Validação de CPF com endereço
                  value:
                    result:
                      cpf: "80246074507"
                      message: Customer not found
                      carrierName: CLARO S.A.
                      zipcode: "00000000"
                      zipCodeMatchRate: -1
                      numberMatchRate: -1
                      numberAddress: "13"
                    status:
                      code: 200
                      message: Success
                documentoscopiaDigital:
                  summary: PF - Documentoscopia digital
                  value:
                    result:
                      cpf: "80246074507"
                      name: NOME DA PESSOA
                      fatherName: NOME DO PAI
                      motherName: NOME DA MÃE
                      birthdate: "1984-05-21"
                      cnhCategory: AD
                      expeditionDate: "19/03/2021"
                      rg: "3261880"
                      rgUf: DF
                      reanch: DF765309297
                      place: Distrito Federal, Goiás, Mato Grosso, Mato Grosso do Sul ou Tocantins
                      validDate: "2026-02-24"
                      biometry: 1
                    status:
                      code: 200
                      message: Success
                resultadoDocumentoscopiaDigital:
                  summary: PF - Resultado da documentoscopia digital
                  value:
                    result:
                      cpf: "80246074507"
                      name: NOME DA PESSOA
                      fatherName: NOME DO PAI
                      motherName: NOME DA MÃE
                      birthdate: "1992-01-05"
                      cnhCategory: AB
                      cnhNumber: "07796497926"
                      expeditionDate: "2020-04-13"
                      rg: "3451620"
                      rgUf: DF
                      doc: CNH
                      place: BRASILIA-DISTRITO FEDERAL, DF
                      validDate: "2021-02-13"
                      REANCH: DF767732467
                      biometry: 3
                    status:
                      code: 200
                      message: Success
                consultaMei:
                  summary: PF - Consulta de MEI
                  value:
                    result:
                      meis:
                        - cpf: "34449772040"
                          cnpj: "22745099000193"
                          companyName: EMPRESA MEI EXEMPLO
                          sector: PRIVATE - 9511800 - REPARACAO E MANUTENCAO DE COMPUTADORES
                          classification: SELF-EMPLOYED
                          startDate: "2022-02-03"
                          endDate: "2022-02-10"
                    status:
                      code: 200
                      message: Success
                dadosPeloTelefone:
                  summary: PF - Dados pelo telefone
                  value:
                    result:
                      cpf: "11111111111"
                      name: NOME DA PESSOA
                      phone: "+5561123456789"
                    status:
                      code: 200
                      message: Success
                historicoProfissionalTitular:
                  summary: PF - Histórico profissional do titular
                  value:
                    result:
                      professionalHistory:
                        - cnpj: "05731652000209"
                          companyName: EMPRESA EXEMPLO LTDA
                          classification: ENTREPRENEUR | BUSINESS OWNER
                          sector: PRIVATE - 8599604 - TREINAMENTO EM DESENVOLVIMENTO PROFISSIONAL E GERENCIAL
                          startDate: "2004-02-10"
                          endDate: "2007-12-23"
                    status:
                      code: 200
                      message: Success
                dadosFinanceirosEnderecosPf:
                  summary: PF - Dados financeiros e endereços
                  value:
                    result:
                      cpf: "80246074507"
                      name: NOME EXEMPLO
                      status: REGULAR
                      origin: RECEITA FEDERAL
                      monthlyIncomeEstimate: "4 A 10 SM"
                      equityEstimate: "100000.00"
                      addresses:
                        - zipcode: "70000000"
                          country: BRASIL
                          address: QUADRA EXEMPLO
                          city: BRASILIA
                          addressType: HOME
                          neighborhood: ASA NORTE
                          state: DF
                      personalIncomeTaxReturns:
                        - year: "2023"
                          situation: CREDITADA
                          bankAgency: BANCO EXEMPLO
                    status:
                      code: 200
                      message: Success
                propensaoApostasOnline:
                  summary: PF - Propensão a apostas online
                  value:
                    result:
                      propensityScore: 72
                      totalPassages: 12
                      firstPassageDate: "2024-01-10T00:00:00"
                      lastPassageDate: "2024-09-18T00:00:00"
                      last30DaysPassages: 1
                      last90DaysPassages: 3
                      last180DaysPassages: 7
                      last365DaysPassages: 12
                    status:
                      code: 200
                      message: Success
                mandadoPrisao:
                  summary: PF - Mandado de prisão
                  value:
                    result:
                      message: Nenhum mandado de prisão encontrado.
                      arrestWarrantFound: false
                    status:
                      code: 200
                      message: Success
                debitosAtivosPf:
                  summary: PF - Débitos ativos
                  value:
                    result:
                      totalDebtValue: 0
                      totalDebtValuePerOrigin: {}
                      totalDebts: 0
                      totalDebtsPerOrigin: {}
                      debts:
                        - source: Fonte
                          debtOrigin: Origem
                          consolidatedValue: Valor
                          responsibleUnity: Unidade
                          responsibleUnityUF: UF
                          registrationNumber: "1234"
                          registrationSituationType: divida
                          registrationSituation: ativo
                    status:
                      code: 200
                      message: Success
                dadosEleitoraisCandidato:
                  summary: PF - Dados eleitorais de candidato
                  value:
                    result:
                      hasRunForOffice: true
                      hasBeenElected: true
                      numberOfTimesRanForOffice: 1
                      numberOfTimesElected: 1
                      lastElectedRole: Presidente
                      firstElectionYearRanForOffice: "2000"
                      lastElectionYearRanForOffice: "2020"
                      firstElectionYearElected: "2000"
                      lastElectionYearElected: "2020"
                      electionData:
                        - ballotName: ROG***NHO
                          ballotNumber: 77789
                          fullName: CAR***************************IRA
                          normalizedName: CAR***************************IRA
                          docNumber: "832*****753"
                          voterNumber: "079******370"
                          url: https://divulgacandcontas.tse.jus.br/divulga/rest/v1/candidatura/buscar/2020/58955/2030402020/candidato/190000751750
                          electionYear: "2020"
                          electionType: Municipal
                          applicationRole: Vereador
                          applicationPlace: SÃO FIDÉLIS
                          applicationUf: RJ
                          campaignCNPJ: "38646823000161"
                          status: Eleito por QP
                          wasElected: true
                          candidateSituation: Consta da urna
                          applicationSituation: Deferido
                          emails:
                            - eleicoes2020sf@gmail.com
                          gender: MASC.
                          maritalStatus: Casado(a)
                          colorRace: BRANCA
                          instructionLevel: Ensino Médio completo
                          occupation: Técnico em Agronomia e Agrimensura
                          birthDate: "0001-01-01T00:00:00Z"
                          nationality: Brasileira nata
                          birthUF: SÃO FIDÉLIS
                          partyNumber: 77
                          partyAcronym: SOLIDARIEDADE
                          partyName: Sol*******ade
                          campaignSpentValue: 0
                          campaignSpendingFirstRound: 122565.82
                          campaignSpendingSecondRound: 0
                          totalAssetsValue: 93100
                          assetsList:
                            - description: economia pessoal
                              type: Dinheiro em espécie - moeda nacional
                              value: 8100
                          accountability:
                            accountabilityControlNumber: 777***************502
                            consolidatedRevenueValues:
                              totalReceivedResources: 13390.8
                              totalFinancialResources: 9230
                              totalEstimatedResources: 4160.8
                            consolidatedExpensesValues:
                              expensesThreshold: 122565.82
                              totalExpensesContracted: 9230
                              totalExpensesPaid: 9230
                            suppliersRanking:
                              - docNumber: 123********102
                                name: A.J*****************************RIA
                                numberDonations: "9"
                                totalValue: 9230
                    status:
                      code: 200
                      message: Success
                doacoesEleitorais:
                  summary: PF - Doações eleitorais
                  value:
                    result:
                      totalDonationsAmount: 15
                      totalDonatedValue: 57930428
                      quantityOfDonationsLastElection: 0
                      quantityOfDonationsLastTwoElections: 0
                      quantityOfDonationsLastThreeElection: 1
                      donatedValueLastElection: 0
                      donatedValueLastTwoElections: 0
                      donatedValueLastThreeElection: 25000000
                      partiesThatReceivedDonation:
                        - PSDB
                        - PST
                        - PRP
                        - PFL
                        - MDB
                      maxDonationValue: 57030000
                      averageDonationValue: 8275775.5
                      minDonationValue: 684
                      electionDonationData:
                        - politicianBallotNumber: 0
                          politicianFullName: HEN**********************LES
                          electionYear: "2002"
                          partyName: P**B
                          donationsAmount: "6"
                          totalDonationValue: 887050.1
                          isCrowdfunding: false
                          donationRecipient: CANDIDATE
                          isCrossDonation: false
                          partyCrossDonationValue: 0
                    status:
                      code: 200
                      message: Success
                envolvimentoPolitico:
                  summary: PF - Envolvimento político
                  value:
                    result:
                      electionsCount: 5
                      isCurrentlyInOffice: true
                      wasFormerlyElected: true
                      isPep: true
                      amountDonated: 19804076
                      amountReceived: 20599420
                      politicalInvolvementScore: 1
                    status:
                      code: 200
                      message: Success
                kycCompliancePessoaFisica:
                  summary: PF - KYC e compliance
                  value:
                    result:
                      cpf: "12345678901"
                      isPep: false
                      isCurrentlySanctioned: false
                      sanctionsHistory: []
                      pepHistories: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                exposicaoPerfilMidiaPf:
                  summary: PF - Exposição e perfil na mídia
                  value:
                    result:
                      cpf: "12345678901"
                      mediaExposureLevel: MEDIUM
                      celebrityLevel: LOW
                      unpopularityLevel: LOW
                      fullName: NOME EXEMPLO
                      shortName: NOME EXEMPLO
                      fullNameUniquenessScore: 0.98
                      shortNameUniquenessScore: 0.91
                      newsItems:
                        - title: Notícia de exemplo
                          url: https://www.exemplo.com/noticia
                          publicationDate: "2024-01-15"
                          sentimentAnalysis: NEUTRAL
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                historicoFamiliarPolitico:
                  summary: PF - Histórico familiar político
                  value:
                    result:
                      totalMembers: 10
                      policalMembers: 3
                      currentlyElectedMembers: 2
                      totalDisputedElections: 22
                      totalWonElections: 11
                      highestDisputedPolicalPosition: PRESIDENTE
                      highestHeldPolicalPosition: PRESIDENTE
                      electionsTimeline:
                        - eelationshipType: SELF
                          electionYear: 2022
                          electionType: FEDERAL
                          electionRegion: BRASIL - BR
                          role: PRESIDENTE
                          partyAcronym: PL
                          wasElected: false
                    status:
                      code: 200
                      message: Success
                prestadoresServicoEleitorais:
                  summary: PF - Prestadores de serviço eleitorais
                  value:
                    result:
                      name: BARBOSA REIS
                      partiesThatReceivedProvision:
                        - PSOL
                        - PCB
                      electionProvisionData:
                        - politicianBallotNumber: 5044
                          politicianFullName: ZULMIRA ROZ
                          politicianDocNumber: "232000391"
                          partyName: PSOL
                          provisionRequester: CANDIDATE
                          electionYear: 2018
                          applicationRole: Deputado Federal
                          numberOfProvisions: 4
                          totalProvisionValue: 240
                      minProvisionValue: 78.75
                      maxProvisionValue: 6274
                      avgProvisionValue: 1054.8488
                    status:
                      code: 200
                      message: Success
                dasMeiReceita:
                  summary: PJ - DAS MEI na Receita
                  value:
                    result:
                      periodos:
                        "201707":
                          mensagem: Exemplo de texto
                          mensagem_site: Exemplo de texto
                          url_das: https://www.exemplo.com/exemplo-de-url
                          codigo_barras_das: ""
                          periodo: Julho/2017
                          apurado: Sim
                          situacao: ""
                          principal: ""
                          multas: ""
                          juros: ""
                          total: ""
                          data_vencimento: ""
                          data_acolhimento: ""
                          data_pagamento: ""
                          icms: ""
                          iss: ""
                          inss: ""
                          numero_apuracao: ""
                          numero_das: ""
                          normalizado_principal: 0.0
                          normalizado_multas: 0.0
                          normalizado_juros: 0.0
                          normalizado_total: 0.0
                          normalizado_icms: 0.0
                          normalizado_iss: 0.0
                          normalizado_inss: 0.0
                        "201708":
                          mensagem: Exemplo de texto
                          mensagem_site: Exemplo de texto
                          url_das: https://www.exemplo.com/exemplo-de-url
                          codigo_barras_das: ""
                          periodo: Agosto/2017
                          apurado: Sim
                          situacao: ""
                          principal: ""
                          multas: ""
                          juros: ""
                          total: ""
                          data_vencimento: ""
                          data_acolhimento: ""
                          data_pagamento: ""
                          icms: ""
                          iss: ""
                          inss: ""
                          numero_apuracao: ""
                          numero_das: ""
                          normalizado_principal: 0.0
                          normalizado_multas: 0.0
                          normalizado_juros: 0.0
                          normalizado_total: 0.0
                          normalizado_icms: 0.0
                          normalizado_iss: 0.0
                          normalizado_inss: 0.0
                    status:
                      code: 200
                      message: Success
                enriquecimentoPessoaJuridica:
                  summary: PJ - Enriquecimento de dados
                  value:
                    result:
                      cnpj: "30108283000150"
                      status: ATIVA
                      statusDate: "2022-07-26T00:00:00Z"
                      name: EMPRESA EXEMPLO LTDA
                      country: Brazil
                      fantasyName: EMPRESA EXEMPLO
                      origin: Receita Federal
                      regime: SIMPLES
                      age: 4
                      registrationStatusDate: "2018-04-04T00:00:00Z"
                      foundedDate: "2018-04-04T00:00:00Z"
                      activities:
                        - IsMain: true
                          Code: "6209100"
                          Activity: SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO
                        - IsMain: false
                          Code: "6201501"
                          Activity: DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA
                        - IsMain: false
                          Code: "6201502"
                          Activity: WEB DESIGN
                        - IsMain: false
                          Code: "6202300"
                          Activity: DESENVOLVIMENTO E LICENCIAMENTO DE PROGRAMAS DE COMPUTADOR CUSTOMIZAVEIS
                      legalNatureCode: "2062"
                      legalNatureActivity: SOCIEDADE EMPRESARIA LIMITADA
                      capital: DEZ MIL REAIS
                      capitalRS: "10000.00"
                      nire: ""
                    status:
                      code: 200
                      message: Success
                statusCnpjReceitaFederal:
                  summary: PJ - Status do CNPJ na Receita Federal
                  value:
                    result:
                      cnpj: "30108283000150"
                      status: ATIVA
                      statusDate: "2022-06-26T00:00:00Z"
                      origin: Receita Federal
                    status:
                      code: 200
                      message: Success
                statusCnpjReceitaFederalOnDemand:
                  summary: PJ - CNPJ na Receita Federal on-demand
                  value:
                    result:
                      cnpj: "30108283000150"
                    status:
                      code: 200
                      message: Success
                relacionamentosEmpresa:
                  summary: PJ - Relacionamentos da empresa
                  value:
                    result:
                      cnpj: "99244297000106"
                      isFamilyCompany: false
                      isFamilyEmployees: false
                      relationshipTotal: 1
                      totalOwners: 1
                      totalEmployees: 1
                      totalOwned: 1
                      companyRelationships:
                        - cpf: "77272722314"
                          name: NOME EXEMPLO
                          country: Brazil
                          relationshipName: SOCIO-ADMINISTRADOR
                          relationshipType: REPRESENTANTELEGAL
                          origin: RECEITA FEDERAL
                          relationshipStartDate: "2021-03-01"
                          relationshipEndDate: "2021-03-01"
                    status:
                      code: 200
                      message: Success
                validacaoCnhDatavalid:
                  summary: PF - Validação de CNH no DataValid
                  value:
                    result:
                      cpf: "73583960149"
                    status:
                      code: 200
                      message: Success
                sociosReceitaFederal:
                  summary: PJ - Sócios na Receita Federal
                  value:
                    results:
                      - cpf: "77272722314"
                        name: NOME DO SÓCIO
                        gender: M
                        birthDate: "1984-05-21"
                        age: 40
                        taxIdStatus: REGULAR
                        taxIdOrigin: RECEITA FEDERAL
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                doacoesEleitoraisPj:
                  summary: PJ - Doações eleitorais
                  value:
                    result:
                      cnpj: "12345678000190"
                      electoralDonors:
                        totalDonationsAmount: 3
                        totalDonatedValue: 15000
                        partiesThatReceivedDonation:
                          - MDB
                          - PSDB
                        electionDonationData:
                          - electionYear: "2022"
                            partyName: MDB
                            donationsAmount: "2"
                            totalDonationValue: 10000
                            isCrowdfunding: false
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                doacoesEleitoraisSocios:
                  summary: PJ - Doações eleitorais dos sócios
                  value:
                    result:
                      cnpj: "12345678000190"
                      ownersElectoralDonors:
                        - ownerDocNumber: "123***78901"
                          ownerName: SOCIO EXEMPLO
                          totalDonationsAmount: 2
                          totalDonatedValue: 5000
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                fornecedoresEleitoraisPj:
                  summary: PJ - Fornecedores eleitorais
                  value:
                    result:
                      cnpj: "12345678000190"
                      electoralProviders:
                        name: EMPRESA EXEMPLO LTDA
                        partiesThatReceivedProvision:
                          - PSOL
                        electionProvisionData:
                          - politicianFullName: CANDIDATO EXEMPLO
                            partyName: PSOL
                            electionYear: 2022
                            numberOfProvisions: 4
                            totalProvisionValue: 2400
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                sintegra:
                  summary: PJ - SINTEGRA
                  value:
                    result:
                      cnpj: "30108283000000"
                      status: NOT REGISTERED
                      uf: DF
                      cfdf: "0785286100111"
                      origin: Sintegra
                    status:
                      code: 200
                      message: Success
                sociosPrimeiroNivel:
                  summary: PJ - Sócios de primeiro nível
                  value:
                    result:
                      cnpj: "99244297000106"
                      circleType: FIRST_LEVEL_OWNERS
                      totalEntities: 2
                      totalDistinctAddresses: 11
                      totalDistinctPhones: 7
                      totalDistinctEmails: 7
                      totalEmployedEntities: 2
                      totalCompaniesOwned: 4
                      totalRelatedEntities: 4
                      totalPEPs: 0
                      totalPublicServants: 0
                      totalClassMember: 0
                      totalLivingPeople: 2
                      totalDeceasedPeople: 0
                      minAge: 28
                      maxAge: 38
                      avgAge: 33
                      circleTotalIncomeRange: ACIMA DE 20 SM
                      entitiesAvgIncomeRange: 10 A 20 SM
                      entitiesMaxIncomeRange: 10 A 20 SM
                      entitiesMinIncomeRange: 4 A 10 SM
                      minEducationLevel: SEM INFORMACAO
                      avgEducationLevel: 6 A 9 FUND
                      maxEducationLevel: MEDIO COMPL
                      avgGeographicDistance: 11490.88926949
                      maxGeographicDistance: 22580.48025219
                      minGeographicDistance: 401.29828679
                      maxEShopperLevel: A
                      totalEShopperLevel: A
                      minEShopperLevel: A
                      maxESellerLevel: D
                      minESellerLevel: H
                      totalESellerLevel: F
                      totalLawSuits: 0
                      totalLawSuitsAsDefendant: 0
                      totalLawSuitsAsAuthor: 0
                      totalPassages: 50
                      totalBadPassages: 4
                      monthAveragePassages: 50
                      firstPassageDate: "0001-01-01T00:00:00"
                      lastPassageDate: "0001-01-01T00:00:00"
                      last3MonthsPassages: -3
                      last6MonthsPassages: -3
                      last12MonthsPassages: -3
                      last18MonthsPassages: -3
                      genderDistribution:
                        U: 0
                        F: 0
                        M: 2
                      ageRangeDistribution:
                        "30-40": 1
                        "25-30": 1
                        "SEM INFORMACAO": 0
                      incomeRangeDistribution:
                        "4 A 10 SM": 1
                        "10 A 20 SM": 1
                        "SEM INFORMACAO": 0
                      educationLevelDistribution:
                        "MEDIO COMPL": 1
                        "SEM INFORMACAO": 1
                      stateDistribution:
                        DF: 1
                        SP: 0
                        RJ: 0
                        BA: 0
                      eShopperDistribution:
                        A: 2
                        B: 0
                        C: 0
                      eSellerDistribution:
                        D: 1
                        H: 1
                      taxIdStatusDistribution:
                        Regular: 2
                    status:
                      code: 200
                      message: Success
                processosJuridicosSocios:
                  summary: PJ - Processos jurídicos dos sócios
                  value:
                    result:
                      totalLawsuitsOwners: 2
                      totalLawsuitsReplaceOwners: 0
                      totalLawsuitsAsAuthorOwners: 1
                      totalLawsuitsAsOtherOwners: 0
                      avgLawsuitsOwners: 0
                      lawSuitsOwners:
                        "00365142506":
                          Lawsuits:
                            - Number: ""
                              Type: ""
                              CourtType: L
                              Value: 53200
                              Parties:
                                - Doc: cpf
                                  IsPartyActive: true
                                  Name: NOME EXEMPLO
                                  Polarity: ACTIVE
                                  Type: AUTHOR
                          TotalLawsuits: 2
                          TotalLawsuitsAsAuthor: 1
                          TotalLawsuitsAsDefendant: 1
                          TotalLawsuitsAsOther: 0
                    status:
                      code: 200
                      message: Success
                kycComplianceSocios:
                  summary: PJ - KYC e compliance dos sócios
                  value:
                    result:
                      cnpj: "12345678000190"
                      totalCurrentPep: 1
                      totalHistoricallyPEP: 1
                      totalCurrentSanctioned: 1
                      totalHistoricallySanctioned: 1
                      averageSanctionsPerOwner: 1
                      pepPercentage: 50.0
                      activeOwners:
                        - "11122233344"
                        - "55566677788"
                      kycOwners:
                        - cpf: "11122233344"
                          isPep: true
                          isCurrentlySanctioned: true
                          wasPreviouslySanctioned: true
                          sanctionsHistory:
                            - source: interpol
                              type: RED_NOTICE
                              matchRate: 96
                          highConfidenceSanctionsHistory:
                            - source: interpol
                              type: RED_NOTICE
                              matchRate: 96
                        - cpf: "55566677788"
                          isPep: false
                          isCurrentlySanctioned: false
                          wasPreviouslySanctioned: false
                          sanctionsHistory: []
                          highConfidenceSanctionsHistory: []
                    status:
                      code: 200
                      message: Success
                exposicaoPerfilMidiaPj:
                  summary: PJ - Exposição e perfil na mídia dos sócios
                  value:
                    results:
                      - cpf: "12345678901"
                        mediaExposureLevel: MEDIUM
                        celebrityLevel: LOW
                        unpopularityLevel: LOW
                        fullName: NOME EXEMPLO
                        shortName: NOME EXEMPLO
                        fullNameUniquenessScore: 0.98
                        shortNameUniquenessScore: 0.91
                        newsItems:
                          - title: Notícia de exemplo
                            url: https://www.exemplo.com/noticia
                            publicationDate: "2024-01-15"
                            sentimentAnalysis: NEUTRAL
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                enderecosEstendidosEmpresa:
                  summary: PJ - Endereços estendidos
                  value:
                    result:
                      cnpj: "30108283000150"
                      addresses:
                        - address: AVENIDA EXEMPLO
                          number: "1000"
                          neighborhood: CENTRO
                          city: SAO PAULO
                          state: SP
                          country: BRASIL
                          zipcode: "01001000"
                          addressType: COMMERCIAL
                          isActive: "true"
                          isMainForEntity: "true"
                      addressesExtendedTotal: 1
                      addressesExtendedTotalActive: 1
                      addressesExtendedOldestPassageDate: "2018-02-10"
                      addressesExtendedNewestPassageDate: "2026-05-12"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                debitosAtivosPj:
                  summary: PJ - Débitos ativos
                  value:
                    result:
                      totalDebtValue: 0
                      totalDebtValuePerOrigin: {}
                      totalDebts: 0
                      totalDebtsPerOrigin: {}
                      debts:
                        - source: Fonte
                          debtOrigin: Origem
                          consolidatedValue: Valor
                          responsibleUnity: Unidade
                          responsibleUnityUF: UF
                          registrationNumber: "1234"
                          registrationSituationType: divida
                          registrationSituation: ativo
                    status:
                      code: 200
                      message: Success
                complianceCasasApostasPj:
                  summary: PJ - Compliance de casas de apostas
                  value:
                    result:
                      cnpj: "00000000000000"
                      status: ATIVA
                      statusDate: "2024-06-08"
                      origin: Receita Federal
                      age: 6
                      foundedDate: "2018-04-04T00:00:00Z"
                      taxIdCountry: Brazil
                      officialName: NOME OFICIAL ANONIMIZADO
                      tradeName: NOME FANTASIA ANONIMIZADO
                      isHeadquarter: true
                      isConglomerate: false
                      taxRegime: SIMPLES
                      taxIdStatusRegistrationDate: "2018-04-04T00:00:00Z"
                      taxRegimes: SIMPLES
                      activities:
                        - IsMain: true
                          Code: "6209100"
                          Activity: SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO
                        - IsMain: false
                          Code: "6201501"
                          Activity: DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA
                        - IsMain: false
                          Code: "6201502"
                          Activity: WEB DESIGN
                      isBet: false
                      onlineBettingCompliance:
                        - SportsExposure:
                            Sports:
                              - SportName: SO**ER
                                Region: BRAZIL
                                TotalRelatedEntities: 1
                                RelatedEntities:
                                  - DocNumber: "00000000000000"
                                    DocType: CPF
                                    RelationshipLevel: BUSINESS PARTNER
                                    InstitutionName: INSTITUICAO ANONIMIZADA
                                    InstitutionActivity: CLUBES SOCIAIS, ESPORTIVOS E SIMILARES
                                    Role: MANAGER
                                    IsActive: true
                                    StartDate: "0001-01-01T00:00:00"
                                    EndDate: "9999-12-31T23:59:59.9999999"
                                    Source: FONTE ANONIMIZADA
                          ForbiddenBet:
                            Name: NOME ANONIMIZADO
                            Age: "30"
                            IsFromMinisterioDaFazenda: false
                            IsBookmakerOwner: false
                            BookmakerOwnerMotives:
                              - Source: SIGAP
                                CNPJ: "00000000000000"
                                CompanyName: EMPRESA ANONIMIZADA
                                EconomicActivityCodes: 6463800;7319004;9200399
                                AdditionalDetails:
                                  SIGAPApplicationNumber: 000**024
                                  SIGAPRegistrationDate: "2024-05-26 22:35:16"
                            MinisterioDaFazendaMotives: {}
                        - SportsExposure:
                            Sports: []
                          ForbiddenBet:
                            Name: NOME ANONIMIZADO
                            Age: "40"
                            IsFromMinisterioDaFazenda: false
                            IsBookmakerOwner: false
                            BookmakerOwnerMotives: []
                            MinisterioDaFazendaMotives: {}
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                    externalId: 8e1ac243-4510-4ebf-ac7d-4b6d133dd619
                certidaoNegativaProtesto:
                  summary: PF - Certidão negativa de protesto
                  value:
                    result:
                      cpf: "77272722134"
                      protestos:
                        - cartorio: CARTÓRIO LARANJEIRAS - 32º OFÍCIO DE NOTAS DO RIO DE JANEIRO
                          cidade: RIO DE JANEIRO
                          quantidadeTitulos: ""
                          endereco: R. DAS LARANJEIRAS - LARANJEIRAS, RIO DE JANEIRO - RJ, 22221-060
                          telefone: 19 3396-2809
                          protestos:
                            - cpfCnpj: "00000000000000"
                              data: "2017-10-10"
                              dataProtesto: "2017-10-10"
                              dataVencimento: ""
                              valor: 9.900,00
                            - cpfCnpj: "00000000000000"
                              data: "2018-01-01"
                              dataProtesto: "2018-01-01"
                              dataVencimento: ""
                              valor: 16.000,00
                    status:
                      code: 200
                      message: Success
                processosJuridicosAdministrativos:
                  summary: PF - Processos jurídicos e administrativos
                  value:
                    result:
                      processes:
                        - cpf: ""
                          numberLegalProcess: ""
                          trialCourt: ""
                          processDate: ""
                          mainSubjectProcess: ""
                          classification: ""
                          relatedParties: ""
                    status:
                      code: 200
                      message: Success
                servidoresPublicos:
                  summary: PF - Servidores públicos
                  value:
                    result:
                      totalPublicPositions: 6
                      inServiceServices: 0
                      income: 0
                      isCurrentlyPublicServant: false
                      professionalHistory: []
                    status:
                      code: 400
                      message: Failed to fetch information
                consultaEnderecos:
                  summary: PF - Endereços
                  value:
                    result:
                      addresses:
                        - zipcode: ""
                          country: BRASIL
                          address: ""
                          city: SALVADOR
                          addressType: HOME
                          neighborhood: GRACA
                          state: BA
                    status:
                      code: 200
                      message: Success
                historicoTelefones:
                  summary: PF - Histórico de telefones
                  value:
                    result:
                      cpf: "80246074507"
                      phones:
                        - number: "(61) 98235-8585"
                          type: Celular
                          isRecent: "true"
                        - number: "(61) 3234-0000"
                          type: Fixo
                          isRecent: "false"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                pessoasRelacionadas:
                  summary: PF - Pessoas relacionadas
                  value:
                    result:
                      cpf: "80246074507"
                      relatedPeople:
                        - cpf: "123***78901"
                          name: NOME DA PESSOA RELACIONADA
                          relationship: Mae
                        - cpf: "987***32100"
                          name: OUTRA PESSOA RELACIONADA
                          relationship: Irmao
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                historicoEmails:
                  summary: PF - Histórico de e-mails
                  value:
                    results:
                      - emailAddress: usuario@example.com
                        domain: example.com
                        userName: usuario
                        type: PERSONAL
                        isMainForEntity: true
                        isRecentForEntity: true
                        validationStatus: VALID
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                relacionamentosEconomicos:
                  summary: PF - Relacionamentos econômicos
                  value:
                    result: {}
                    status:
                      code: 200
                      message: Success
                historicoProfissional:
                  summary: PF - Histórico profissional
                  value:
                    result:
                      professionalHistory:
                        - endDate: "2007-12-23"
                          companyName: CRN CURSOS PROFISSIONALIZANTES LTDA
                          cnpj: "05731652000209"
                          classification: EMPLOYEE
                          sector: PRIVATE - 8599604 - TREINAMENTO EM DESENVOLVIMENTO PROFISSIONAL E GERENCIAL
                          startDate: "2004-02-10"
                    status:
                      code: 200
                      message: Success
                certidaoNegativaProtestoPj:
                  summary: PJ - Certidão negativa de protesto
                  value:
                    result:
                      cnpj: "77272722134"
                      protestos:
                        - cartorio: CARTÓRIO LARANJEIRAS - 32º OFÍCIO DE NOTAS DO RIO DE JANEIRO
                          cidade: RIO DE JANEIRO
                          quantidadeTitulos: ""
                          endereco: R. DAS LARANJEIRAS - LARANJEIRAS, RIO DE JANEIRO - RJ, 22221-060
                          telefone: 19 3396-2809
                          protestos:
                            - cpfCnpj: "00000000000000"
                              data: "2017-10-10"
                              dataProtesto: "2017-10-10"
                              dataVencimento: ""
                              valor: 9.900,00
                            - cpfCnpj: "00000000000000"
                              data: "2018-01-01"
                              dataProtesto: "2018-01-01"
                              dataVencimento: ""
                              valor: 16.000,00
                    status:
                      code: 200
                      message: Success
                scoreCreditoPj:
                  summary: PJ - Score de Crédito PJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                scoreCreditoMultidadosPj:
                  summary: PJ - Score de Crédito Multidados PJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                dadosRestritivosPj:
                  summary: PJ - Dados Restritivos PJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                flagsNegativosPj:
                  summary: PJ - Flags Negativos PJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      riskLevel: "BAIXO"
                      riskClassification: "A"
                      hasRestrictions: false
                      negativeFlagsCount: 0
                      creditBureauSummary: "Nenhum flag negativo encontrado"
                      creditBureauDetails: {}
                      origin: "Quod"
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                scoreCreditoQuantumPj:
                  summary: PJ - Score de Crédito Quantum PJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      score: 690
                      creditBureauSummary: "Score de crédito dentro da média do setor"
                      creditBureauDetails: {}
                      origin: "Quantum"
                      queryDate: "2026-08-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                beneficiariosFinais:
                  summary: PJ - Beneficiários Finais
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: "30108283000150"
                          percentage: 45.5
                          level: 1
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                percentualParticipacaoSocietaria:
                  summary: PJ - Percentual de Participação Societária
                  value:
                    result:
                      cnpj: "30108283000150"
                      numberOfOwners: 2
                      numberOfPeopleAsOwners: 1
                      numberOfCompaniesAsOwners: 1
                      hasMajorityStakeHolder: true
                      averageParticipationPercentage: 50.0
                      maxParticipationPercentage: 70.0
                      minParticipationPercentage: 30.0
                      firstOwnerEntryDate: "2015-03-01"
                      lastOwnerEntryDate: "2022-06-15"
                      ownerParticipationSummary: Consulta realizada
                      ownerParticipations:
                        - ownerDocument: "00000000000"
                          ownerName: NOME DO SOCIO
                          percentage: 70.0
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                projetosPublicos:
                  summary: PJ - Projetos Públicos
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalPublicProjects: 1
                      publicProjectsSummary: Consulta realizada
                      publicProjects:
                        - source: BNDES
                          modality: FINANCIAMENTO
                          contractedValue: 500000
                          disbursedValue: 250000
                          contractDate: "2025-01-10"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                obrasCivis:
                  summary: PJ - Obras Civis
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalCivilConstructionRecords: 2
                      totalActiveCivilConstructionRecords: 1
                      civilConstructionSummary: Consulta realizada
                      civilConstructionRecords:
                        - cno: "00000000000"
                          status: ATIVA
                          address: RUA EXEMPLO, 100
                          startDate: "2025-01-01"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                debitosPgfn:
                  summary: PJ - Débitos com a PGFN
                  value:
                    result:
                      cnpj: "30108283000150"
                      pgfnSummary: Consulta realizada
                      pgfnBaseStatus: NEGATIVA
                      pgfnClearance: Sim
                      pgfnEmissionDate: "2026-08-01"
                      pgfnCertificateUrl: "https://example.com/certidao-pgfn.pdf"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                cotaPcd:
                  summary: PJ - Cota de PCD
                  value:
                    result:
                      cnpj: "30108283000150"
                      pcdSummary: Consulta realizada
                      pcdBaseStatus: EM CONFORMIDADE
                      pcdExpeditionDate: "2026-08-01"
                      pcdCertificateUrl: "https://example.com/certidao-pcd.pdf"
                      pcdContent: Texto integral da certidão de cota de PCD
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                certidaoCgu:
                  summary: PJ - Certidão Negativa Correcional CGU
                  value:
                    result:
                      cnpj: "30108283000150"
                      cguSummary: Consulta realizada
                      cguBaseStatus: NEGATIVA
                      cguClearance: Sim
                      cguValidUntil: "2027-08-01"
                      cguIssueDate: "2026-08-01"
                      cguCertificateUrl: "https://example.com/certidao-cgu.pdf"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                certidaoCnj:
                  summary: PJ - Certidão Negativa CNJ
                  value:
                    result:
                      cnpj: "30108283000150"
                      cnjSummary: Consulta realizada
                      cnjBaseStatus: NEGATIVA
                      cnjClearance: Sim
                      cnjIssueDate: "2026-08-01"
                      cnjCertificateUrl: "https://example.com/certidao-cnj.pdf"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                certidaoDebitosEstaduais:
                  summary: PJ - Certidão Negativa de Débitos Estaduais
                  value:
                    result:
                      cnpj: "30108283000150"
                      stateDebtSummary: Consulta realizada
                      stateDebtBaseStatus: NEGATIVA
                      stateDebtClearance: Sim
                      stateDebtState: SP
                      stateDebtRegistration: "000.000.000.000"
                      stateDebtValidUntil: "2027-08-01"
                      stateDebtCertificateUrl: "https://example.com/certidao-debitos-estaduais.pdf"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                optanteSimples:
                  summary: PJ - Optante pelo Simples Nacional
                  value:
                    result:
                      cnpj: "30108283000150"
                      simplesSummary: Consulta realizada
                      simplesOfficialName: NOME OFICIAL DA EMPRESA
                      simplesNationalStatus: OPTANTE
                      simplesMeiStatus: NAO OPTANTE
                      simplesCertificateUrl: "https://example.com/comprovante-simples.pdf"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                kycGrupoEconomico:
                  summary: PJ - KYC e Compliance do Grupo Econômico
                  value:
                    result:
                      cnpj: "30108283000150"
                      economicGroupKycSummary: Consulta realizada
                      economicGroupTotalCurrentPep: "0"
                      economicGroupTotalHistoricalPep: "1"
                      economicGroupTotalCurrentSanctioned: "0"
                      economicGroupTotalHistoricalSanctioned: "0"
                      economicGroupAverageSanctions: "0"
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                relacionamentosGrupoEconomico:
                  summary: PJ - Relacionamentos do Grupo Econômico
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalEconomicGroupRelationships: 3
                      economicGroupRelationshipsSummary: "Empresa possui 3 relacionamentos de grupo econômico"
                      economicGroupRelationships: []
                      economicGroupCurrentRelationships: []
                      economicGroupHistoricalRelationships: []
                      economicGroupRelationshipsStats: {}
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                avaliacoesReputacao:
                  summary: PJ - Avaliações e Reputação
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalReputationSources: 2
                      reputationSummary: "Empresa possui avaliações em 2 plataformas"
                      reputationAndReviews: []
                      reputationSummaryDetails: {}
                      reputationSummaryByDataSources: {}
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                dadosFundosInvestimento:
                  summary: PJ - Dados de Fundos de Investimento
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalMovimentations: 0
                      investmentFundDataSummary: "Nenhuma movimentação de fundo de investimento encontrada"
                      investmentFundData: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                influenciaQuadroSocietario:
                  summary: PJ - Influência do Quadro Societário
                  value:
                    result:
                      cnpj: "30108283000150"
                      influenceScore: 0
                      ownersInfluenceSummary: "Baixa influência do quadro societário"
                      ownersInfluence: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                arrecadacaoSimplesMei:
                  summary: PJ - Arrecadação Simples Nacional - MEI
                  value:
                    result:
                      cnpj: "30108283000150"
                      pgmeiStatus: "Optante"
                      pgmeiReferenceYear: "2026"
                      pgmeiPendingGuides: 0
                      pgmeiSummary: "MEI optante e regular no ano de referência"
                      pgmeiGuides: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                fgtsRegularidade:
                  summary: PJ - FGTS
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                marketplaces:
                  summary: PJ - Marketplaces
                  value:
                    result:
                      cnpj: "30108283000150"
                      totalMarketplacesUsed: 1
                      totalStoresOperated: 1
                      marketplaceWithMostProducts: "Mercado Livre"
                      marketplaceWithBestRating: "Mercado Livre"
                      totalProductsListed: 0
                      marketplaceSummary: "Empresa presente em 1 marketplace"
                      marketplaceDetails: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                anunciosOnline:
                  summary: PJ - Anúncios Online
                  value:
                    result:
                      cnpj: "30108283000150"
                      onlineAdsTotalPhones: 0
                      onlineAdsSummary: "Nenhum anúncio online encontrado"
                      onlineAds: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                receitaFederalQsa:
                  summary: PJ - Receita Federal - QSA
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                distribuicaoProcessosSocios:
                  summary: PJ - Distribuição de Processos dos Sócios
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                distribuicaoProcessosJudiciais:
                  summary: PJ - Distribuição de Processos Judiciais
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                acoesTrabalhistas:
                  summary: PJ - Ações Trabalhistas
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                kycComplianceFuncionarios:
                  summary: PJ - KYC e Compliance dos Funcionários
                  value:
                    result:
                      cnpj: "30108283000150"
                      employeesKycTotalEmployees: 5
                      employeesKycCurrentlyPepCount: 0
                      employeesKycCurrentlySanctionedCount: 0
                      employeesKycPreviouslySanctionedCount: 0
                      employeesKycFlaggedCount: 0
                      employeesKycSummary: "Nenhum funcionário sinalizado como PEP ou sancionado"
                      employeesKycFlagged: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                historicoDadosBasicos:
                  summary: PJ - Histórico de Dados Básicos
                  value:
                    result:
                      cnpj: "30108283000150"
                      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: Consulta de API Realizada com Sucesso
                categoriaComercial:
                  summary: PJ - Categoria Comercial
                  value:
                    result:
                      cnpj: "30108283000150"
                      merchantCategoryHasDirectAssociation: "false"
                      merchantCategoryHasMultipleCodes: "false"
                      merchantCategorySummary: "Categoria comercial inferida pelo CNAE"
                      merchantCategoryCategories: []
                      merchantCategoryCnaeCategories: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                acordosSindicais:
                  summary: PJ - Acordos Sindicais
                  value:
                    result:
                      cnpj: "30108283000150"
                      syndicateAgreementsTotal: 1
                      syndicateAgreementsTotalActive: 1
                      syndicateAgreementsSummary: "Empresa com 1 acordo sindical ativo"
                      syndicateAgreementsStats: []
                      syndicateAgreements: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                telefonesEmpresa:
                  summary: PJ - Telefones
                  value:
                    result:
                      cnpj: "30108283000150"
                      phonesExtendedCompanyTotal: 2
                      phonesExtendedCompanyTotalActive: 1
                      phonesExtendedCompanySummary: "Empresa com 2 telefones encontrados, 1 ativo"
                      phonesExtendedCompanyStats: []
                      phonesExtendedCompany: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                evolucaoEmpresa:
                  summary: PJ - Evolução da Empresa
                  value:
                    result:
                      cnpj: "30108283000150"
                      companyEvolutionSummary: "Empresa com tendência de crescimento estável"
                      companyEvolutionStats: []
                    status:
                      code: 200
                      message: Consulta de API Realizada com Sucesso
                informacoesFinanceiras:
                  summary: PF - Informações financeiras
                  value:
                    status:
                      code: 200
                      message: Success
                dadosPis:
                  summary: PF - Dados PIS
                  value:
                    status:
                      code: 200
                      message: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/InvalidService'
        '500':
          $ref: '#/components/responses/ExternalSourceError'

  /api/customer:
    get:
      tags:
        - Customers
      summary: Consultar cliente
      description: |
        Consulta clientes cadastrados a partir de CPF ou CNPJ informado em
        `documentKey`.

        Use este endpoint para verificar se um cliente já existe, recuperar seu
        `tokenCustomer` e consultar o status atual de ativação.
      security:
        - bearerAuth: []
      parameters:
        - name: documentKey
          in: query
          required: true
          description: CPF ou CNPJ do cliente.
          schema:
            type: string
          example: cpf ou cnpj
      responses:
        '200':
          description: Cliente encontrado.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
              example:
                - tokenCustomer: c65449cd-5ce5-40b8-9aa4-0726b118f73e
                  type: PF
                  documentKey: c65449cd-5ce5-40b8-9aa4-0726b118f73e
                  name: NOME DO CLIENTE
                  addInformation: Cliente cadastrado via integração
                  active: false
                  imageUrl: https://exemplo.com/imagem-cliente.jpg
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

  /api/changeStatusOfCustomer:
    post:
      tags:
        - Customers
      summary: Alterar status de cliente
      description: |
        Altera o status ativo ou inativo de um ou mais clientes.

        Envie uma lista de objetos com `documentKey` e `active`. Use `active:
        true` para ativar e `active: false` para desativar o cliente.
      security:
        - bearerAuth: []
      requestBody:
        description: Lista de clientes que devem ter o status alterado.
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ChangeCustomerStatusRequest'
            example:
              - documentKey: c65449cd-5ce5-40b8-9aa4-0726b118f73e
                active: false
      responses:
        '200':
          description: Status alterado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericStatusResponse'
              example:
                status:
                  code: 200
                  message: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  responses:
    BadRequest:
      description: Payload inválido, parâmetro ausente ou falha técnica no processamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status:
              code: 400
              message: Failed to fetch information
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status:
              code: 401
              message: Unauthorized
    Forbidden:
      description: Credenciais válidas, mas sem permissão para executar a operação ou serviço.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status:
              code: 403
              message: Forbidden
    InvalidService:
      description: Serviço inexistente, não habilitado ou informado com grafia incorreta.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            serviceAusente:
              summary: Campo service ausente
              value:
                result: {}
                status:
                  code: 400
                  message: Campo service é obrigatório.
            serviceInvalido:
              summary: Service não reconhecido
              value:
                result: {}
                status:
                  code: 400
                  message: Serviço não disponível para este cliente.
    ExternalSourceError:
      description: Falha temporária ou técnica na fonte externa consultada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            result: {}
            status:
              code: 500
              message: Failed to fetch information

  schemas:
    TokenRequest:
      type: object
      description: Credenciais da aplicação usadas para gerar token JWT.
      required:
        - client
        - secret
      properties:
        client:
          type: string
          description: Identificador da aplicação fornecido previamente.
        secret:
          type: string
          description: Segredo da aplicação fornecido previamente.

    TokenResponse:
      type: object
      description: Resposta da geração de token.
      properties:
        access_token:
          type: string
          description: Token JWT usado no header `Authorization`.
        expires_in:
          type: string
          description: Tempo de expiração do token em segundos.

    TokenOnboardingRequest:
      type: object
      properties:
        document:
          type: string
          description: CPF ou CNPJ usado no onboarding.
        cpf:
          type: string
        cnpj:
          type: string
        name:
          type: string
        documentFiles:
          type: array
          items:
            type: object
            properties:
              documentFileType:
                type: string
                enum:
                  - RG_FRONT
                  - RG_BACK
                  - CNH
                  - SELFIE
                  - SELFIE_3D
                  - OAB_FRONT
                  - OAB_BACK
                  - OTHER
                  - OTHER_SINGLE_FILE
              document:
                type: string
                description: Arquivo em base64.
              documentUrl:
                type: string
                description: URL do arquivo.

    TokenOnboardingResponse:
      type: object
      properties:
        tokenOnboarding:
          type: string
          description: UUID do onboarding.
        dateHourProcess:
          type: string
          description: Data e hora de criação do TokenOnboarding.

    OnboardingReportResponse:
      type: object
      properties:
        tokenOnboarding:
          type: string
        createdDate:
          type: string
        numberSteps:
          type: integer
        status:
          type: string
          enum:
            - APPROVED
            - IN_PROCESS
            - REFUSED
        result:
          type: string
          enum:
            - AUT_APPROVED
            - IN_PROCESS
            - REFUSED
        fields:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingField'
        services:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingService'

    OnboardingField:
      type: object
      properties:
        field:
          type: string
        name:
          type: string
        step:
          type: string
        value:
          type: string

    OnboardingService:
      type: object
      properties:
        serviceName:
          type: string
        createdDate:
          type: string
        status:
          type: string
        statusMessage:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingField'
        rules:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string

    ServiceApiRequest:
      type: object
      description: |
        Payload base do endpoint `/api/service-api`. O campo `service` define qual
        produto será executado; os demais campos são dinâmicos e dependem do
        serviço escolhido.

        Famílias principais:

        - Cadastro e identidade PF
        - Documentos e biometria
        - Risco, validações e compliance PF
        - Político e eleitoral
        - Cadastro e regularidade PJ
        - Sócios, relacionamentos e compliance PJ
      required:
        - service
      additionalProperties: true
      properties:
        service:
          type: string
          description: Código do serviço que será executado.
          example: SERVICE_PERSON_DATA_ENRICHMENT
        cpf:
          type: string
          description: CPF usado em consultas de pessoa física.
          example: cpf
        cnpj:
          type: string
          description: CNPJ usado em consultas de pessoa jurídica.
          example: cnpj
        email:
          type: string
          description: E-mail usado na validação de endereço eletrônico.
          example: email@email.com
        phone:
          type: string
          description: Telefone usado em consultas e validações de contato.
          example: "11900000000"
        zipcode:
          type: string
          description: CEP usado em validações de endereço.
          example: 00000-000
        numberAddress:
          type: string
          description: Número do endereço usado em validações de residência.
          example: "13"
        uf:
          type: string
          description: Unidade federativa quando o serviço exigir recorte estadual.
          example: SP
        image1:
          type: string
          description: Imagem em base64 ou conteúdo principal para serviços de OCR, biometria e FaceMatch.
          example: base64
        image2:
          type: string
          description: Segunda imagem em base64, quando o serviço exigir comparação ou verso de documento.
          example: base64
        image1Url:
          type: string
          description: URL da primeira imagem, quando a integração usa arquivo hospedado.
          example: url_image
        image2Url:
          type: string
          description: URL da segunda imagem, quando a integração usa arquivo hospedado.
          example: urlImageMatch
        selfie1:
          type: string
          description: Selfie em base64 usada em documentoscopia ou comparação facial.
          example: base64
        key:
          type: string
          description: Chave de consulta usada em serviços assíncronos, como documentoscopia digital.
          example: de0cd562-5962-40bd-8f94-5a7184ecde0e
        nit:
          type: string
          description: Número de identificação do trabalhador, quando aplicável.

    ServiceApiResponse:
      type: object
      description: |
        Resposta padrão dos serviços externos. O objeto `result` muda conforme
        o serviço executado, e `status` informa o resultado técnico da consulta.

        Schemas de apoio para os principais retornos estão documentados nos
        componentes desta referência, como `PersonDataEnrichmentResult`,
        `RfbPfResult`, `OcrDocumentResult`, `FaceMatchResult`, `PepResult`,
        `CorporateDataEnrichmentResult`, `RfbPjResult` e `ActiveDebtResult`.
      additionalProperties: true
      properties:
        result:
          type: object
          description: Dados de negócio retornados pela consulta.
          additionalProperties: true
        status:
          $ref: '#/components/schemas/StatusResponse'
        externalId:
          type: string
          description: Identificador externo da consulta, quando retornado.

    StatusResponse:
      type: object
      description: Status técnico comum nas respostas da API.
      properties:
        code:
          type: integer
          description: Código técnico do processamento.
          example: 200
        message:
          type: string
          description: Mensagem técnica do processamento.
          example: Success

    GenericStatusResponse:
      type: object
      description: Resposta genérica com status técnico.
      properties:
        status:
          $ref: '#/components/schemas/StatusResponse'

    ErrorResponse:
      type: object
      description: Resposta de erro técnico ou falha de processamento.
      properties:
        result:
          type: object
          nullable: true
          additionalProperties: true
          description: Dados parciais retornados, quando existirem.
        status:
          $ref: '#/components/schemas/StatusResponse'
        externalId:
          type: string
          description: Identificador externo da consulta, quando retornado.

    Customer:
      type: object
      description: Cliente cadastrado na base idCerberus.
      properties:
        tokenCustomer:
          type: string
          description: Token identificador do cliente.
        type:
          type: string
          nullable: true
          description: Tipo do cliente, quando disponível.
        documentKey:
          type: string
          description: CPF ou CNPJ usado como chave do cliente.
        name:
          type: string
          nullable: true
          description: Nome do cliente, quando disponível.
        addInformation:
          type: string
          nullable: true
          description: Informação adicional vinculada ao cliente.
        active:
          type: boolean
          description: Indica se o cliente está ativo.
        imageUrl:
          type: string
          nullable: true
          description: URL de imagem vinculada ao cliente, quando disponível.

    PersonDataEnrichmentResult:
      type: object
      description: Resultado do enriquecimento de dados de pessoa física.
      properties:
        cpf:
          type: string
        status:
          type: string
        statusDate:
          type: string
        name:
          type: string
        gender:
          type: string
        fatherName:
          type: string
        motherName:
          type: string
        birthdate:
          type: string
        birthCountry:
          type: string
        dead:
          type: boolean
        country:
          type: string
        fiscalRegion:
          type: string
        age:
          type: integer

    RfbPfResult:
      type: object
      description: Resultado da consulta de CPF na Receita Federal.
      properties:
        cpf:
          type: string
        status:
          type: string
        name:
          type: string
        birthDate:
          type: string
        dead:
          type: boolean
        origin:
          type: string
        age:
          type: integer

    OcrDocumentResult:
      type: object
      description: Resultado de OCR de documento.
      properties:
        cpf:
          type: string
        name:
          type: string
        fatherName:
          type: string
        motherName:
          type: string
        birthdate:
          type: string
        cnhCategory:
          type: string
        cnhNumber:
          type: string
        expeditionDate:
          type: string
        rg:
          type: string
        rgUf:
          type: string
        doc:
          type: string
        side:
          type: string
        validDate:
          type: string

    FaceMatchResult:
      type: object
      description: Resultado da comparação facial entre duas imagens.
      properties:
        status:
          type: string
        similarity:
          type: number
          format: float

    PepResult:
      type: object
      description: Resultado da consulta de Pessoa Politicamente Exposta.
      properties:
        cpf:
          type: string
        status:
          type: string

    CorporateDataEnrichmentResult:
      type: object
      description: Resultado do enriquecimento de dados de pessoa jurídica.
      properties:
        cnpj:
          type: string
        status:
          type: string
        statusDate:
          type: string
        name:
          type: string
        country:
          type: string
        fantasyName:
          type: string
        origin:
          type: string
        regime:
          type: string
        age:
          type: integer
        foundedDate:
          type: string
        legalNatureCode:
          type: string
        legalNatureActivity:
          type: string
        capitalRS:
          type: string

    RfbPjResult:
      type: object
      description: Resultado da consulta de CNPJ na Receita Federal.
      properties:
        cnpj:
          type: string
        status:
          type: string
        statusDate:
          type: string
        origin:
          type: string

    ActiveDebtResult:
      type: object
      description: Resultado de consulta de débitos ativos.
      properties:
        totalDebtValue:
          type: number
        totalDebts:
          type: integer
        debts:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              debtOrigin:
                type: string
              consolidatedValue:
                type: string
              responsibleUnity:
                type: string
              responsibleUnityUF:
                type: string
              registrationNumber:
                type: string
              registrationSituationType:
                type: string
              registrationSituation:
                type: string

    ChangeCustomerStatusRequest:
      type: object
      required:
        - documentKey
        - active
      properties:
        documentKey:
          type: string
          description: Identificador do cliente.
        active:
          type: boolean
          description: Define se o cliente deve ficar ativo ou inativo.
```