# GYRA+ Docs

## Docs

- [Chaves de API](https://developers.gyramais.com.br/api-reference/api-keys.md): Obtenha uma chave de API para autenticar suas requisições à API da GYRA+.
- [Gerar Token](https://developers.gyramais.com.br/api-reference/auth/post-authauthenticate.md): Gera um token para autenticar as requisições
- [Como Funciona](https://developers.gyramais.com.br/api-reference/como-funciona.md)
- [Consultar políticas de decisão](https://developers.gyramais.com.br/api-reference/credit-policypolicy/get-credit-policypolicy.md): Busca todas as políticas de decisão
- [Introdução](https://developers.gyramais.com.br/api-reference/introduction.md): Documentação oficial da API GYRA+
- [Consultar Relatório (v2)](https://developers.gyramais.com.br/api-reference/report-v2/get-v2report.md): Consulta um relatório pelo ID usando a estrutura de resposta revisada da v2.
- [Criar Relatório (v2)](https://developers.gyramais.com.br/api-reference/report-v2/post-v2report.md): Dispara uma nova análise de crédito para CPF ou CNPJ com o payload revisado da v2.
- [Consultar Seção por Tipo](https://developers.gyramais.com.br/api-reference/report/get-report-section.md): Retorna uma seção específica de um relatório pelo seu tipo, sem precisar do sectionId.
- [Exportar Relatório (Assíncrono)](https://developers.gyramais.com.br/api-reference/report/get-reportexport.md): Dispara a exportação do relatório em PDF/XLS de forma assíncrona. O arquivo é entregue via webhook REPORT_EXPORTED.
- [Exportar Relatório (Síncrono)](https://developers.gyramais.com.br/api-reference/report/get-reportexport-sync.md): Exporta o relatório em PDF e retorna a URL na mesma resposta. Bloqueia até o arquivo ficar pronto.
- [Consulta Lista de Relatórios](https://developers.gyramais.com.br/api-reference/report/get-reportlist.md): Busca uma lista de relatórios
- [Consultar Seção por ID](https://developers.gyramais.com.br/api-reference/report/get-reportsection.md): Retorna os dados completos de uma seção específica de um relatório.
- [Analisar Relatório Manualmente](https://developers.gyramais.com.br/api-reference/report/post-reportanalyze.md): Registra uma decisão manual (aprovado/negado com justificativa) sobre um relatório existente.
- [Refazer Análise Manual](https://developers.gyramais.com.br/api-reference/report/post-reportre-analyze.md): Refaz uma análise manual já registrada em um relatório, substituindo o parecer anterior.
- [Remover Webhook](https://developers.gyramais.com.br/api-reference/webhook/delete-webhook.md): Remove um webhook por ID
- [Consultar Webhook](https://developers.gyramais.com.br/api-reference/webhook/get-webhookfindby.md): Busca um webhook por ID
- [Criar Webhook](https://developers.gyramais.com.br/api-reference/webhook/post-webhook.md): Cria um webhook
- [Análise de Crédito](https://developers.gyramais.com.br/concepts/analise-de-credito.md): O que é a análise de crédito na GYRA+ e como ela chega à decisão final.
- [Decisão Automática](https://developers.gyramais.com.br/concepts/decisao-automatica.md): Como a Política de Crédito avalia regras e produz a decisão final do relatório (aprovar, negar, alerta).
- [GYRA Insights](https://developers.gyramais.com.br/concepts/gyra-insights.md): Agentes de IA da GYRA+ que analisam o contexto da empresa ou pessoa consultada e entregam pareceres especializados sobre seções específicas do relatório.
- [Operações](https://developers.gyramais.com.br/concepts/operacoes.md): Workflow de análise em cascata, como encadear o relatório principal com análises de sócios, filiais e vínculos.
- [Política de Crédito](https://developers.gyramais.com.br/concepts/politica-de-credito.md): Entenda como as políticas de crédito funcionam e como elas controlam as decisões automáticas da GYRA+.
- [Precificação](https://developers.gyramais.com.br/concepts/precificacao.md): Como a GYRA+ calcula prazo, taxa de juros e valor final usando fórmulas dinâmicas dentro da política de crédito.
- [O que é um Relatório](https://developers.gyramais.com.br/concepts/relatorio.md): Entenda o conceito central da GYRA+, o relatório de crédito e como ele é gerado.
- [Score](https://developers.gyramais.com.br/concepts/score.md): Indicador numérico de risco entre 1 e 1000 calculado pela política de crédito durante a análise de um relatório.
- [Seções do Relatório](https://developers.gyramais.com.br/concepts/secoes.md): Cada relatório é dividido em seções temáticas. Entenda o que cada uma entrega.
- [Templates de Política](https://developers.gyramais.com.br/concepts/templates-de-politica.md): Políticas prontas para partir de uma base testada em vez de começar do zero.
- [Webhooks e Tempo Real](https://developers.gyramais.com.br/concepts/webhooks-e-tempo-real.md): Receba a decisão de crédito assim que o relatório for concluído, sem polling.
- [Estrutura do Relatório](https://developers.gyramais.com.br/data/estrutura-relatorio.md): Campos de nível raiz de um relatório GYRA+ e como navegar pelas seções.
- [Seção, Informações Básicas (BASIC_INFORMATION)](https://developers.gyramais.com.br/data/secao-informacoes-basicas.md): Campos da seção cadastral completa para CNPJ e CPF.
- [Seção, PEFIN e REFIN](https://developers.gyramais.com.br/data/secao-pefin-refin.md): Campos das seções de pendências financeiras (PEFIN) e refinanciamentos (REFIN).
- [Seção, PEP e Sanções](https://developers.gyramais.com.br/data/secao-pep-sancoes.md): Campos das seções de Pessoas Expostas Politicamente (PEP) e listas de sanções nacionais e internacionais.
- [Seção, Política de Crédito (CREDIT_POLICY)](https://developers.gyramais.com.br/data/secao-politica-credito.md): Campos da seção com o resultado completo da avaliação automática de regras e decisão final.
- [Seção, Processos Judiciais (PROCESSES)](https://developers.gyramais.com.br/data/secao-processos.md): Campos da seção de processos com cobertura de ações cíveis, trabalhistas, tributárias, criminais, financeiras, ambientais, administrativas, eleitorais, previdenciárias e Outros.
- [Seção, Protestos (PROTESTS)](https://developers.gyramais.com.br/data/secao-protestos.md): Campos da seção de protestos em cartório com cobertura nacional.
- [Seção, Resumo (SUMMARY)](https://developers.gyramais.com.br/data/secao-resumo.md): Campos da seção de resumo com os principais indicadores de risco do relatório.
- [Seção, SCR (Banco Central)](https://developers.gyramais.com.br/data/secao-scr.md): Campos das seções HISTORY e CATEGORIES com o histórico de crédito bancário via SCR do Bacen.
- [Dados Entregues](https://developers.gyramais.com.br/docs/dados-entregues.md): Entenda todos os dados entregues no relatório da GYRA+.
- [Integração com n8n](https://developers.gyramais.com.br/docs/integracao-n8n.md): Automatize análises de crédito com n8n, workflows prontos para importar e conectar seu ERP, CRM, Google Sheets e e-mail.
- [Collections para Postman e Insomnia](https://developers.gyramais.com.br/docs/postman-insomnia.md): Baixe a collection oficial da API GYRA+ e comece a testar em minutos, sem configurar nada do zero.
- [Políticas de Decisão e Tipos de Relatório](https://developers.gyramais.com.br/docs/tipos-relatorios.md)
- [Configurar Webhook](https://developers.gyramais.com.br/guides/configurar-webhook.md): Receba a decisão de crédito em tempo real no seu sistema assim que o relatório for concluído.
- [Criar uma Política de Crédito](https://developers.gyramais.com.br/guides/criar-politica-personalizada.md): Configure os critérios de aprovação, alerta e negação de crédito do seu negócio, sem precisar escrever código.
- [Interpretar uma Decisão de Crédito](https://developers.gyramais.com.br/guides/interpretar-decisao.md): Como ler o resultado de um relatório GYRA+ e entender o que cada campo significa.
- [Seu primeiro relatório em 5 minutos](https://developers.gyramais.com.br/guides/primeiro-relatorio.md): Do zero à primeira decisão de crédito automatizada. Siga este guia e comece a analisar.
- [Casos de Uso com MCP](https://developers.gyramais.com.br/mcp/casos-de-uso.md): Cenários reais de uso do MCP da GYRA+ em workflows de análise de crédito, compliance e automação.
- [Ferramentas Disponíveis](https://developers.gyramais.com.br/mcp/ferramentas-disponiveis.md): Catálogo completo de tools expostas pelo MCP Server da GYRA+, agrupadas por domínio.
- [Instalação do MCP](https://developers.gyramais.com.br/mcp/instalacao.md): Conectar o MCP Server da GYRA+ no Claude.ai, Claude Desktop, Cursor, Claude Code e outros clientes MCP.
- [O que é o MCP da GYRA+](https://developers.gyramais.com.br/mcp/o-que-e.md): Servidor MCP (Model Context Protocol) que expõe a API da GYRA+ como ferramentas para agentes de IA, permitindo rodar análises, consultar relatórios e gerenciar webhooks via linguagem natural.
- [Troubleshooting MCP](https://developers.gyramais.com.br/mcp/troubleshooting.md): Erros comuns ao usar o MCP da GYRA+: autenticação, conexão, tools não aparecendo, comportamento inesperado do agente.
- [Changelog](https://developers.gyramais.com.br/reference/changelog.md): Histórico de atualizações da API e da plataforma GYRA+.
- [Referência de Erros](https://developers.gyramais.com.br/reference/erros.md): Todos os códigos de erro da API GYRA+, suas causas e como resolver.
- [Benefícios Sociais](https://developers.gyramais.com.br/sources/beneficios-sociais.md): Participação em programas sociais (Bolsa Família, BPC, Seguro Desemprego) e vínculos governamentais para CPF.
- [Bureau de Crédito](https://developers.gyramais.com.br/sources/bureau-credito.md): Score sintético, histórico de restritivos e endividamento.
- [Cadastral](https://developers.gyramais.com.br/sources/cadastral.md): Dados cadastrais oficiais de pessoa física e jurídica: nome, situação, CNAE, endereço, data de abertura.
- [Certidões](https://developers.gyramais.com.br/sources/certidoes.md): Certidões oficiais consultadas em tempo real na fonte: PGFN, FGTS, CNDT, Fazenda Estadual, Junta Comercial, CNJ, IBAMA, SIPROQUIM, Simples Nacional, SUFRAMA, CCC, MTE, Anatel.
- [Contatos e Localização](https://developers.gyramais.com.br/sources/contatos.md): Telefones, e-mails, endereços (atual e históricos), mapa do endereço e fotos de fachada, retornados em todos os níveis de relatório.
- [Financeira](https://developers.gyramais.com.br/sources/financeira.md): Faturamento declarado, indicadores contábeis, integrações de balanço e sinais de capacidade financeira para CNPJ e CPF.
- [Mídia e Reputação](https://developers.gyramais.com.br/sources/midia-reputacao.md): Menções em mídia, adverse media, sinais reputacionais online e exposição pública para CPF e CNPJ.
- [PEFIN e REFIN](https://developers.gyramais.com.br/sources/pefin-refin.md): Pendências financeiras registradas e refinanciamentos bancários.
- [PEP e Sanções](https://developers.gyramais.com.br/sources/pep-sancoes.md): Exposição política (PEP), listas de sanções nacionais e internacionais, CEIS, CNEP, OFAC e equivalentes.
- [Processos Judiciais](https://developers.gyramais.com.br/sources/processos-judiciais.md): Ações como autor e réu em tribunais estaduais e federais, classificadas por tipo de vara.
- [Protestos](https://developers.gyramais.com.br/sources/protestos.md): Protestos cartorários ativos em todo o Brasil, por CPF ou CNPJ, com valor, cartório e data.
- [SCR e Open Finance](https://developers.gyramais.com.br/sources/scr-open-finance.md): Endividamento bancário oficial via Sistema de Informações de Crédito do Banco Central.
- [Vínculos Societários](https://developers.gyramais.com.br/sources/vinculos-societarios.md): QSA, sócios, filiais, grupo econômico e relacionamentos de parentesco mapeados a partir de um CPF ou CNPJ.
- [Visão Geral das Fontes](https://developers.gyramais.com.br/sources/visao-geral.md): Categorias de dados que compõem o relatório GYRA+, cobertura por nível e como as fontes se combinam numa análise.
- [Criar Política](https://developers.gyramais.com.br/toolbox/criar-politica.md): Montar uma política de crédito do zero ou a partir de template: regras, grupos, scoring, fórmulas de precificação, habilitação.
- [Editar Política](https://developers.gyramais.com.br/toolbox/editar-politica.md): Ajustar regras, thresholds, fórmulas e mensagens de uma política existente. Versionamento e como reverter.
- [Usuários e Permissões](https://developers.gyramais.com.br/toolbox/gerenciar-usuarios-permissoes.md): Convidar, remover, atribuir papéis e configurar SSO (Google Workspace, Microsoft Azure AD).
- [Interpretar Resultado do Relatório](https://developers.gyramais.com.br/toolbox/interpretar-resultado-operacao.md): Status, score, breakdown por regra, precificação e motivos para aprovar, alertar ou negar.
- [Primeiro Acesso](https://developers.gyramais.com.br/toolbox/primeiro-acesso.md): Passo a passo para configurar a plataforma pela primeira vez e começar a operar: login, ativação de templates, política padrão por usuário e primeira operação.
- [Rodar uma Análise](https://developers.gyramais.com.br/toolbox/rodar-operacao.md): Como rodar uma análise de crédito no toolbox pelo input sempre visível, individualmente ou em lote de clientes.
- [Solicitações: SCR e Face Match](https://developers.gyramais.com.br/toolbox/solicitacoes.md): Coletar opt-in do cliente para consulta SCR ou validar identidade via Face Match com liveness, pelo próprio WhatsApp do cliente.
- [Usar Templates de Política](https://developers.gyramais.com.br/toolbox/usar-templates.md): Ativar um template direto ou clonar e customizar para criar a sua política. Catálogo e mecânica de versionamento.
- [Visão Geral do Toolbox](https://developers.gyramais.com.br/toolbox/visao-geral.md): Tour pelas seções principais da plataforma: input sempre visível, Política de Crédito, Análises, Lotes de Clientes, Configurações.
- [Webhooks e API Keys](https://developers.gyramais.com.br/toolbox/webhooks-e-api-keys.md): Como obter credenciais de API e configurar webhooks para receber eventos em tempo real.
- [Distribuidora e Crédito B2B](https://developers.gyramais.com.br/use-cases/distribuidora-b2b.md): Automatize a aprovação de crédito para novos clientes e revisões de limite em operações comerciais.
- [Fintech de Crédito](https://developers.gyramais.com.br/use-cases/fintech-credito.md): Como usar a GYRA+ para automatizar aprovação de crédito para pessoa física e jurídica.
- [Fundo de Crédito e Factoring](https://developers.gyramais.com.br/use-cases/fundo-e-factoring.md): Due diligence automatizada para originação e aquisição de recebíveis com inteligência de risco em tempo real.

## OpenAPI Specs

- [openapi](https://developers.gyramais.com.br/openapi.yaml)