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.

A GYRA+ combina dois conceitos distintos para cada análise: o tipo de relatório (escopo dos dados coletados) e a política de decisão (regras que avaliam o resultado).

​
Tipos de relatório

O tipo de relatório determina quais seções e fontes são coletadas. Quatro níveis disponíveis:
Nometype.valueEscopo
SimplesCUSTOMER_GYRA_90_COMPANY / _PERSONCadastro, contatos e localização
EssencialCUSTOMER_GYRA_180_COMPANY / _PERSONSimples + resumo, relacionamentos, processos (2014+)
CompletoCUSTOMER_GYRA_360_COMPANY / _PERSONEssencial + protestos, PEFIN, REFIN, cheques, PEP, sanções, SCR, certidões parciais
Completo+CUSTOMER_GYRA_360_PLUS_COMPANY / _PERSONCompleto + processos 1980+ e todas as certidões em tempo real
Variantes _MAX e _MAX_PLUS existem para coberturas estendidas (balanço, DRE, indicadores financeiros); disponíveis mediante contratação. O tipo de relatório é determinado pela política de decisão (policyId) enviada no POST /v2/report.

​
Políticas de decisão (policyId)

Cada policyId referencia uma política de decisão que define:
  • Qual tipo de relatório será gerado (Simples, Essencial, Completo ou Completo+).
  • Quais regras serão avaliadas (SCR, protestos, PEP, certidões, etc.).
  • Como o resultado final é calculado (APPROVED, DENIED, ALERT).
Três formas de usar:
  1. Templates prontos: a GYRA+ publica templates de mercado (crédito PJ, cartão, antecipação, RH/background check, KYC, etc.). Você clona e usa direto.
  2. Template personalizado: clone um template e ajuste regras, pesos e Risk Bands à sua estratégia.
  3. Do zero: configure a política inteira no toolbox, escolhendo variáveis, condições e grupos.
Os policyId ativos da sua organização ficam disponíveis via GET /credit-policy/policy ou pela MCP tool list_policies. Não há lista pública fixa — eles variam por organização e podem mudar conforme a GYRA+ publica novos templates.
Para obter o policyId correto na hora da integração, liste as políticas da sua organização:
curl https://gyra-core.gyramais.com.br/credit-policy/policy \
  -H "Authorization: Bearer <token>"

Comparativo dos Relatórios

Tabela completa com os campos disponíveis em cada tipo.