Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

O que são seções

Um relatório GYRA+ é estruturado em seções independentes, cada uma responsável por um tema de análise. As seções são processadas em paralelo e chegam ao frontend em tempo real via WebSocket conforme as integrações são concluídas. A disponibilidade de cada seção depende do tipo de relatório (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+) e da política de crédito utilizada.

Catálogo de seções

Informações Cadastrais

BASIC_INFORMATION

Dados cadastrais completos: razão social, CNAE, situação na Receita Federal, endereço, contatos, quadro societário e histórico de alterações.

RELATIONS

Relacionamentos empresariais e societários: empresas associadas, participações como sócio, vínculos relevantes.

Análise de Risco

SUMMARY

Painel de resumo com os principais indicadores de risco: score, alertas críticos e totais de restrições. Pareceres gerados por IA (GYRA Insights) ficam nas seções de Processos e SCR, não aqui.

CREDIT_POLICY

Resultado detalhado de todas as regras avaliadas pela política de crédito: status por grupo, pontuações e decisão final.

Restrições Financeiras

PEFIN

Pendências financeiras registradas em bureaus de crédito. Inclui valor, quantidade, período e comparativo com faturamento.

REFIN

Refinanciamentos com instituições financeiras. Semelhante ao PEFIN, com foco em dívidas renegociadas com bancos.

BAD_CHECK

Cheques sem fundo, sustados ou roubados registrados no CCF (Cadastro de Emitentes de Cheques sem Fundo).

HISTORY / CATEGORIES

Histórico de endividamento mês a mês via SCR (Sistema de Informações de Crédito do Banco Central). Inclui breakdown por categoria de uso. Suporta GYRA Insights (parecer gerado por IA sobre o perfil de endividamento).

Processos e Protestos

PROCESSES

Processos judiciais do documento e dos sócios (quando empresa): civis, trabalhistas, criminais, ambientais e financeiros. Com partes, valores e movimentações. Suporta GYRA Insights (parecer gerado por IA sobre riscos dos processos).

PROTESTS

Protestos em cartório com abrangência nacional. Valor, quantidade, período e cartório de origem.

CRIMINAL_RECORD

Antecedentes criminais (disponível apenas para CPF, nos relatórios COMPLETO e COMPLETO+). Inclui também mandados de prisão (CNJ), atualizados mensalmente:
  • Situação X (vermelho): mandado ativo encontrado no mês.
  • Situação ! (amarelo): existiu mandado no passado, mas não há mandado ativo no mês atual.
Esses dados aparecem na UI dentro de Antecedente Criminal e também na seção Antecedentes criminais do PDF do relatório.

Compliance e Localização

PEP

Pessoas Expostas Politicamente: cargos públicos, mandatos, vínculos com agentes políticos e histórico de doações eleitorais.

SANCTIONS

Sanções nacionais e internacionais: OFAC, listas de bloqueio, CEIS, CEPIM e outros registros regulatórios.

CERTIFICATES

Certidões emitidas em tempo real: PGFN, Receita Federal, FGTS, Estaduais. O relatório COMPLETO inclui um subconjunto de certidões; o COMPLETO+ traz o conjunto completo.

LOCATION

Telefones, e-mails, endereços, mapa e fotos de fachada do endereço declarado. Disponível em todos os níveis (SIMPLES, ESSENCIAL, COMPLETO, COMPLETO+).

Status de uma seção

Cada seção pode estar em um dos seguintes estados:
StatusDescrição
PendenteAguardando conclusão das integrações
CompletaTodos os dados foram recebidos e normalizados
ParcialAlgumas integrações concluídas, outras ainda em andamento
ErroUma ou mais integrações falharam, dados parciais disponíveis
Mesmo com erro em uma integração, o relatório é gerado com os dados disponíveis. A seção errors de cada seção detalha o que falhou.

Disponibilidade por tipo de relatório

SeçãoSIMPLESESSENCIALCOMPLETOCOMPLETO+
BASIC_INFORMATION
LOCATION (contatos, mapa, fachada)
Faturamento / Renda
RELATIONS✅ (1º nível)✅ (até 3º nível, parentesco, filiais e mesmo endereço)✅ (até 3º nível, parentesco, filiais e mesmo endereço)✅ (até 3º nível, parentesco, filiais e mesmo endereço)
Alterações cadastrais
PROCESSES✅ (2014+)✅ (2014+)✅ (1980+)
PEP / SANCTIONS
CERTIFICATES (PGFN, Receita, IBAMA, TST, CNJ, MTE, SEFAZ, FGTS)
CRIMINAL_RECORD
Licenças operacionais (ANTT, ANATEL, ANVISA, ANP)
Beneficiário social (programas do governo)
SUMMARY
CREDIT_POLICY

Dados adicionais (opcionais, em qualquer tipo)

SeçãoConteúdo
BureausPefin/Refin, protestos, CCF, dívidas vencidas, score, limite, quantidade de consultas e faturamento/renda presumidos
SCR (HISTORY / CATEGORIES)Endividamento por faixa e produtos, limites e relacionamentos bancários
Balanço Patrimonial e DREScore, limites, indicadores, extração de dados e análise qualitativa