Estrutura do Relatório

Objeto Relatório

Todo relatório retornado pela API tem a seguinte estrutura raiz:

Campo	Tipo	Descrição
`id`	string (ObjectId)	Identificador único do relatório
`createdAt`	datetime	Data/hora de criação
`updatedAt`	datetime	Data/hora da última atualização
`document`	string	CPF ou CNPJ consultado (sem formatação)
`yearMonthDay`	number	Data de referência como inteiro `AAAAMMDD` (ex.: `20260731`).
`organizationId`	string (ObjectId)	ID da organização que gerou o relatório

| status | object | { id, value }, com value em PENDING, APPROVED ou DENIED. | | policyId / policyVersion / policyName | | Política aplicada. | | parecerEnabled | boolean | Se o pipeline de parecer está habilitado. | | committeeStatus / committeeDecision / committeeResult | | Estado e resultado do Comitê de Crédito IA. | | exportUrl / exportExcelUrl | string | Últimas exportações geradas. | | commentary | object[] | Comentários de analistas | | sections | object[] | Seções do relatório (ver abaixo) |

Tipo do relatório (`type`)

Campo	Tipo	Descrição
`id`	string	ID do tipo
`title`	string	Nome: `"Simples"`, `"Essencial"`, `"Completo"`, `"Completo+"`
`value`	string	Valor do enum: `CUSTOMER_GYRA_90_COMPANY`/`_PERSON` (Simples), `CUSTOMER_GYRA_180_COMPANY`/`_PERSON` (Essencial), `CUSTOMER_GYRA_360_COMPANY`/`_PERSON` (Completo), `CUSTOMER_GYRA_360_PLUS_COMPANY`/`_PERSON` (Completo+). Também existem variantes `_MAX` e `_MAX_PLUS` para relatórios extendidos.
`isPaid`	boolean	Se a consulta gerou cobrança adicional

Status do relatório (`status`)

Campo	Tipo	Descrição
`id`	string	ID do status
`value`	string	`"Pendente"`, `"Aprovado"`, `"Negado"`

Estrutura de uma seção (`sections[]`)

Cada elemento de sections tem:

Campo	Tipo	Descrição
`id`	string	ID da seção
`type`	object	Tipo da seção (ver abaixo)
`completedAt`	datetime	Quando a seção foi finalizada
`errors`	object[]	Erros de integrações (se houver)
`comments`	object[]	Comentários de analistas nesta seção
`selectedIntegrations`	string[]	Integrações que alimentaram esta seção
`sectionDetails`	object[]	Os dados da seção. Ver abaixo.

Onde ficam os dados: `sectionDetails[].values`

Cada item de sectionDetails tem integrationTypes (de onde veio) e values (o conteúdo).

O formato de values varia por seção. Em algumas, os campos ficam no nível de cima. Em outras, ficam aninhados sob uma chave com o nome do provedor que respondeu (ex.: values.SERASA). Não existe uma regra única, então não assuma nem uma coisa nem outra: inspecione as chaves antes de acessar.

Exemplo real de uma seção com campos no nível de cima (BAD_CHECK):

{
  "integrationCount": 1,
  "checksQuantity": 0,
  "checksBalance": "R$ 0,00",
  "lastCheckDate": "",
  "checkTable": []
}

Já os protestos via Serasa aninham sob a chave do provedor. O campo integrationCount, quando presente, indica quantas integrações contribuíram para aquele bloco. O caminho robusto é inspecionar antes de acessar, em vez de assumir um caminho fixo:

for (const detail of section.sectionDetails ?? []) {
  const v = detail.values ?? {};
  // campos no nível de cima?
  if ('checksQuantity' in v) usar(v);
  // ou aninhados sob o provedor?
  else for (const [provedor, dados] of Object.entries(v)) usar(dados, provedor);
}

Se você quer a leitura consolidada e estável, independente de qual bureau respondeu, use GET /report/{id}/insights em vez de fazer parse de values.

Campos crus e campos formatados

Vários tradutores devolvem o mesmo dado duas vezes: value e date (crus, para cálculo) mais formattedValue e formattedDate (formatados em português e padrão brasileiro, para exibição). Não faça parse do formatado para recuperar o número: use o cru.

Tipo da seção (`sections[].type`)

Campo	Tipo	Descrição
`id`	string	ID do tipo
`title`	string	Nome legível (ex: `"Processos Judiciais"`)
`value`	string	Identificador: `BASIC_INFORMATION`, `PROCESSES`, etc.

Valores possíveis de `sections[].type.value`

Valor	Seção	Disponível em
`BASIC_INFORMATION`	Informações básicas e cadastrais	Todos os tipos
`LOCATION`	Contatos, endereço, mapa e fotos de fachada	Todos os tipos
`SUMMARY`	Resumo e insights principais	ESSENCIAL+
`RELATIONS`	Relacionamentos societários	ESSENCIAL+
`PROCESSES`	Processos judiciais (2014+ no ESSENCIAL e COMPLETO; 1980+ no COMPLETO+)	ESSENCIAL+
`SCORE`	Score sintético e componentes de risco	COMPLETO+
`SCR`	SCR Bacen consolidado (snapshot mais recente)	COMPLETO+
`HISTORY`	Histórico SCR mês a mês	COMPLETO+
`CATEGORIES`	SCR por categoria de uso	COMPLETO+
`PEFIN`	Pendências financeiras	COMPLETO+
`REFIN`	Refinanciamentos	COMPLETO+
`BAD_CHECK`	Cheques sem fundo	COMPLETO+
`PROTESTS`	Protestos em cartório	COMPLETO+
`PEP`	Pessoas expostas politicamente	COMPLETO+
`SANCTIONS`	Sanções nacionais e internacionais	COMPLETO+
`CRIMINAL_RECORD`	Antecedentes criminais (CPF), incluindo mandados de prisão (CNJ) — atualização mensal	COMPLETO e COMPLETO+ (somente PF)
`CERTIFICATES`	Certidões em tempo real (parciais no COMPLETO, completas no COMPLETO+)	COMPLETO+
`DOMAINS`	Domínios web associados ao documento	COMPLETO+
`BUREAU_INQUIRY`	Consultas realizadas em bureaus de crédito	COMPLETO+
`LICENSES_AUTHORIZATIONS`	Licenças e autorizações (ANATEL, MTE, etc.)	COMPLETO+
`CREDIT_POLICY`	Resultado da política de crédito	Todos os tipos

Comentários (`commentary`)

Campo	Tipo	Descrição
`id`	string	ID do comentário
`createdAt`	datetime	Data do comentário
`text`	string	Texto do comentário
`authUserId`	string	ID de autenticação do autor
`user.id`	string	ID do usuário no sistema
`user.email`	string	E-mail do usuário
`user.person.name`	string	Nome do usuário
`user.person.cpf`	string	CPF do usuário

Navegação pelo dicionário

Resumo

Campos da seção SUMMARY, principais indicadores de risco.

Informações Básicas

Campos da seção BASIC_INFORMATION, cadastro completo.

Processos Judiciais

Campos da seção PROCESSES, processos e valores.

Protestos

Campos da seção PROTESTS, protestos em cartório.

PEFIN e REFIN

Pendências financeiras e refinanciamentos.

SCR Bacen

Histórico de crédito bancário, SCR do Banco Central.

PEP e Sanções

Exposição política e listas de sanções.

Política de Crédito

Resultado da avaliação automática das regras.

Primeiros Passos

Conceitos Fundamentais

Guia do Toolbox

Fontes de Dados

Guias

Casos de Uso

MCP Server

Referência da API

Dicionário de Dados

Integrações

Referência

Estrutura do Relatório

Objeto Relatório

Tipo do relatório (`type`)

Status do relatório (`status`)

Estrutura de uma seção (`sections[]`)

Onde ficam os dados: `sectionDetails[].values`

Campos crus e campos formatados

Tipo da seção (`sections[].type`)

Valores possíveis de `sections[].type.value`

Comentários (`commentary`)

Navegação pelo dicionário

Resumo

Informações Básicas

Processos Judiciais

Protestos

PEFIN e REFIN

SCR Bacen

PEP e Sanções

Política de Crédito

​Objeto Relatório

​Tipo do relatório (type)

​Status do relatório (status)

​Estrutura de uma seção (sections[])

​Onde ficam os dados: sectionDetails[].values

​Campos crus e campos formatados

​Tipo da seção (sections[].type)

​Valores possíveis de sections[].type.value

​Comentários (commentary)

​Navegação pelo dicionário

Resumo

Informações Básicas

Processos Judiciais

Protestos

PEFIN e REFIN

SCR Bacen

PEP e Sanções

Política de Crédito

Objeto Relatório

Tipo do relatório (`type`)

Status do relatório (`status`)

Estrutura de uma seção (`sections[]`)

Onde ficam os dados: `sectionDetails[].values`

Campos crus e campos formatados

Tipo da seção (`sections[].type`)

Valores possíveis de `sections[].type.value`

Comentários (`commentary`)

Navegação pelo dicionário