# GYRA+ Docs > ## Agent Instructions > A GYRA+ tem um servidor MCP oficial: https://mcp.gyramais.com.br/mcp. A autenticação é o login do próprio usuário na plataforma, não uma credencial separada. Instalação em https://developers.gyramais.com.br/mcp/instalacao. > Prefira as tools do MCP a montar chamadas HTTP na mão quando o usuário já tem o conector ligado. > Para analisar crédito de um CNPJ ou CPF, use create_report_v2 e assine um webhook em vez de fazer polling. > Para ler um documento (contrato social, comprovante de residência, imposto de renda, balanço), use validate_document: a entrada é um arquivo só e a plataforma reconhece o tipo sozinha. > Para pedir documentos ao cliente final, use create_collection com o slug de um modelo obtido em list_collection_templates. > Documento (CNPJ/CPF) é dado pessoal: não o repita em log nem o envie a serviços de terceiros. - [Introdução](https://developers.gyramais.com.br/api-reference/introduction.md): Documentação oficial da API GYRA+ - [Como Funciona](https://developers.gyramais.com.br/api-reference/como-funciona.md): Arquitetura da API GYRA+, do POST que dispara a análise ao webhook que entrega a decisão, e como autenticar em cada etapa. - [Chaves de API](https://developers.gyramais.com.br/api-reference/api-keys.md): Gere as credenciais da sua organização no próprio painel do toolbox e autentique as requisições à API da GYRA+. - [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. - [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. - [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+. - [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. - [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. - [Pareceres GYRA+ IA](https://developers.gyramais.com.br/concepts/pareceres-gyra-ia.md): Todas as seções do relatório chegam analisadas. Um agente especialista por domínio lê os dados no contexto real do negócio e entrega parecer, score e nível de risco. - [Comitê de Crédito IA](https://developers.gyramais.com.br/concepts/comite-de-credito.md): Sete agentes especialistas e um Presidente deliberam sobre os pareceres do relatório e devolvem uma decisão de crédito auditável. - [Análise Financeira (Balanços e DRE)](https://developers.gyramais.com.br/concepts/analise-financeira.md): Balanços e DRE viram dados estruturados: a GYRA+ busca as demonstrações que já tem na base de mais de 170 mil balanços, aceita upload de múltiplos exercícios, calcula mais de 30 indicadores, compara a evolução período a período e entrega tudo como variável de política, planilha, API e MCP. - [Arquivos do Relatório](https://developers.gyramais.com.br/concepts/arquivos-do-relatorio.md): Guarde no relatório os documentos que sustentaram a decisão de crédito e baixe o dossiê completo num único zip: anexos enviados, certidões coletadas, demonstrações de origem, PDF e planilha do relatório. - [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. - [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). - [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. - [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. - [Onboarding](https://developers.gyramais.com.br/onboarding/visao-geral.md): O módulo que conhece o seu cliente, pede o que falta e confere quem ele é: o dossiê de cada CNPJ ou CPF, o pedido de documentos, formulário, termo, assinatura e identidade, e a validação de identidade. - [Cadastro documental](https://developers.gyramais.com.br/onboarding/cadastro-documental.md): O dossiê de um CNPJ ou CPF no Onboarding: documentos vigentes, completude, situação, dados declarados pelo cliente, quadro societário, contatos, renovação e trilha de auditoria. - [Tipos de documento aceitos](https://developers.gyramais.com.br/onboarding/tipos-de-documento.md): Os 25 tipos documentais que a plataforma analisa, com o que cada um é, o prazo de vigência padrão e os subtipos aceitos. - [Análise documental](https://developers.gyramais.com.br/onboarding/analise-documental.md): Como um arquivo vira parecer: classificação, extração, validação e parecer, com status, motivos e reprocessamento seletivo. - [Régua de validação](https://developers.gyramais.com.br/onboarding/regua-de-validacao.md): As verificações que a plataforma faz em cada documento, o que reprova, o que vira ressalva e o que você configura por tipo documental. - [Solicitações de coleta](https://developers.gyramais.com.br/onboarding/solicitacoes.md): O pedido do Onboarding ao cliente final: modelo, itens, destinatários, canal, prazo, lembretes e o que acontece com cada resposta. - [Formulários](https://developers.gyramais.com.br/onboarding/formularios.md): Como montar o formulário de cadastro que o destinatário responde: campos prontos, campos livres, sócios e pré-preenchimento pela extração. - [Formulário público](https://developers.gyramais.com.br/onboarding/formulario-publico.md): Um link aberto do modelo de solicitação: qualquer pessoa abre, se apresenta, confirma o contato e começa o próprio cadastro ou pedido. - [Termos e assinatura](https://developers.gyramais.com.br/onboarding/termos-e-assinatura.md): Modelos de termo em Markdown ou PDF, variáveis, campos posicionados, assinatura individual e conjunta, e o pacote com verificação de identidade. - [Verificação de identidade](https://developers.gyramais.com.br/onboarding/verificacao-de-identidade.md): Os três caminhos para provar quem é a pessoa: face match com documento, sem documento contra a base oficial do CPF, e o código enviado a um e-mail que o bureau já associa a ela. - [Página do destinatário](https://developers.gyramais.com.br/onboarding/pagina-do-destinatario.md): O link que o cliente final recebe: o que ele vê, como a página fica com a sua marca, domínio próprio, remetente próprio e WhatsApp próprio. - [O que é cobrado](https://developers.gyramais.com.br/onboarding/cobranca.md): Os eventos de consumo do módulo de cadastros e solicitações: o que entra na fatura, o que não entra, e por quê. - [Propostas](https://developers.gyramais.com.br/propostas/visao-geral.md): O pedido de crédito do cliente final, do momento em que entra até a oferta emitida: situações, origens e como a proposta se liga a produto, esteira e cadastro. - [Produtos e carteiras](https://developers.gyramais.com.br/propostas/produtos.md): O catálogo das suas linhas de crédito: quem pode pedir, quanto, em quanto tempo, a que taxa, com quais documentos e qual análise roda. E as carteiras que agrupam tudo. - [Precificação do produto](https://developers.gyramais.com.br/propostas/precificacao.md): Como a estrutura financeira do produto vira taxa, parcela, cronograma e CET: amortização, composição da taxa, índices de mercado, carência, encargos e simulação. - [Pré-aprovação e oferta](https://developers.gyramais.com.br/propostas/pre-aprovacao-e-oferta.md): As duas rodadas da oferta: a faixa pré-aprovada que o cliente escolhe numa página com a sua marca, e a oferta firme com cronograma congelado que segue para o contrato. - [Painel gerencial](https://developers.gyramais.com.br/propostas/gerencial.md): A aba Gerencial de Propostas: volume, aprovação, conversão, onde as propostas param, quem traz o negócio e o mix por produto, com visões salvas e exportação para Excel. - [HubSpot](https://developers.gyramais.com.br/propostas/hubspot.md): Integração nativa com o HubSpot: o negócio que entra num estágio do funil vira proposta, roda o relatório ou a esteira, e a decisão volta para o negócio. - [Esteiras](https://developers.gyramais.com.br/esteiras/visao-geral.md): A sequência de etapas que leva um pedido de crédito da análise à decisão e ao contrato, com rascunho, versões e execuções rastreáveis. - [Etapas](https://developers.gyramais.com.br/esteiras/etapas.md): Catálogo completo dos 14 tipos de etapa da esteira: o que cada um faz, o que você configura e o que acontece quando algo dá errado. - [Dados de entrada](https://developers.gyramais.com.br/esteiras/dados-de-entrada.md): Os dados da proposta, dos formulários, dos documentos e das verificações, prontos para usar nas fórmulas da esteira e nas regras da política. - [Camadas e add-ons](https://developers.gyramais.com.br/esteiras/camadas-e-add-ons.md): Como a esteira aprofunda o relatório com consultas pontuais, sem pagar duas vezes pelo mesmo dado e sem misturar fontes que se contradizem. - [Chamada de API](https://developers.gyramais.com.br/esteiras/chamada-de-api.md): A etapa que chama o seu sistema no meio da esteira: o que a GYRA+ envia, como autentica, como a resposta vira variável e o que acontece quando a chamada falha. - [Decisão, alçada e comitê](https://developers.gyramais.com.br/esteiras/decisao-alcada-e-comite.md): Como a esteira transforma o resultado das análises numa decisão e numa oferta, com revisão humana, Comitê de crédito IA e aprovação por alçada. - [Execuções](https://developers.gyramais.com.br/esteiras/execucoes.md): O que acontece quando uma esteira roda: estados, esperas, rodar de novo, proposta encerrada, fechamento externo e o webhook de fim de execução. - [Formalização](https://developers.gyramais.com.br/formalizacao/visao-geral.md): Da oferta firme ao contrato assinado: a fase da esteira que gera o contrato, colhe as assinaturas e fecha a operação com o seu sistema. - [Modelos de contrato](https://developers.gyramais.com.br/formalizacao/modelos-de-contrato.md): O seu Word vira modelo: suba o .docx, revise as variáveis, escolha quem assina, defina a numeração e publique uma versão. - [Variáveis do contrato](https://developers.gyramais.com.br/formalizacao/variaveis-do-contrato.md): O catálogo completo de variáveis do modelo de contrato: sintaxe, raízes, pessoas, oferta e cronograma, filtros de formatação, em branco e blocos prontos. - [Partes e assinaturas](https://developers.gyramais.com.br/formalizacao/partes-e-assinaturas.md): Quem entra no contrato, quem assina, em que ordem e como cada papel prova quem é: a política de partes da esteira e a configuração da assinatura. - [Clicksign](https://developers.gyramais.com.br/formalizacao/clicksign.md): Assine os contratos da esteira pela conta Clicksign da sua organização: conectar contas, envelope, autenticação, via assinada, reenviar e cancelar. - [BNDES Online](https://developers.gyramais.com.br/bndes-online/visao-geral.md): Módulo para linhas com recursos do BNDES: consulta de impedimentos, pedido de financiamento e contratação no BNDES Online, direto da esteira. - [Módulos e capacidades](https://developers.gyramais.com.br/plataforma/modulos-e-capacidades.md): O que cada módulo contratado libera no Toolbox e na API, o que aparece com cadeado e como pedir um módulo que a sua organização ainda não tem. - [Assistente GYRA+](https://developers.gyramais.com.br/plataforma/assistente-gyra.md): Peça em português, dentro do Toolbox: o Assistente GYRA+ lê a tela aberta, monta esteira e política, edita termos e contratos, age em execuções, solicitações e cadastros, e só grava depois da sua confirmação. - [Correspondentes](https://developers.gyramais.com.br/plataforma/correspondentes.md): Credencie correspondentes para originar crédito em seu nome: entrada do canal, cadastro da entidade, atendentes, validades, área de atuação, produtos e bloqueio, tudo pela tela Correspondentes. - [Visão Geral do Toolbox](https://developers.gyramais.com.br/toolbox/visao-geral.md): Mapa do Toolbox: a barra que analisa ou pergunta, o Início, o menu por grupos (Operação, Onboarding, Motor de crédito, Conta), o menu da organização e o Assistente GYRA+. - [Início](https://developers.gyramais.com.br/toolbox/inicio.md): A tela de entrada do Toolbox: uma barra que analisa CPF ou CNPJ e leva pedidos ao Assistente GYRA+, o que está esperando por você, o mês até agora e sugestões que acompanham a fase da sua organização. - [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 análise. - [Propostas no toolbox](https://developers.gyramais.com.br/toolbox/propostas.md): A tela de Propostas: a lista de pedidos, a aba Gerencial, a criação pelo operador, o detalhe com as abas Resumo, Execuções, Aprovação, Foto da aprovação e Contrato, e as ações de cada situação. - [Produtos no toolbox](https://developers.gyramais.com.br/toolbox/produtos.md): A tela de Produtos: o catálogo, o editor com identificação, valor, estrutura financeira, documentos e simulação ao vivo, e a aba Carteiras. - [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, por política ou esteira. - [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. - [Montar uma esteira](https://developers.gyramais.com.br/toolbox/montar-esteira.md): Guia da tela do construtor: criar a esteira, adicionar e configurar etapas, salvar versões, validar e ativar. - [Acompanhar execuções](https://developers.gyramais.com.br/toolbox/acompanhar-execucoes.md): Guia da tela de execuções: rodar uma esteira, ler a lista, abrir a página da execução, decidir etapas e votar na alçada. - [Contratos no toolbox](https://developers.gyramais.com.br/toolbox/contratos.md): Subir e publicar modelos de contrato, configurar a etapa Contrato e assinatura e acompanhar o contrato de cada proposta na aba Contrato. - [Clientes no toolbox](https://developers.gyramais.com.br/toolbox/cadastros.md): A tela do dossiê no Onboarding: listar clientes, abrir um cadastro, enviar e reprocessar documentos, ver o que o cliente declarou, cuidar do quadro societário e dos contatos, revisar pendências, configurar validações e acompanhar indicadores. - [Solicitações no toolbox](https://developers.gyramais.com.br/toolbox/solicitacoes.md): Pedir documentos, formulário, termo, assinatura e identidade ao cliente final por um link, no Onboarding: montar o modelo, enviar, acompanhar e resolver. - [Validação de identidade](https://developers.gyramais.com.br/toolbox/validacao-de-identidade.md): A tela do Onboarding que reúne todas as verificações de identidade da sua organização, com resultado, semelhança, prova de vida e sinais de fraude. - [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 fontes de uma política existente, com versão automática quando a mudança afeta a decisão. - [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. - [Integrações no toolbox](https://developers.gyramais.com.br/toolbox/integracoes.md): Conectar as contas Clicksign e BNDES Online da sua instituição, ligar o HubSpot ao módulo de Propostas e cadastrar as conexões de API que a esteira usa para chamar o seu sistema. - [Usuários e Permissões](https://developers.gyramais.com.br/toolbox/gerenciar-usuarios-permissoes.md): Adicionar, excluir, atribuir cargos, o que cada papel faz em cada módulo e SSO (Google Workspace, Microsoft Azure AD). - [API & MCP: chaves e webhooks](https://developers.gyramais.com.br/toolbox/webhooks-e-api-keys.md): Gerar as credenciais de API pelo painel, configurar webhooks e ligar o conector de IA, tudo em Configurações. - [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. - [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. - [Bureau de Crédito](https://developers.gyramais.com.br/sources/bureau-credito.md): Score sintético, histórico de restritivos e endividamento. - [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 por CPF ou CNPJ, com valor, cartório e data. Fonte configurável: bureau da análise ou Cenprot (cobertura nacional garantida). - [PEFIN e REFIN](https://developers.gyramais.com.br/sources/pefin-refin.md): Pendências financeiras registradas e refinanciamentos bancários. - [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. - [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. - [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. - [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. - [Inteligência de Pagamentos (Núclea)](https://developers.gyramais.com.br/sources/inteligencia-pagamentos.md): Indicadores de fluxo transacionado, predição, concentração e liquidez de PJ via Núclea (Conecta360), ativados como fonte adicional na política de crédito. - [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. - [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. - [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. - [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. - [Integrar o Onboarding](https://developers.gyramais.com.br/guides/integrar-cadastro-documental.md): Do zero ao webhook chegando, no Onboarding: credencial, primeiro documento validado, dossiê montado, o cliente entregando o que falta pelo link e o aviso no seu sistema. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [Instalação do MCP](https://developers.gyramais.com.br/mcp/instalacao.md): Conectar o MCP Server da GYRA+ no Claude.ai, Claude Desktop, Claude Code, Cursor e outros clientes MCP, entrando com o seu login (e-mail e senha ou Google). - [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. - [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. - [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. - [Gerar Token](https://developers.gyramais.com.br/api-reference/auth/post-authauthenticate.md): Troca o par de credenciais da organização por um token de acesso válido por 24 horas. - [Criar Relatório (v2)](https://developers.gyramais.com.br/api-reference/report-v2/post-v2report.md): Dispara uma análise de crédito para um CPF ou CNPJ com a política que você escolher. - [Consultar Relatório (v2)](https://developers.gyramais.com.br/api-reference/report-v2/get-v2report.md): Retorna o relatório completo, com status, progresso, seções, pareceres e resultado do comitê. - [Enviar Balanço e DRE](https://developers.gyramais.com.br/api-reference/report/post-report-financial-tab.md): Envia os PDFs do balanço patrimonial e da DRE de um relatório de CNPJ para extração e estruturação automática. - [Enviar Balanço e DRE por upload direto](https://developers.gyramais.com.br/api-reference/report/post-report-financial-tab-presign.md): Envia os PDFs do balanço e da DRE direto para o armazenamento, em dois passos, e dispara a mesma extração do envio multipart. - [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 de uma seção a partir do id da seção dentro do relatório. - [Consultar Seção por Tipo](https://developers.gyramais.com.br/api-reference/report/get-report-section.md): Retorna uma seção de um relatório pelo tipo, sem precisar do id da seção. - [Reprocessar seção com falha](https://developers.gyramais.com.br/api-reference/report/post-report-section-retry.md): Consulta de novo as fontes que falharam em uma seção do relatório, sem criar um relatório novo. - [Consultar Pareceres do Relatório](https://developers.gyramais.com.br/api-reference/report/get-reportinsights.md): Retorna apenas os pareceres de IA por seção e o resumo da decisão do comitê, sem os dados brutos do relatório. - [Convocar Comitê de Crédito IA](https://developers.gyramais.com.br/api-reference/report/post-reportcommittee.md): Dispara manualmente a deliberação do Comitê de Crédito IA sobre um relatório. - [Consultar Deliberação do Comitê](https://developers.gyramais.com.br/api-reference/committee/get-committeedeliberations.md): Retorna a deliberação completa do Comitê de Crédito IA para um relatório, com o voto de cada agente e os dados de auditoria. - [Analisar Relatório Manualmente](https://developers.gyramais.com.br/api-reference/report/post-reportanalyze.md): Registra a decisão de aprovar ou reprovar um relatório que ainda está pendente. - [Refazer Análise Manual](https://developers.gyramais.com.br/api-reference/report/post-reportre-analyze.md): Troca a decisão de um relatório e guarda a decisão anterior. - [Exportar Relatório (Assíncrono)](https://developers.gyramais.com.br/api-reference/report/get-reportexport.md): Pede a geração do PDF ou do Excel do relatório. O link chega pelo webhook REPORT_EXPORTED. - [Exportar Relatório (Síncrono)](https://developers.gyramais.com.br/api-reference/report/get-reportexport-sync.md): Gera o PDF ou o Excel do relatório e devolve o link na mesma resposta. - [Consultar políticas de decisão](https://developers.gyramais.com.br/api-reference/credit-policypolicy/get-credit-policypolicy.md): Lista as políticas da organização, com o id que vai na criação do relatório. - [Criar Webhook](https://developers.gyramais.com.br/api-reference/webhook/post-webhook.md): Cria um webhook - [Consultar Webhook](https://developers.gyramais.com.br/api-reference/webhook/get-webhookfindby.md): Busca um webhook por ID - [Remover Webhook](https://developers.gyramais.com.br/api-reference/webhook/delete-webhook.md): Remove um webhook por ID - [Visão geral da API](https://developers.gyramais.com.br/api-reference/onboarding/visao-geral.md): Endereço, autenticação, versionamento, capacidades e erros das rotas do Onboarding. Leia uma vez, vale para todas. - [Validar Documento](https://developers.gyramais.com.br/api-reference/registry/post-registry-validate-document.md): Você tem um arquivo e quer o parecer agora. - [Status do Documento](https://developers.gyramais.com.br/api-reference/registry/get-registry-documents-docid-status.md): O envio respondeu `202` e você precisa acompanhar. - [Preparar Upload de Documento](https://developers.gyramais.com.br/api-reference/registry/post-registry-id-documents-presign.md): Arquivo acima de 15 MB, ou quando você não quer segurar a conexão esperando o parecer. - [Confirmar Upload e Analisar](https://developers.gyramais.com.br/api-reference/registry/post-registry-id-documents.md): Segundo passo do envio assíncrono: o arquivo já está no armazenamento e você dispara a análise. - [Resultado do Documento](https://developers.gyramais.com.br/api-reference/registry/get-registry-id-documents-docid-result.md): Quando você precisa do detalhe: os campos lidos, cada verificação com evidência, e o parecer. - [Reprocessar Documento](https://developers.gyramais.com.br/api-reference/registry/post-registry-id-documents-docid-reprocess.md): A classificação errou o tipo, a régua mudou, ou a leitura merece outra tentativa. - [Criar Cadastro](https://developers.gyramais.com.br/api-reference/registry/post-registry.md): No início de uma jornada, para garantir que o dossiê daquele CNPJ ou CPF existe. - [Listar Cadastros](https://developers.gyramais.com.br/api-reference/registry/get-registry.md): Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação. - [Consultar Cadastro](https://developers.gyramais.com.br/api-reference/registry/get-registry-id.md): Quando você já tem o id e quer o dossiê completo. - [Consultar Cadastro por CNPJ ou CPF](https://developers.gyramais.com.br/api-reference/registry/get-registry-by-document-document.md): Antes de pedir documento ao cliente: responde o que já temos deste CNPJ? sem você guardar o id do cadastro. - [Listar Documentos do Cadastro](https://developers.gyramais.com.br/api-reference/registry/get-registry-id-documents.md): Para saber o que o dossiê já tem antes de pedir de novo. - [Árvore Societária](https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons.md): Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa. - [Pessoas, contatos e dados declarados](https://developers.gyramais.com.br/api-reference/onboarding/pessoas-e-contatos.md): Corrija um sócio, guarde e escolha os contatos de cada pessoa e leia o que o cliente respondeu nos formulários do cadastro. - [Listar Modelos de Coleta](https://developers.gyramais.com.br/api-reference/collection/get-collection-templates.md): Sempre antes de criar uma solicitação: o `slug` daqui é o que entra em `template`. - [Criar Solicitação](https://developers.gyramais.com.br/api-reference/collection/post-collections.md): Você quer que o próprio cliente entregue o que falta. - [Listar Solicitações](https://developers.gyramais.com.br/api-reference/collection/get-collections.md): Para responder quem está devendo documento?: filtre por `SENT` e `IN_PROGRESS` e olhe o prazo. - [Consultar Solicitação](https://developers.gyramais.com.br/api-reference/collection/get-collections-id.md): Para acompanhar item a item e ver o estado de entrega de cada destinatário. - [Enviar Solicitação](https://developers.gyramais.com.br/api-reference/collection/post-collections-id-send.md): Primeiro envio de um rascunho, ou reenvio de um pedido que o cliente não respondeu. - [Cancelar Solicitação](https://developers.gyramais.com.br/api-reference/collection/post-collections-id-cancel.md): A operação caiu, ou o pedido foi criado errado. - [Revisar Item](https://developers.gyramais.com.br/api-reference/collection/post-collections-id-items-itemid-review.md): Modo de resposta com revisão: a IA avaliou e a decisão é sua. - [Baixar a via assinada](https://developers.gyramais.com.br/api-reference/onboarding/via-assinada.md): Baixe o PDF assinado de um item da solicitação, conferido contra o selo gravado quando a via foi guardada. - [Catálogo de Eventos](https://developers.gyramais.com.br/api-reference/collection/get-webhook-events.md): Para montar a sua tela de configuração sem fixar a lista de eventos no código. - [Listar Assinaturas de Webhook](https://developers.gyramais.com.br/api-reference/collection/get-webhook-endpoints.md): Quando o cliente diz que parou de receber: aqui aparece se a assinatura foi desligada e por quê. - [Criar ou Atualizar Assinatura](https://developers.gyramais.com.br/api-reference/collection/post-webhook-endpoints.md): Para assinar os eventos do módulo e parar de fazer polling. - [Formatos de retorno por documento](https://developers.gyramais.com.br/api-reference/onboarding/formatos-de-retorno.md): A entrada é única, o retorno não: o objeto extraction tem os campos do tipo que a plataforma identificou. Aqui está o mapa completo, campo a campo, dos 25 tipos documentais. - [Eventos de webhook](https://developers.gyramais.com.br/api-reference/onboarding/eventos-de-webhook.md): Todos os eventos do módulo de cadastros e solicitações, agrupados por categoria, com quando disparam e o que vem em data. - [Visão geral da API de Propostas](https://developers.gyramais.com.br/api-reference/propostas/visao-geral.md): Endereço, autenticação, módulo exigido, unidades, paginação, repetição segura e erros das rotas de Propostas. Com um fluxo completo em curl. - [Propostas](https://developers.gyramais.com.br/api-reference/propostas/propostas.md): Crie, liste e leia propostas, mude a situação, inclua participantes, rode a análise e consulte a foto da aprovação. - [Ofertas](https://developers.gyramais.com.br/api-reference/propostas/ofertas.md): Copie o link da oferta, reenvie o aviso ao cliente e registre a escolha em nome dele, com motivo. - [Produtos e precificação](https://developers.gyramais.com.br/api-reference/propostas/produtos-e-precificacao.md): Leia produtos e carteiras, consulte os índices de mercado e simule o cronograma de parcelas de uma estrutura financeira. - [Indicadores gerenciais](https://developers.gyramais.com.br/api-reference/propostas/gerencial.md): Leia os números da aba Gerencial de Propostas (volume, aprovação, funil, gargalos e SLA) e exporte as propostas de um período, uma por linha. - [Dados de entrada](https://developers.gyramais.com.br/api-reference/propostas/dados-de-entrada.md): Leia o que a proposta, os formulários, os documentos e as verificações informaram, no mesmo formato de chave que a política e a esteira usam. - [Fechamento externo](https://developers.gyramais.com.br/api-reference/esteiras/fechamento-externo.md): Avise a GYRA+ que o contrato foi fechado no seu sistema: a execução que espera na etapa Aguardar fechamento externo conclui e a esteira segue. - [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, 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, 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, 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 fonte configurável entre o bureau da análise e o Cenprot (cobertura nacional). - [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, 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. - [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. - [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. - [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. - [Políticas de Decisão e Tipos de Relatório](https://developers.gyramais.com.br/docs/tipos-relatorios.md): A diferença entre tipo de relatório (escopo dos dados coletados) e política de decisão (regras que avaliam o resultado), e como os dois se combinam em cada análise. - [Dados Entregues](https://developers.gyramais.com.br/docs/dados-entregues.md): Entenda todos os dados entregues no relatório da GYRA+. - [Referência de Erros](https://developers.gyramais.com.br/reference/erros.md): Mensagens de erro que a API GYRA+ realmente devolve, com o código HTTP de cada uma, a causa e como resolver. - [Changelog](https://developers.gyramais.com.br/reference/changelog.md): Histórico de atualizações da API e da plataforma GYRA+. ## OpenAPI Specs - [openapi](/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.