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: toda análise começa pelo input sempre visível no topo do toolbox. Você digita o CPF ou CNPJ, o sistema identifica o tipo de documento, abre o dropdown com as políticas (e operações, se houver) disponíveis e, ao apertar Enter, dispara o processamento. Em segundos o relatório está na tela. Para múltiplos documentos, há o fluxo de Lote de Clientes.

​
O input sempre visível

No topo de todas as telas do toolbox fica o campo de análise. Ele é o ponto de entrada para qualquer consulta. O fluxo direto é:
1

Digitar o documento

CPF (11 dígitos) ou CNPJ (14 dígitos). O toolbox identifica o tipo automaticamente, valida o dígito verificador e filtra a lista de políticas compatíveis. Documento inválido é sinalizado antes de você poder prosseguir.
2

Escolher a política no dropdown

Logo abaixo do input abre um dropdown com as políticas ativas para o tipo de documento digitado. Se você tem política padrão marcada (via o próprio dropdown, ação tornar padrão ao lado do nome), ela já vem pré-selecionada.Se a sua organização configurou alguma operação (feature opcional de cadeia com relacionamentos, ver Operações), ela também aparece no dropdown, distinguida como operação.
3

Apertar Enter

Dispara o processamento e redireciona você direto para a tela do relatório. Não há outro clique.
4

Acompanhar o processamento

A análise passa pelos estados:
  • PROCESSING, coleta de dados em andamento.
  • EVALUATING, política rodando sobre os dados coletados.
  • COMPLETED, resultado disponível.
Tempo típico: 5 a 30 segundos, conforme as fontes consultadas.
5

Ler o resultado

Ao terminar, aparece status (APPROVED, ALERT, DENIED, ERROR), breakdown por regra e precificação, se houver. Guia em Interpretar Resultado da Operação.
Se ao digitar o documento o dropdown vem vazio, é porque nenhuma política compatível está habilitada para aquele tipo. O gestor precisa ativar um template antes. Ver Usar Templates.

​
Lote de Clientes

Para analisar múltiplos documentos de uma vez, não precisa planilha nem upload de arquivo. Tudo acontece pelo mesmo input:
1

Clicar no + do input

No canto do input sempre visível há o botão +. Ele abre a tela de entrada em lote.
2

Colar ou digitar os documentos

Copie uma coluna de CNPJs/CPFs de uma planilha, lista, e-mail, e cole na caixa. Também aceita digitação direta. O toolbox faz a checagem em tempo real, marca documentos válidos e separa os inválidos para você revisar.
3

Avançar

Clicar em Próximo.
4

Nomear o lote e escolher a política

Dê um nome reconhecível ao lote (ex: Revisão carteira Abril 2026) e selecione qual política será usada para todos os documentos do lote. Só políticas compatíveis com o tipo predominante aparecem na lista.
5

Criar lote

Clicar em Criar lote. O processamento é engatilhado em background, em paralelo, e o lote aparece na seção Lotes de Clientes do menu lateral.
6

Acompanhar e baixar

Ao terminar, o lote entrega:
  • Um arquivo XLS com as principais informações agrupadas de cada documento (status, score, motivos, precificação).
  • O XLS fica disponível para download na listagem de Lotes de Clientes.
  • Cada relatório individual também é acessível na plataforma pelo link no próprio XLS ou pela listagem do lote.
O XLS consolidado é o formato pensado para gestor de carteira ou analista revisar um grande volume rapidamente. Para investigar um caso específico, abra o relatório individual.

​
Via API

O fluxo equivalente por integração direta: 
POST /v2/report
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "document": "43591367000130",
  "policyId": "6612a7f30000000000000001",
  "amount": 100000
}
Resposta: objeto Report com id, que você pode consultar por polling ou receber via webhook. Referência em POST /v2/report.

​
Reanálise

A reanálise existe para casos em que um relatório foi gerado com dados incompletos ou com erro em alguma fonte, e ainda não fechou com decisão final (APPROVED ou DENIED). Como funciona:
  • Ao gerar o relatório novamente para o mesmo documento (pelo input ou pela API), o relatório existente é reprocessado caso ainda não esteja APPROVED ou DENIED. Os dados que estavam com erro ou parciais podem então ser revistos.
  • Se o relatório já fechou com status final (APPROVED ou DENIED), ele não é atualizado — uma nova chamada gera um relatório distinto.
Não há um botão “Reanalisar” no toolbox. A reanálise acontece automaticamente ao se solicitar uma nova análise para o mesmo documento, dentro das condições acima.

​
Limitações e considerações

  • Documento inválido é bloqueado antes do envio.
  • Dropdown vazio significa que não há política ativa para o tipo, gestor precisa habilitar.
  • Fontes indisponíveis no momento da consulta podem gerar ERROR. O relatório mostra qual fonte falhou; basta reanalisar depois.
  • Concorrência do lote é paralelizada, mas lotes muito grandes podem ser enfileirados conforme o contrato.

​
Perguntas frequentes

Porque nenhuma política compatível com o tipo de documento (PF ou PJ) está habilitada para a sua organização. O administrador ou gestor precisa ativar pelo menos um template em Política de Crédito, Templates. Ver Usar Templates.
Política é um conjunto de regras que roda sobre um documento. Operação é uma feature opcional para configurar cadeias de políticas baseadas em relacionamentos (sócios, filiais, parentes). Nem toda organização usa operação; quem usa pode ver em Operações.
No dropdown que abre ao digitar o documento, ao lado de cada política aparece a ação tornar padrão. Uma política padrão por tipo de documento, por usuário.
Pode. Se o relatório anterior ainda não fechou com APPROVED ou DENIED, ele é reprocessado (reanálise). Se já fechou, uma nova chamada gera um relatório distinto.
Mais de 2 minutos em PROCESSING é sinal de fonte lenta ou falha temporária. Aguarde 1 minuto a mais e, se continuar, rode de novo. Se o padrão se repetir, fale com o suporte.
Análises que terminam em ERROR antes da avaliação da política não contam. As que chegaram a rodar a política, mesmo com fonte parcial, contam normalmente.

​
Próximos passos

Interpretar resultado

Status, breakdown por regra, precificação.

Operações (feature opcional)

Cadeia de políticas por relacionamento.

Webhooks

Receber o resultado em tempo real no seu backend.

API de relatório

Integração direta via HTTP.