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.

Resumo: o toolbox é organizado em torno de um input sempre visível no topo (ponto de entrada para qualquer análise) e um menu lateral com as áreas de configuração e gestão. Esta página é um mapa rápido: o que existe, para que serve e onde clicar.

Estrutura da tela

┌─────────────────────────────────────────────────────────┐
│  [INPUT SEMPRE VISÍVEL: digitar CPF/CNPJ]      [perfil] │
├──────────┬──────────────────────────────────────────────┤
│          │                                              │
│  Menu    │                                              │
│  lateral │            Conteúdo da seção                 │
│          │                                              │
│          │                                              │
└──────────┴──────────────────────────────────────────────┘
Todo o toolbox gira em torno dessas duas áreas: o input dispara análises em qualquer momento; o menu lateral dá acesso a configurações, políticas e históricos.

O input sempre visível

Ponto de entrada universal. Em qualquer tela, você pode:
  1. Digitar um CPF ou CNPJ, que o sistema identifica automaticamente.
  2. Selecionar a política no dropdown que abre abaixo (com a ação tornar padrão ao lado de cada uma).
  3. Apertar Enter para disparar a análise e ir direto para o relatório.
  4. Clicar no + no canto do input para iniciar um Lote de Clientes (análise em massa).
Detalhes em Rodar uma Análise.

Análises

Histórico de todas as análises rodadas pelos usuários da organização. Filtros por documento, política, status, período, autor. Cada linha abre o relatório individual.

Lotes de Clientes

Onde ficam os lotes criados pelo + do input. Cada lote mostra progresso do processamento, total de documentos, status agregado, e link para o XLS consolidado e relatórios individuais.

Política de Crédito

Subdividida em:
  • Políticas, lista das políticas da organização (habilitadas e rascunhos). Aqui você cria, edita, habilita, desabilita.
  • Templates, catálogo de políticas prontas mantido pela GYRA+. Ponto de partida para organizações novas. Ver Usar Templates.
  • Produtos, cadastro opcional de produtos financeiros vinculados às políticas (ex: Capital de Giro, Antecipação de Recebíveis).

Solicitações

Onde você dispara fluxos que exigem o envolvimento direto do cliente final: opt-in de SCR (autorização para consultar o Banco Central) e Face Match com liveness (validação de identidade no onboarding). Tudo via WhatsApp do cliente. Detalhes em Solicitações.

Operações (feature opcional)

Só aparece se a organização usa a feature de cadeias de políticas baseadas em relacionamentos (sócios, filiais, parentes). Detalhes em Operações.

GYRA Insights (IA no relatório)

Insights são pareceres gerados por IA sobre seções específicas do relatório, disponíveis diretamente dentro da análise (não é um módulo separado). Hoje estão habilitados nas seções de Processos e SCR: ao clicar em GYRA Insights dentro dessas seções, o agente retorna uma análise interpretativa do conjunto — riscos relevantes, padrões de comportamento, pontos de atenção e recomendações — com base nos dados coletados para aquele CPF/CNPJ. Disponibilidade depende do plano contratado.

Configurações

  • Usuários, convidar, remover, atribuir papéis. Ver Gerenciar Usuários e Permissões.
  • Integrações, credenciais próprias de bureau (BYOC Serasa) e demais bases externas com contrato direto.
Não configura pelo toolbox: API Keys e webhooks (solicite/configure via suporte ou API, ver Webhooks e API Keys), logo e branding da organização (configurado pela equipe da GYRA+ no provisionamento) e dados de faturamento (gestão via contrato, ainda sem tela no toolbox).

Fluxos principais do dia a dia

Analisar um documento

Input sempre visível, digitar, Enter.

Analisar em lote

Clicar no + do input, colar lista, criar lote.

Criar ou ajustar política

Política de Crédito, Políticas ou Templates.

Convidar usuário

Configurações, Usuários.

Configurar webhook

Via API (POST /webhook).

Ler um relatório

Clicar em qualquer linha na lista de Análises.

Papéis e o que cada um vê

Papel
AdministradorTudo. Usuários, políticas, integrações, webhooks, todas as análises da organização.
Gestor de CréditoPolíticas, templates, produtos, todas as análises da organização.
Analista de CréditoInput de análise, apenas as análises que ele próprio rodou, relatórios. Não edita política.
Detalhamento em Gerenciar Usuários e Permissões.

Atalhos e produtividade

  • Busca global (ícone de lupa no topo): procura por documento, nome, política ou lote.
  • Política padrão (marcada no próprio dropdown do input): pré-seleciona ao digitar um documento, um clique a menos por análise.
  • Filtros salvos na listagem de análises: útil para quem monitora carteira por produto ou período.
  • Exportar em PDF, XLS ou PDF+XLS em qualquer relatório individual pelo menu de três pontos ao lado do nome da empresa (links válidos por 7 dias, regenerável a qualquer momento).

Perguntas frequentes

Provavelmente a plataforma foi recém-provisionada. Vá em Primeiro Acesso e siga os passos: ativar templates, configurar padrão, rodar primeira análise.
Operações é feature opcional. Se a organização não contratou, o menu não aparece. Para análise simples, basta o input no topo. Detalhes em Operações.
O toolbox é otimizado para desktop. Funciona em tablet, mas o editor de políticas e a tela de relatório completo ficam melhor em tela grande.
Não no momento. O toolbox segue o design system gyra-design com tema claro padrão.

Próximos passos

Primeiro Acesso

Configurar a plataforma do zero.

Rodar uma análise

Primeiro uso do input sempre visível.

Usar Templates

Ativar políticas prontas.

Interpretar resultado

Ler o relatório com confiança.