# AgRisk ## Docs - Root > Documentação [AgRisk](https://docs.agrisk.app/agrisk-1941514m0.md): - Root > 🇧🇷 Português > Aprovação [Aprovação — Visão Geral](https://docs.agrisk.app/aprova%C3%A7%C3%A3o-vis%C3%A3o-geral-2272516m0.md): - Root > 🇧🇷 Português > Fluxo [Fluxo — Visão Geral](https://docs.agrisk.app/fluxo-vis%C3%A3o-geral-2272517m0.md): - Root > 🇧🇷 Português > Consulta a Bureau [Consulta a Bureau — Visão Geral](https://docs.agrisk.app/consulta-a-bureau-vis%C3%A3o-geral-2272518m0.md): - Root > 🇧🇷 Português > Campos [Campos — Visão Geral](https://docs.agrisk.app/campos-vis%C3%A3o-geral-2272519m0.md): - Root > 🇧🇷 Português > Conversa [Conversa — Visão Geral](https://docs.agrisk.app/conversa-vis%C3%A3o-geral-2272520m0.md): - Root > 🇧🇷 Português > Motores [Motores — Visão Geral](https://docs.agrisk.app/motores-vis%C3%A3o-geral-2272521m0.md): - Root > 🇧🇷 Português > Parecer [Parecer — Visão Geral](https://docs.agrisk.app/parecer-vis%C3%A3o-geral-2272522m0.md): - Root > 🇧🇷 Português > Formulário Inicial [Formulário Inicial — Visão Geral](https://docs.agrisk.app/formul%C3%A1rio-inicial-vis%C3%A3o-geral-2272523m0.md): - Root > 🇧🇷 Português > Filtros [Filtros — Visão Geral](https://docs.agrisk.app/filtros-vis%C3%A3o-geral-2272524m0.md): - Root > 🇧🇷 Português > AgRisk [AgRisk — Visão Geral](https://docs.agrisk.app/agrisk-vis%C3%A3o-geral-2272525m0.md): - Root > 🇧🇷 Português > Gatilhos [Gatilhos — Visão Geral](https://docs.agrisk.app/gatilhos-vis%C3%A3o-geral-2272526m0.md): - Root > 🇧🇷 Português > Autenticação [Autenticação — Visão Geral](https://docs.agrisk.app/autentica%C3%A7%C3%A3o-vis%C3%A3o-geral-2272527m0.md): - Root > 🇧🇷 Português > Mensageria [Mensageria — Visão Geral](https://docs.agrisk.app/mensageria-vis%C3%A3o-geral-2272528m0.md): - Root > 🇧🇷 Português > Empresas e Papéis [Empresas e Papéis — Visão Geral](https://docs.agrisk.app/empresas-e-pap%C3%A9is-vis%C3%A3o-geral-2272529m0.md): - Root > 🇧🇷 Português > Documentos [Documentos — Visão Geral](https://docs.agrisk.app/documentos-vis%C3%A3o-geral-2272530m0.md): - Root > 🇧🇷 Português > Cards [Cards — Visão Geral](https://docs.agrisk.app/cards-vis%C3%A3o-geral-2272531m0.md): - Root > 🇧🇷 Português > Configuração de Cliente [Configuração de Cliente — Visão Geral](https://docs.agrisk.app/configura%C3%A7%C3%A3o-de-cliente-vis%C3%A3o-geral-2272532m0.md): - Root > 🇧🇷 Português > Fase [Fase — Visão Geral](https://docs.agrisk.app/fase-vis%C3%A3o-geral-2272533m0.md): - Root > 🇺🇸 English > Phase [Phase — Overview](https://docs.agrisk.app/phase-overview-2272534m0.md): - Root > 🇺🇸 English > Approval [Approval — Overview](https://docs.agrisk.app/approval-overview-2272535m0.md): - Root > 🇺🇸 English > Flow [Flow — Overview](https://docs.agrisk.app/flow-overview-2272536m0.md): - Root > 🇺🇸 English > Bureau Query [Bureau Query — Overview](https://docs.agrisk.app/bureau-query-overview-2272537m0.md): - Root > 🇺🇸 English > Fields [Fields — Overview](https://docs.agrisk.app/fields-overview-2272538m0.md): - Root > 🇺🇸 English > Engines [Engines — Overview](https://docs.agrisk.app/engines-overview-2272539m0.md): - Root > 🇺🇸 English > Conversation [Conversation — Overview](https://docs.agrisk.app/conversation-overview-2272540m0.md): - Root > 🇺🇸 English > Opinion [Opinion — Overview](https://docs.agrisk.app/opinion-overview-2272541m0.md): - Root > 🇺🇸 English > Start Form [Start Form — Overview](https://docs.agrisk.app/start-form-overview-2272542m0.md): - Root > 🇺🇸 English > Filters [Filters — Overview](https://docs.agrisk.app/filters-overview-2272543m0.md): - Root > 🇺🇸 English > AgRisk [AgRisk — Overview](https://docs.agrisk.app/agrisk-overview-2272544m0.md): - Root > 🇺🇸 English > Triggers [Triggers — Overview](https://docs.agrisk.app/triggers-overview-2272545m0.md): - Root > 🇺🇸 English > Authentication [Authentication — Overview](https://docs.agrisk.app/authentication-overview-2272546m0.md): - Root > 🇺🇸 English > Messaging [Messaging — Overview](https://docs.agrisk.app/messaging-overview-2272547m0.md): - Root > 🇺🇸 English > Companies & Roles [Companies & Roles — Overview](https://docs.agrisk.app/companies-roles-overview-2272548m0.md): - Root > 🇺🇸 English > Documents [Documents — Overview](https://docs.agrisk.app/documents-overview-2272549m0.md): - Root > 🇺🇸 English > Cards [Cards — Overview](https://docs.agrisk.app/cards-overview-2272550m0.md): - Root > 🇺🇸 English > Client Configuration [Client Configuration — Overview](https://docs.agrisk.app/client-configuration-overview-2272551m0.md): - Root > 💼 Visão de Negócio [Fase](https://docs.agrisk.app/fase-2272552m0.md): - Root > 💼 Visão de Negócio [Fluxo](https://docs.agrisk.app/fluxo-2272553m0.md): - Root > 💼 Visão de Negócio [Campos — Visão de Negócio](https://docs.agrisk.app/campos-vis%C3%A3o-de-neg%C3%B3cio-2272554m0.md): - Root > 💼 Visão de Negócio [Aprovação](https://docs.agrisk.app/aprova%C3%A7%C3%A3o-2272555m0.md): - Root > 💼 Visão de Negócio [Parecer](https://docs.agrisk.app/parecer-2272556m0.md): - Root > 💼 Visão de Negócio [Motores](https://docs.agrisk.app/motores-2272557m0.md): - Root > 💼 Visão de Negócio [Empresas e Papéis](https://docs.agrisk.app/empresas-e-pap%C3%A9is-2272558m0.md): - Root > 💼 Visão de Negócio [Gatilhos](https://docs.agrisk.app/gatilhos-2272559m0.md): - Root > 💼 Visão de Negócio [Conversa](https://docs.agrisk.app/conversa-2272560m0.md): - Root > 💼 Visão de Negócio [Documentos](https://docs.agrisk.app/documentos-2272561m0.md): - Root > 💼 Visão de Negócio [Mensageria](https://docs.agrisk.app/mensageria-2272562m0.md): - Root > 💼 Visão de Negócio [Filtros](https://docs.agrisk.app/filtros-2272563m0.md): - Root > 💼 Visão de Negócio [Autenticação](https://docs.agrisk.app/autentica%C3%A7%C3%A3o-2272564m0.md): - Root > 💼 Visão de Negócio [Configuração de Cliente](https://docs.agrisk.app/configura%C3%A7%C3%A3o-de-cliente-2272565m0.md): - Root > 💼 Visão de Negócio [Cards](https://docs.agrisk.app/cards-2272566m0.md): - Root > 💼 Visão de Negócio [AgRisk](https://docs.agrisk.app/agrisk-2272567m0.md): - Root > 💼 Visão de Negócio [Formulário Inicial](https://docs.agrisk.app/formul%C3%A1rio-inicial-2272568m0.md): - Root > 💼 Visão de Negócio [Consulta a Bureau](https://docs.agrisk.app/consulta-a-bureau-2272569m0.md): - Root > 💼 Business Overview [Phase](https://docs.agrisk.app/phase-2272570m0.md): - Root > 💼 Business Overview [Flow](https://docs.agrisk.app/flow-2272571m0.md): - Root > 💼 Business Overview [Approval](https://docs.agrisk.app/approval-2272572m0.md): - Root > 💼 Business Overview [Fields — Business Overview](https://docs.agrisk.app/fields-business-overview-2272573m0.md): - Root > 💼 Business Overview [Opinion](https://docs.agrisk.app/opinion-2272574m0.md): - Root > 💼 Business Overview [Engines](https://docs.agrisk.app/engines-2272575m0.md): - Root > 💼 Business Overview [Companies & Roles](https://docs.agrisk.app/companies-roles-2272576m0.md): - Root > 💼 Business Overview [Documents](https://docs.agrisk.app/documents-2272577m0.md): - Root > 💼 Business Overview [Triggers](https://docs.agrisk.app/triggers-2272578m0.md): - Root > 💼 Business Overview [Messaging](https://docs.agrisk.app/messaging-2272579m0.md): - Root > 💼 Business Overview [Conversation](https://docs.agrisk.app/conversation-2272580m0.md): - Root > 💼 Business Overview [Filters](https://docs.agrisk.app/filters-2272581m0.md): - Root > 💼 Business Overview [Authentication](https://docs.agrisk.app/authentication-2272582m0.md): - Root > 💼 Business Overview [Client Configuration](https://docs.agrisk.app/client-configuration-2272583m0.md): - Root > 💼 Business Overview [Cards](https://docs.agrisk.app/cards-2272584m0.md): - Root > 💼 Business Overview [AgRisk](https://docs.agrisk.app/agrisk-2272585m0.md): - Root > 💼 Business Overview [Start Form](https://docs.agrisk.app/start-form-2272586m0.md): - Root > 💼 Business Overview [Bureau Query](https://docs.agrisk.app/bureau-query-2272587m0.md): - Root > Documentação > Gestão de portfolio [Análise geral](https://docs.agrisk.app/an%C3%A1lise-geral-2030271m0.md): - Root > Documentação > Gestão de portfolio [Dicionário de campos base (Necessário validar)](https://docs.agrisk.app/dicion%C3%A1rio-de-campos-base-necess%C3%A1rio-validar-2155988m0.md): - Root > Documentação > Gestão de portfolio [[Desatualizado]Fluxo de funcionamento](https://docs.agrisk.app/desatualizadofluxo-de-funcionamento-2155991m0.md): - Root > Documentação > Gestão de portfolio > Carteiras [Gestão da carteira](https://docs.agrisk.app/gest%C3%A3o-da-carteira-2032347m0.md): - Root > Documentação > Gestão de portfolio > Contratos [Contratos](https://docs.agrisk.app/contratos-2080676m0.md): - Root > Documentação > Gestão de portfolio > Contratos [Template Contratos](https://docs.agrisk.app/template-contratos-2069268m0.md): - Root > Documentação > Gestão de portfolio > Pagamentos [Pagamentos ](https://docs.agrisk.app/pagamentos-2073082m0.md): - Root > Documentação > Gestão de portfolio > Baixas [Baixas](https://docs.agrisk.app/baixas-2073083m0.md): - Root > Documentação > Gestão de portfolio > Clientes [Devedores e credores (Participantes)](https://docs.agrisk.app/devedores-e-credores-participantes-2080515m0.md): - Root > Documentação > Gestão de portfolio > Clientes [Informações dos clientes](https://docs.agrisk.app/informa%C3%A7%C3%B5es-dos-clientes-2155987m0.md): - Root > Documentação > Gestão de portfolio > Importação de dados [Importação de dados](https://docs.agrisk.app/importa%C3%A7%C3%A3o-de-dados-2049322m0.md): - Root > Documentação > Gestão de portfolio > Garantia [Colaterais](https://docs.agrisk.app/colaterais-2073081m0.md): - Root > Documentação > Gestão de Cobrança > Régua de cobrança [Regras da régua por empresa](https://docs.agrisk.app/regras-da-r%C3%A9gua-por-empresa-2047300m0.md): - Root > Documentação > Gestão de Cobrança > Atividades [Regras das Atividades](https://docs.agrisk.app/regras-das-atividades-2057366m0.md): ## API Docs - Root > API - AgRisk > Login [Atualizar token](https://docs.agrisk.app/atualizar-token-32021257e0.md): - Root > API - AgRisk > Login [Autenticar usuário](https://docs.agrisk.app/autenticar-usu%C3%A1rio-29174538e0.md): Realiza a autenticação do usuário na plataforma, retornando o token utilizado no header das outras requisições. - Root > API - AgRisk > Consultas [Solicitar consulta](https://docs.agrisk.app/solicitar-consulta-29174539e0.md): Solicita a criação de uma consulta para um ou mais clientes. - Root > API - AgRisk > Consultas [Listar consultas](https://docs.agrisk.app/listar-consultas-29174540e0.md): Listagem de consultas de um cliente pelo identificador. - Root > API - AgRisk > Consultas [Listar consultas da empresa](https://docs.agrisk.app/listar-consultas-da-empresa-29174541e0.md): Listagem de consultas da empresa pelo identificador. - Root > API - AgRisk > Listagem de Produtos [Listar produtos](https://docs.agrisk.app/listar-produtos-29174542e0.md): Listagem de produtos que podem ser consultados pelo usuário autenticado. - Root > API - AgRisk > Clientes [Listar clientes](https://docs.agrisk.app/listar-clientes-29174543e0.md): Listagem de clientes cadastrados. - Root > API - AgRisk > Clientes [Criar cliente](https://docs.agrisk.app/criar-cliente-29174544e0.md): Cadastrar cliente. - Root > API - AgRisk > Clientes [Listar contadores de clientes](https://docs.agrisk.app/listar-contadores-de-clientes-29174545e0.md): Listagem de contadores de clientes por tipo (PF, PJ ou grupo). - Root > API - AgRisk > Clientes [Deletar cliente](https://docs.agrisk.app/deletar-cliente-29174546e0.md): Deletar cliente pelo identificador. - Root > API - AgRisk > Clientes [Listar contadores de clientes no grupo](https://docs.agrisk.app/listar-contadores-de-clientes-no-grupo-29174547e0.md): Listagem de contadores de clientes cadastrados no grupo por tipo (PF ou PJ). - Root > API - AgRisk > Dados Cadastrais [Buscar dados cadastrais](https://docs.agrisk.app/buscar-dados-cadastrais-29174548e0.md): Buscar dados cadastrais de um cliente pelo identificador. - Root > API - AgRisk > Grupos [Listar grupos](https://docs.agrisk.app/listar-grupos-29174549e0.md): Listagem de grupos cadastrados. - Root > API - AgRisk > Grupos [Criar grupo](https://docs.agrisk.app/criar-grupo-29174550e0.md): Cadastrar grupo. - Root > API - AgRisk > Grupos [Listar clientes em grupo](https://docs.agrisk.app/listar-clientes-em-grupo-29174551e0.md): Listagem de clientes cadastrados em grupo. - Root > API - AgRisk > Grupos [Criar cliente em grupo](https://docs.agrisk.app/criar-cliente-em-grupo-29174552e0.md): Cadastar cliente em um grupo. - Root > API - AgRisk > Grupos [Atualizar nome do grupo](https://docs.agrisk.app/atualizar-nome-do-grupo-29174553e0.md): Atualizar nome do grupo pelo identificador. - Root > API - AgRisk > Grupos [Deletar grupo](https://docs.agrisk.app/deletar-grupo-29174554e0.md): Deletar grupo pelo identificador. - Root > API - AgRisk > Grupos [Inserir cliente em grupo](https://docs.agrisk.app/inserir-cliente-em-grupo-29174555e0.md): Inserir cliente cadastrado em um grupo pelo identificador. - Root > API - AgRisk > Grupos [Remover cliente de grupo](https://docs.agrisk.app/remover-cliente-de-grupo-29174556e0.md): Remover cliente de grupo pelo identificador. - Root > API - AgRisk > Análise de Matrícula [Listar análises de matrículas](https://docs.agrisk.app/listar-an%C3%A1lises-de-matr%C3%ADculas-29174557e0.md): Listagem de todas as análises de matrículas do cliente. - Root > API - AgRisk > Análise de Matrícula [Criar análise de matrícula](https://docs.agrisk.app/criar-an%C3%A1lise-de-matr%C3%ADcula-29174558e0.md): Solicitar uma análise de matrícula. - Root > API - AgRisk > Análise de Matrícula [Buscar análise de matrícula](https://docs.agrisk.app/buscar-an%C3%A1lise-de-matr%C3%ADcula-29174559e0.md): Buscar análise de matrícula pelo identificador. - Root > API - AgRisk > Análise de Matrícula [Deletar análise de matrícula](https://docs.agrisk.app/deletar-an%C3%A1lise-de-matr%C3%ADcula-29174560e0.md): Deletar análise de matrícula pelo identificador. - Root > API - AgRisk > Contatos [Listar contatos](https://docs.agrisk.app/listar-contatos-29174561e0.md): Listagem de contatos do cliente pelo identificador. - Root > API - AgRisk > BNDES [Listar BNDES](https://docs.agrisk.app/listar-bndes-29174562e0.md): Listagem de BNDES do cliente pelo identificador. - Root > API - AgRisk > Boa Vista [Listar Boa Vista](https://docs.agrisk.app/listar-boa-vista-29174563e0.md): Listagem de Boa Vista do cliente pelo identificador. - Root > API - AgRisk > Compliance [Listar compliance](https://docs.agrisk.app/listar-compliance-29174564e0.md): Listagem de compliance do cliente pelo identificador. - Root > API - AgRisk > CPRs [Listar CPRs](https://docs.agrisk.app/listar-cprs-29174565e0.md): Listagem de CPRs do cliente pelo identificador. - Root > API - AgRisk > CPRs [Buscar CPR](https://docs.agrisk.app/buscar-cpr-29174566e0.md): Buscar CPR pelo identificador. - Root > API - AgRisk > Grupo econômico > familiar [Listar grupo econômico](https://docs.agrisk.app/listar-grupo-econ%C3%B4mico-29174567e0.md): Listagem de grupo econômico do cliente pelo identificador. - Root > API - AgRisk > Grupo econômico > familiar [Listar grupo familiar](https://docs.agrisk.app/listar-grupo-familiar-29174568e0.md): Listagem de grupo econômico do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Criar ativo financeiro](https://docs.agrisk.app/criar-ativo-financeiro-29174569e0.md): Criar ativo financeiro. - Root > API - AgRisk > Imposto de Renda [Listar ativos financeiros](https://docs.agrisk.app/listar-ativos-financeiros-29174570e0.md): Listagem de ativos financeiros do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Criar dívida](https://docs.agrisk.app/criar-d%C3%ADvida-29174571e0.md): Criar dívida. - Root > API - AgRisk > Imposto de Renda [Importar dívidas](https://docs.agrisk.app/importar-d%C3%ADvidas-29174572e0.md): Importar dívidas do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Listar dívidas](https://docs.agrisk.app/listar-d%C3%ADvidas-29174573e0.md): Listagem de dívidas do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Atualizar dívida](https://docs.agrisk.app/atualizar-d%C3%ADvida-29174574e0.md): Atualizar dívida pelo identificador. - Root > API - AgRisk > Imposto de Renda [Deletar dívida](https://docs.agrisk.app/deletar-d%C3%ADvida-29174575e0.md): Deletar dívida pelo identificador. - Root > API - AgRisk > Imposto de Renda [Criar ativo móvel](https://docs.agrisk.app/criar-ativo-m%C3%B3vel-29174576e0.md): Criar ativo móvel. - Root > API - AgRisk > Imposto de Renda [Listar ativos móveis](https://docs.agrisk.app/listar-ativos-m%C3%B3veis-29174577e0.md): Listagem de ativos móveis do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Atualizar ativo móvel](https://docs.agrisk.app/atualizar-ativo-m%C3%B3vel-29174578e0.md): Atualizar ativo móvel pelo identificador. - Root > API - AgRisk > Imposto de Renda [Deletar ativo móvel](https://docs.agrisk.app/deletar-ativo-m%C3%B3vel-29174579e0.md): Deletar ativo móvel pelo identificador. - Root > API - AgRisk > Imposto de Renda [Criar imóvel urbano](https://docs.agrisk.app/criar-im%C3%B3vel-urbano-29174580e0.md): Criar imóvel urbano. - Root > API - AgRisk > Imposto de Renda [Listar imóveis urbanos](https://docs.agrisk.app/listar-im%C3%B3veis-urbanos-29174581e0.md): Listagem de imóveis urbanos do cliente pelo identificador. - Root > API - AgRisk > Imposto de Renda [Atualizar imóvel urbano](https://docs.agrisk.app/atualizar-im%C3%B3vel-urbano-29174582e0.md): Atualizar imóvel urbano pelo identificador. - Root > API - AgRisk > Imposto de Renda [Deletar imóvel urbano](https://docs.agrisk.app/deletar-im%C3%B3vel-urbano-29174583e0.md): Deletar imóvel urbano pelo identificador. - Root > API - AgRisk > Judicial [Listar processos judiciais](https://docs.agrisk.app/listar-processos-judiciais-29174584e0.md): Listagem de processos judiciais do cliente pelo identificador. - Root > API - AgRisk > Judicial [Buscar processo judicial](https://docs.agrisk.app/buscar-processo-judicial-29174585e0.md): Buscar processo judicial pelo identificador. - Root > API - AgRisk > Judicial [Solicitar análise por IA](https://docs.agrisk.app/solicitar-an%C3%A1lise-por-ia-29174586e0.md): Solicitar análise de processo judicial por IA pelo identificador. - Root > API - AgRisk > Protestos [Listar protestos](https://docs.agrisk.app/listar-protestos-29174587e0.md): Listagem de protestos do cliente pelo identificador. - Root > API - AgRisk > Imóveis Rurais - Simples [Criar imóvel rural](https://docs.agrisk.app/criar-im%C3%B3vel-rural-29174588e0.md): Criar imóvel rural. - Root > API - AgRisk > Imóveis Rurais - Simples [Listar imóveis rurais](https://docs.agrisk.app/listar-im%C3%B3veis-rurais-29174589e0.md): Listagem de imóveis rurais do cliente pelo identificador. - Root > API - AgRisk > Imóveis Rurais - Simples [Buscar imóvel rural](https://docs.agrisk.app/buscar-im%C3%B3vel-rural-29174590e0.md): Buscar imóvel rural pelo identificador. - Root > API - AgRisk > Endividamento [Listar SCR (endividamento)](https://docs.agrisk.app/listar-scr-endividamento-29174591e0.md): Listagem de SCR (endividamento) do cliente pelo identificador. - Root > API - AgRisk > Imóveis Rurais - CAR [Listar CAR (Cadastro Ambiental Rural)](https://docs.agrisk.app/listar-car-cadastro-ambiental-rural-29174593e0.md): Listagem de CARs (Cadastro Ambiental Rural) do cliente pelo identificador. - Root > API - AgRisk > Imóveis Rurais - CAR [Buscar CAR](https://docs.agrisk.app/buscar-car-29174594e0.md): Buscar CAR pelo identificador. - Root > API - AgRisk > Imóveis Rurais - CAR [Deletar CAR](https://docs.agrisk.app/deletar-car-29174595e0.md): Deletar CAR pelo identificador. - Root > API - AgRisk > Imóveis Rurais - CAR [Criar CAR](https://docs.agrisk.app/criar-car-29174596e0.md): Criar CAR. - Root > API - AgRisk > Imóveis Rurais - CAR [Download certidão CAR](https://docs.agrisk.app/download-certid%C3%A3o-car-29174597e0.md): Download da certidão do CAR em Base64 pelo identificador. - Root > API - AgRisk > QUOD [Buscar Quod](https://docs.agrisk.app/buscar-quod-29174598e0.md): Buscar Quod pelo identificador. - Root > API - AgRisk > Restritivo Nacional [Buscar Restritivo Nacional](https://docs.agrisk.app/buscar-restritivo-nacional-29174599e0.md): Buscar Restritivo Nacional pelo identificador. - Root > API - AgRisk > Veicular [Buscar Patrimônio Veicular](https://docs.agrisk.app/buscar-patrim%C3%B4nio-veicular-29174600e0.md): Buscar Patrimônio Veicular pelo identificador. - Root > API - AgRisk > Sintegra [Listar Sintegras](https://docs.agrisk.app/listar-sintegras-29174592e0.md): Listagem de Sintegras do cliente pelo identificador. - Root > 🇧🇷 Português > Aprovação [Consultar configuração de aprovação](https://docs.agrisk.app/consultar-configura%C3%A7%C3%A3o-de-aprova%C3%A7%C3%A3o-40857332e0.md): Retorna a configuração de alçada de aprovação cadastrada em uma fase, incluindo os parâmetros gerais da votação e as regras (rules) já criadas, cada uma com seus critérios de disparo e a hierarquia de aprovadores correspondente. - Root > 🇧🇷 Português > Aprovação [Criar configuração de aprovação](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-aprova%C3%A7%C3%A3o-40857333e0.md): Cria a configuração base da alçada de aprovação de uma fase — os parâmetros gerais da votação, sem regras e sem aprovadores. - Root > 🇧🇷 Português > Aprovação [Atualizar configuração de aprovação](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-de-aprova%C3%A7%C3%A3o-40857334e0.md): Atualiza a configuração base de uma alçada de aprovação já existente em uma fase. - Root > 🇧🇷 Português > Aprovação [Adicionar regra de aprovação](https://docs.agrisk.app/adicionar-regra-de-aprova%C3%A7%C3%A3o-40857335e0.md): Adiciona uma regra à configuração de aprovação de uma fase. Uma regra define, por meio de condições, quando ela se aplica a um card, e quem são os aprovadores responsáveis por votar quando ela é acionada. - Root > 🇧🇷 Português > Aprovação [Atualizar regra de aprovação](https://docs.agrisk.app/atualizar-regra-de-aprova%C3%A7%C3%A3o-40857336e0.md): Atualiza uma regra já existente na configuração de aprovação de uma fase. A chamada substitui a regra por completo — envie novamente todas as condições e a hierarquia de aprovadores desejada, e não apenas o campo alterado. - Root > 🇧🇷 Português > Aprovação [Remover configuração de aprovação](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-de-aprova%C3%A7%C3%A3o-40857337e0.md): Remove a configuração de aprovação de uma fase por completo, incluindo todas as regras associadas a ela. - Root > 🇧🇷 Português > Aprovação [Consultar aprovação do card](https://docs.agrisk.app/consultar-aprova%C3%A7%C3%A3o-do-card-40857338e0.md): Consulta o registro de votação de aprovação de um card — os votos já registrados, o comentário e o valor informado por cada aprovador, e o resultado consolidado da alçada até o momento. - Root > 🇧🇷 Português > Aprovação [Registrar voto de aprovação](https://docs.agrisk.app/registrar-voto-de-aprova%C3%A7%C3%A3o-40857339e0.md): Registra um novo voto de aprovação para um card, na fase indicada. A chamada é usada pelo aprovador atual dentro da alçada configurada para a fase — a fase precisa ter ao menos uma regra de aprovação já cadastrada; caso contrário, a chamada retorna erro por não localizar uma regra aplicável ao card. - Root > 🇧🇷 Português > Aprovação [Atualizar voto de aprovação](https://docs.agrisk.app/atualizar-voto-de-aprova%C3%A7%C3%A3o-40857340e0.md): Atualiza um voto de aprovação já registrado para um card em uma fase. Utiliza os mesmos campos e regras de validação do registro de um novo voto: `status`, `value` e `comment` são obrigatórios, e um `status` de rejeição exige `value` igual a zero. - Root > 🇧🇷 Português > Fluxo [Verificar disponibilidade](https://docs.agrisk.app/verificar-disponibilidade-40857341e0.md): Endpoint de monitoramento simples, que não exige autenticação, utilizado para verificar se a API AgFlow está disponível. Não retorna nenhum dado de negócio — serve apenas como sonda de disponibilidade (liveness check) para ferramentas de monitoramento externas. - Root > 🇧🇷 Português > Fluxo [Criar fluxo](https://docs.agrisk.app/criar-fluxo-40857342e0.md): Cria um novo flow (processo de negócio) dentro da empresa autenticada. - Root > 🇧🇷 Português > Fluxo [Listar fluxos](https://docs.agrisk.app/listar-fluxos-40857343e0.md): Retorna os flows da empresa autenticada. - Root > 🇧🇷 Português > Fluxo [Obter fluxo](https://docs.agrisk.app/obter-fluxo-40857344e0.md): Retorna os dados de um flow específico, incluindo nome, descrição, ícone, cor e as etiquetas (`labelOptions`) configuradas. - Root > 🇧🇷 Português > Fluxo [Atualizar fluxo](https://docs.agrisk.app/atualizar-fluxo-40857345e0.md): Atualiza os dados de um flow existente. - Root > 🇧🇷 Português > Fluxo [Remover fluxo](https://docs.agrisk.app/remover-fluxo-40857346e0.md): Remove um flow por completo, incluindo suas fases, cards e configurações associadas (aprovação, parecer, motores, mensageria, entre outras). - Root > 🇧🇷 Português > Fluxo [Adicionar usuário ao fluxo](https://docs.agrisk.app/adicionar-usu%C3%A1rio-ao-fluxo-40857347e0.md): Concede a um usuário acesso a um flow, associando-o a um cargo (role) específico dentro dele. - Root > 🇧🇷 Português > Fluxo [Remover usuário do fluxo](https://docs.agrisk.app/remover-usu%C3%A1rio-do-fluxo-40857348e0.md): Remove o acesso de um usuário a um flow. O cargo (role) associado ao usuário neste flow também deixa de se aplicar — a remoção não afeta o acesso do usuário a outros flows da mesma empresa. - Root > 🇧🇷 Português > Fluxo [Listar caminhos de campos dinâmicos](https://docs.agrisk.app/listar-caminhos-de-campos-din%C3%A2micos-40857349e0.md): Retorna o catálogo de caminhos (paths) de campos disponíveis para referenciar em condições, regras e templates deste flow — por exemplo, ao montar a condição de um trigger ou o filtro de uma automação. - Root > 🇧🇷 Português > Consulta a Bureau [Obter configuração de consulta a bureau](https://docs.agrisk.app/obter-configura%C3%A7%C3%A3o-de-consulta-a-bureau-40857350e0.md): Retorna a configuração de consulta a bureau (query-config) definida para uma fase — incluindo o título da configuração e a lista de identificadores dos produtos de bureau/AgRisk que serão consultados quando um card entrar nessa fase. - Root > 🇧🇷 Português > Consulta a Bureau [Criar configuração de consulta a bureau](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-consulta-a-bureau-40857351e0.md): Cria a configuração de consulta a bureau (query-config) de uma fase, definindo o título da configuração e a lista de identificadores dos produtos de bureau/AgRisk que serão consultados quando um card entrar na fase. - Root > 🇧🇷 Português > Consulta a Bureau [Atualizar configuração de consulta a bureau](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-de-consulta-a-bureau-40857352e0.md): Atualiza a configuração de consulta a bureau (query-config) já existente de uma fase, substituindo o título e a lista de identificadores dos produtos de bureau/AgRisk a serem consultados. - Root > 🇧🇷 Português > Campos [Listar campos da fase](https://docs.agrisk.app/listar-campos-da-fase-40857353e0.md): Retorna os campos customizados configurados em uma fase do flow — os campos exibidos e preenchidos pelos usuários enquanto um card permanece nessa etapa do processo. - Root > 🇧🇷 Português > Campos [Atualizar campos da fase](https://docs.agrisk.app/atualizar-campos-da-fase-40857354e0.md): Substitui integralmente a lista de campos customizados de uma fase. Esta operação é full-replace: o array `fields` enviado passa a ser a configuração completa da fase — não é possível adicionar ou remover um campo isoladamente, o conjunto inteiro precisa ser reenviado a cada chamada. - Root > 🇧🇷 Português > Campos [Atualizar regras de campos da fase](https://docs.agrisk.app/atualizar-regras-de-campos-da-fase-40857355e0.md): Configura regras condicionais entre os campos de uma fase — por exemplo, exibir, ocultar ou tornar obrigatório um campo com base no valor de outro campo (gatilho `onChange`), ou calcular automaticamente o valor de um campo a partir de uma expressão envolvendo outros campos (gatilho `onCalculate`). - Root > 🇧🇷 Português > Conversa [Obter configuração de conversa](https://docs.agrisk.app/obter-configura%C3%A7%C3%A3o-de-conversa-40857356e0.md): Retorna a configuração de conversa (conversation-config) atualmente definida em uma fase — a estrutura de mensagens de WhatsApp usada para capturar, diretamente por mensagem, as respostas de quem participa de uma etapa de aprovação ou validação, sem que essa pessoa precise acessar o AgFlow. - Root > 🇧🇷 Português > Conversa [Criar configuração de conversa](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-conversa-40857357e0.md): Cria a configuração de conversa (conversation-config) de uma fase — uma máquina de estados de modelos de mensagem WhatsApp que permite capturar respostas diretamente por mensagem, sem que a pessoa envolvida precise acessar o AgFlow. É comumente usada para conduzir aprovações inteiramente por WhatsApp. - Root > 🇧🇷 Português > Conversa [Remover configuração de conversa](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-de-conversa-40857358e0.md): Remove definitivamente a configuração de conversa identificada por `id`. A resposta de sucesso não retorna conteúdo. - Root > 🇧🇷 Português > Motores [Consultar resultado do motor de decisão do card](https://docs.agrisk.app/consultar-resultado-do-motor-de-decis%C3%A3o-do-card-40857359e0.md): Consulta o resultado mais recente do motor de decisão para o cliente vinculado ao card informado. - Root > 🇧🇷 Português > Motores [Executar motor de decisão no card](https://docs.agrisk.app/executar-motor-de-decis%C3%A3o-no-card-40857360e0.md): Executa o motor de decisão configurado no flow para o cliente vinculado ao card informado, processando os dados atuais do card e do cliente através da política Taktile e retornando o resultado por módulo. - Root > 🇧🇷 Português > Motores [Consultar inputs do motor de crédito para o card](https://docs.agrisk.app/consultar-inputs-do-motor-de-cr%C3%A9dito-para-o-card-40857361e0.md): Retorna os valores de entrada (`inputs`) que seriam enviados à política Taktile do motor de crédito para o cliente vinculado ao card informado — sem executar o motor. Útil para inspecionar, antes de rodar a análise, exatamente quais valores do card e do cliente estão sendo mapeados para cada input configurado (`input[]`) na configuração do motor de crédito do flow. - Root > 🇧🇷 Português > Motores [Consultar resultado do motor de crédito do card](https://docs.agrisk.app/consultar-resultado-do-motor-de-cr%C3%A9dito-do-card-40857362e0.md): Consulta o resultado mais recente do motor de crédito para o cliente vinculado ao card informado — pontuação (`score`), classificação (`rating`), valor sugerido (`value`) e os critérios agrupados em `output[]`, calculados pela política Taktile. - Root > 🇧🇷 Português > Motores [Executar motor de crédito no card](https://docs.agrisk.app/executar-motor-de-cr%C3%A9dito-no-card-40857363e0.md): Executa (ou reexecuta) o motor de crédito configurado no flow para o cliente vinculado ao card informado, processando os dados atuais através da política Taktile e retornando pontuação (`score`), classificação (`rating`), valor sugerido (`value`) e os critérios em `output[]`. - Root > 🇧🇷 Português > Motores [Consultar configuração do motor de decisão](https://docs.agrisk.app/consultar-configura%C3%A7%C3%A3o-do-motor-de-decis%C3%A3o-40857364e0.md): Retorna a configuração do motor de decisão associada ao flow informado — a política Taktile vinculada (`policyId`) e os mapeamentos de entrada (`input[]`) e saída (`output[]`) definidos. - Root > 🇧🇷 Português > Motores [Criar configuração do motor de decisão](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-do-motor-de-decis%C3%A3o-40857365e0.md): Cria a configuração do motor de decisão de um flow, vinculando-a a uma política Taktile previamente registrada (`policyId`) e definindo os mapeamentos de entrada (`input[]`) e saída (`output[]`). - Root > 🇧🇷 Português > Motores [Atualizar configuração do motor de decisão](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-do-motor-de-decis%C3%A3o-40857366e0.md): Atualiza a configuração do motor de decisão existente do flow, substituindo integralmente o `input[]`/`output[]` informado. - Root > 🇧🇷 Português > Motores [Remover configuração do motor de decisão](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-do-motor-de-decis%C3%A3o-40857367e0.md): Remove a configuração do motor de decisão do flow. - Root > 🇧🇷 Português > Motores [Consultar detalhe da configuração do motor de crédito](https://docs.agrisk.app/consultar-detalhe-da-configura%C3%A7%C3%A3o-do-motor-de-cr%C3%A9dito-40857368e0.md): Retorna o detalhe completo de uma configuração do motor de crédito, a partir do seu identificador. - Root > 🇧🇷 Português > Motores [Criar configuração do motor de crédito](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-do-motor-de-cr%C3%A9dito-40857369e0.md): Cria a configuração do motor de crédito de um flow, vinculando-a a uma política Taktile previamente registrada (`policyId`) e definindo os mapeamentos de entrada (`input[]`) e saída (`output[]`). - Root > 🇧🇷 Português > Motores [Listar configurações do motor de crédito do flow](https://docs.agrisk.app/listar-configura%C3%A7%C3%B5es-do-motor-de-cr%C3%A9dito-do-flow-40857370e0.md): Lista as configurações do motor de crédito registradas no flow — normalmente uma única configuração ativa por flow — retornando, para cada uma, um identificador (`id`), título e descrição resumidos. - Root > 🇧🇷 Português > Motores [Listar políticas de crédito aplicáveis a um card](https://docs.agrisk.app/listar-pol%C3%ADticas-de-cr%C3%A9dito-aplic%C3%A1veis-a-um-card-40857371e0.md): Lista as configurações do motor de crédito do flow aplicáveis ao card e cliente informados, na ordem em que devem ser consideradas. - Root > 🇧🇷 Português > Motores [Atualizar configuração do motor de crédito](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-do-motor-de-cr%C3%A9dito-40857372e0.md): Atualiza a configuração do motor de crédito existente do flow, substituindo integralmente o `input[]`/`output[]` informado. - Root > 🇧🇷 Português > Motores [Remover configuração do motor de crédito](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-do-motor-de-cr%C3%A9dito-40857373e0.md): Remove a configuração do motor de crédito do flow. - Root > 🇧🇷 Português > Parecer [Consultar configuração do parecer técnico](https://docs.agrisk.app/consultar-configura%C3%A7%C3%A3o-do-parecer-t%C3%A9cnico-40857374e0.md): Retorna a configuração do parecer técnico (opinion) associada ao fluxo, incluindo o título exibido aos analistas e a lista de campos complementares cadastrados. - Root > 🇧🇷 Português > Parecer [Criar configuração do parecer técnico](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-do-parecer-t%C3%A9cnico-40857375e0.md): Cria a configuração do parecer técnico (opinion) de um fluxo, habilitando a coleta de um parecer estruturado nas fases de análise. - Root > 🇧🇷 Português > Parecer [Atualizar configuração do parecer técnico](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-do-parecer-t%C3%A9cnico-40857376e0.md): Atualiza (substitui) a configuração do parecer técnico do fluxo. Assim como na criação, o payload aceita apenas `title` e `fields` no nível superior — as mesmas chaves proibidas (description, blocksMovement, slug, uiComponent, active, rules) continuam sendo rejeitadas com erro 400. - Root > 🇧🇷 Português > Parecer [Consultar parecer registrado no card](https://docs.agrisk.app/consultar-parecer-registrado-no-card-40857377e0.md): Retorna o parecer técnico registrado para um card em uma fase específica: o status definido pelo analista (aprovado ou reprovado), o valor aprovado, o texto do parecer e os valores preenchidos nos campos complementares configurados no fluxo. - Root > 🇧🇷 Português > Parecer [Registrar parecer no card](https://docs.agrisk.app/registrar-parecer-no-card-40857378e0.md): Registra o parecer técnico de um analista para um card em uma fase específica. O corpo da requisição usa três campos nativos no nível superior — `status`, `value` e `opinion` — além de um array `fields` para os valores dos campos complementares configurados no fluxo. - Root > 🇧🇷 Português > Parecer [Atualizar parecer no card](https://docs.agrisk.app/atualizar-parecer-no-card-40857379e0.md): Atualiza o parecer técnico já registrado para um card em uma fase específica, usando o mesmo formato de corpo da criação (`status`, `value`, `opinion` e `fields`). Use esta chamada para revisar um parecer existente — por exemplo, corrigir o valor aprovado ou complementar o texto — sem criar um novo registro. - Root > 🇧🇷 Português > Formulário Inicial [Criar formulário inicial](https://docs.agrisk.app/criar-formul%C3%A1rio-inicial-40857380e0.md): Cria o formulário inicial (ficha de cadastro) de um flow que ainda não possui um. O formulário inicial é a etapa preenchida por quem solicita, e sua submissão é o que gera um novo card no flow. - Root > 🇧🇷 Português > Formulário Inicial [Definir regras condicionais do formulário](https://docs.agrisk.app/definir-regras-condicionais-do-formul%C3%A1rio-40857381e0.md): Define, substituindo por completo as regras vigentes, o comportamento condicional do formulário inicial — reações a mudanças de valor em um campo, ou o cálculo automático do valor de um campo. - Root > 🇧🇷 Português > Formulário Inicial [Atualizar metadados do formulário](https://docs.agrisk.app/atualizar-metadados-do-formul%C3%A1rio-40857382e0.md): Atualiza os metadados do formulário inicial já existente: título, cor de fundo, texto do botão de criação, descrição, logotipo e a fase inicial associada. - Root > 🇧🇷 Português > Formulário Inicial [Consultar formulário inicial](https://docs.agrisk.app/consultar-formul%C3%A1rio-inicial-40857383e0.md): Retorna a configuração completa do formulário inicial de um flow: metadados (título, cor de fundo, texto do botão, descrição, logotipo) e a lista completa de campos (`fields`), incluindo identificadores, tipos, seções e — quando configuradas — as regras condicionais associadas a cada campo. - Root > 🇧🇷 Português > Formulário Inicial [Consultar formulário público](https://docs.agrisk.app/consultar-formul%C3%A1rio-p%C3%BAblico-40857384e0.md): Retorna a versão pública do formulário inicial, no formato utilizado pela página de preenchimento voltada a quem solicita — o mesmo conteúdo exibido fora de uma sessão de usuário autenticada da plataforma. - Root > 🇧🇷 Português > Formulário Inicial [Atualizar campos do formulário](https://docs.agrisk.app/atualizar-campos-do-formul%C3%A1rio-40857385e0.md): Substitui por completo a lista de campos (`fields`) do formulário inicial. É uma substituição integral — o array enviado passa a ser o conteúdo total do formulário. - Root > 🇧🇷 Português > Formulário Inicial [Remover formulário inicial](https://docs.agrisk.app/remover-formul%C3%A1rio-inicial-40857386e0.md): Remove definitivamente o formulário inicial de um flow. - Root > 🇧🇷 Português > Filtros [Listar filtros salvos](https://docs.agrisk.app/listar-filtros-salvos-40857387e0.md): Retorna os filtros salvos do flow associados ao usuário autenticado. - Root > 🇧🇷 Português > Filtros [Criar filtro salvo](https://docs.agrisk.app/criar-filtro-salvo-40857388e0.md): Cria o filtro salvo do usuário autenticado para o flow informado — uma visualização pré-configurada do kanban, com ordenação, projeção de campos e condições próprias. - Root > 🇧🇷 Português > Filtros [Atualizar filtro salvo](https://docs.agrisk.app/atualizar-filtro-salvo-40857389e0.md): Atualiza o filtro salvo do usuário autenticado para o flow informado, substituindo integralmente a ordenação, o limite, a projeção de campos e as condições anteriores pelo conteúdo enviado. - Root > 🇧🇷 Português > Filtros [Buscar cards do flow](https://docs.agrisk.app/buscar-cards-do-flow-40857390e0.md): Executa uma busca de cards dentro de um único flow, usando uma linguagem de condições que aceita árvores de filtros aninhadas e agregações sobre coleções. - Root > 🇧🇷 Português > Filtros [Busca global de cards](https://docs.agrisk.app/busca-global-de-cards-40857391e0.md): Executa uma busca de cards entre todos os flows acessíveis ao usuário autenticado, em vez de restringir a busca a um único flow. Use este endpoint quando a busca precisar abranger cards de mais de um flow simultaneamente; para restringir a busca a um flow específico, utilize o endpoint de busca por flow (`/v1/filters/flows/{flowId}/search`). - Root > 🇧🇷 Português > AgRisk [Listar produtos de consulta AgRisk](https://docs.agrisk.app/listar-produtos-de-consulta-agrisk-40857392e0.md): Retorna o catálogo de produtos de consulta de bureau de crédito disponíveis na AgRisk, a camada de dados externos integrada à API AgFlow. Cada produto representa um tipo de consulta — como registros de restrições financeiras, protestos, ações judiciais, patrimônio veicular ou cadastro de propriedades — identificado por um `id` e um `name` legível. - Root > 🇧🇷 Português > Gatilhos [Listar gatilhos do flow](https://docs.agrisk.app/listar-gatilhos-do-flow-40857393e0.md): Retorna todos os gatilhos configurados nas fases de um flow. - Root > 🇧🇷 Português > Gatilhos [Criar gatilho](https://docs.agrisk.app/criar-gatilho-40857394e0.md): Cria um novo gatilho (trigger) em uma fase do flow. - Root > 🇧🇷 Português > Gatilhos [Atualizar gatilho](https://docs.agrisk.app/atualizar-gatilho-40857395e0.md): Atualiza um gatilho existente. Esta operação substitui integralmente os dados do gatilho — campos e ações não incluídos no payload não são preservados do estado anterior. - Root > 🇧🇷 Português > Gatilhos [Remover gatilho](https://docs.agrisk.app/remover-gatilho-40857396e0.md): Remove definitivamente um gatilho de uma fase. - Root > 🇧🇷 Português > Gatilhos [Listar gatilhos da fase](https://docs.agrisk.app/listar-gatilhos-da-fase-40857397e0.md): Retorna os gatilhos configurados em uma fase específica. - Root > 🇧🇷 Português > Autenticação [Autenticar usuário](https://docs.agrisk.app/autenticar-usu%C3%A1rio-40857398e0.md): Autentica um usuário na API AgFlow a partir de e-mail (ou nome de usuário) e senha, retornando um token de acesso do tipo Bearer (JWT) que deve ser utilizado no cabeçalho `Authorization` de todas as demais chamadas à API. - Root > 🇧🇷 Português > Mensageria [Configurar telefone](https://docs.agrisk.app/configurar-telefone-40857399e0.md): Cadastra o telefone do WhatsApp Business que será utilizado para o envio das mensagens automáticas configuradas nas fases do flow. - Root > 🇧🇷 Português > Mensageria [Consultar configuração de mensageria](https://docs.agrisk.app/consultar-configura%C3%A7%C3%A3o-de-mensageria-40857400e0.md): Consulta a configuração de mensageria atualmente definida para a fase — contatos fixos e dinâmicos, variáveis de template (fields) e as regras de disparo (rules), incluindo os canais e templates associados a cada uma. - Root > 🇧🇷 Português > Mensageria [Criar configuração de mensageria](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-mensageria-40857401e0.md): Cria a configuração de mensageria de uma fase — os contatos que devem receber notificações automáticas e, opcionalmente, as variáveis de template usadas no corpo da mensagem. - Root > 🇧🇷 Português > Mensageria [Atualizar configuração de mensageria](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-de-mensageria-40857402e0.md): Atualiza a configuração de mensageria de uma fase já existente — contatos e variáveis de template. Esta chamada substitui integralmente contacts e o fields[] raiz da configuração: envie o conteúdo completo desejado, não apenas os campos alterados. As regras (rules[]) não são afetadas por esta chamada; para atualizá-las, utilize os endpoints de criação e atualização de regras deste domínio. - Root > 🇧🇷 Português > Mensageria [Criar regras de mensageria](https://docs.agrisk.app/criar-regras-de-mensageria-40857403e0.md): Adiciona uma ou mais regras de disparo à configuração de mensageria de uma fase. Cada regra combina um ou mais canais de envio (e-mail, WhatsApp) com condições que determinam quando ela deve ser aplicada. - Root > 🇧🇷 Português > Mensageria [Atualizar regra de mensageria](https://docs.agrisk.app/atualizar-regra-de-mensageria-40857404e0.md): Atualiza integralmente uma regra específica da configuração de mensageria da fase, identificada por ruleId no caminho da requisição. - Root > 🇧🇷 Português > Mensageria [Remover configuração de mensageria](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-de-mensageria-40857405e0.md): Remove definitivamente a configuração de mensageria de uma fase, incluindo os contatos, as variáveis de template e todas as regras associadas. Esta operação é irreversível. - Root > 🇧🇷 Português > Empresas e Papéis [Listar usuários da empresa](https://docs.agrisk.app/listar-usu%C3%A1rios-da-empresa-40857406e0.md): Retorna a lista de usuários vinculados a uma empresa (organização) no AgFlow. - Root > 🇧🇷 Português > Empresas e Papéis [Listar papéis da empresa](https://docs.agrisk.app/listar-pap%C3%A9is-da-empresa-40857407e0.md): Retorna a lista de papéis (roles) cadastrados para uma empresa. - Root > 🇧🇷 Português > Empresas e Papéis [Atualizar papel](https://docs.agrisk.app/atualizar-papel-40857408e0.md): Atualiza um papel (role) já existente. - Root > 🇧🇷 Português > Empresas e Papéis [Listar catálogo de permissões](https://docs.agrisk.app/listar-cat%C3%A1logo-de-permiss%C3%B5es-40857409e0.md): Retorna o catálogo completo de permissões disponíveis na plataforma, agrupadas por módulo e recurso. - Root > 🇧🇷 Português > Empresas e Papéis [Criar papel](https://docs.agrisk.app/criar-papel-40857410e0.md): Cria um novo papel (role) para a empresa. - Root > 🇧🇷 Português > Empresas e Papéis [Gerar URL de upload do logotipo](https://docs.agrisk.app/gerar-url-de-upload-do-logotipo-40857411e0.md): Gera uma URL pré-assinada para upload do logotipo de uma empresa. - Root > 🇧🇷 Português > Empresas e Papéis [Gerar URL de download do logotipo](https://docs.agrisk.app/gerar-url-de-download-do-logotipo-40857412e0.md): Gera uma URL pré-assinada para download do logotipo atualmente cadastrado de uma empresa. - Root > 🇧🇷 Português > Empresas e Papéis [Atribuir papéis a um usuário](https://docs.agrisk.app/atribuir-pap%C3%A9is-a-um-usu%C3%A1rio-40857413e0.md): Atribui um ou mais papéis a um usuário. - Root > 🇧🇷 Português > Documentos [Criar configuração de geração automática de documento](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-gera%C3%A7%C3%A3o-autom%C3%A1tica-de-documento-40857414e0.md): Cria a configuração de geração automática de documento de uma fase, vinculando um ou mais templates (`documents`) que serão usados para gerar o documento automaticamente conforme o card avança pelo processo. - Root > 🇧🇷 Português > Documentos [Remover configuração de geração automática de documento](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-de-gera%C3%A7%C3%A3o-autom%C3%A1tica-de-documento-40857415e0.md): Remove a configuração de geração automática de documento de uma fase. - Root > 🇧🇷 Português > Documentos [Consultar configuração de geração automática de documento](https://docs.agrisk.app/consultar-configura%C3%A7%C3%A3o-de-gera%C3%A7%C3%A3o-autom%C3%A1tica-de-documento-40857416e0.md): Retorna a configuração de geração automática de documento de uma fase, quando existente — incluindo o título da configuração e a lista de templates vinculados (`documents`). - Root > 🇧🇷 Português > Documentos [Atualizar configuração de geração automática de documento](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-de-gera%C3%A7%C3%A3o-autom%C3%A1tica-de-documento-40857417e0.md): Atualiza diretamente a configuração de geração automática de documento já existente em uma fase, aceitando o mesmo formato de payload da criação (`title` e `documents`). - Root > 🇧🇷 Português > Documentos [Consultar campos para geração do documento](https://docs.agrisk.app/consultar-campos-para-gera%C3%A7%C3%A3o-do-documento-40857418e0.md): Retorna a estrutura de campos pré-preenchida com os dados do card, pronta para servir de base ao payload da chamada de geração do documento. A resposta traz os clientes vinculados ao card (`clients`) e as demais seções gerais do template (`generalSections`), cada uma já com a lista de campos que devem ser preenchidos. - Root > 🇧🇷 Português > Documentos [Gerar documento a partir de template](https://docs.agrisk.app/gerar-documento-a-partir-de-template-40857419e0.md): Gera o documento (arquivo .docx preenchido) a partir de um template e dos dados de um card específico. - Root > 🇧🇷 Português > Documentos [Consultar template por ID](https://docs.agrisk.app/consultar-template-por-id-40857420e0.md): Retorna os detalhes completos de um template de documento a partir do seu identificador — incluindo nome, processador utilizado, campos configurados e seções. - Root > 🇧🇷 Português > Documentos [Listar templates do card](https://docs.agrisk.app/listar-templates-do-card-40857421e0.md): Retorna a lista de templates de documento disponíveis para geração a partir de um card específico — ou seja, os templates ativos cujo escopo corresponde ao flow ao qual o card pertence. - Root > 🇧🇷 Português > Documentos [Ativar template](https://docs.agrisk.app/ativar-template-40857422e0.md): Ativa um template de documento, tornando-o disponível para geração de documentos. Esta chamada exige um corpo de requisição vazio (`{}`) — enviar a requisição sem corpo é rejeitado. - Root > 🇧🇷 Português > Documentos [Criar template de documento](https://docs.agrisk.app/criar-template-de-documento-40857423e0.md): Cria um novo template de documento. A criação de um template é um processo composto por múltiplas etapas, e este endpoint executa apenas a primeira delas: registra os metadados do template (nome, processador, escopo, seções e a definição inicial dos campos) e retorna uma URL assinada e temporária (`fileUploadUrl`) para o envio do arquivo `.docx` correspondente. - Root > 🇧🇷 Português > Documentos [Remover template](https://docs.agrisk.app/remover-template-40857424e0.md): Remove definitivamente um template de documento. - Root > 🇧🇷 Português > Documentos [Listar templates](https://docs.agrisk.app/listar-templates-40857425e0.md): Lista os templates de documento cadastrados, com filtro opcional por escopo (`scope`, o identificador do flow) e por aplicação (`application`). - Root > 🇧🇷 Português > Documentos [Definir campos do template](https://docs.agrisk.app/definir-campos-do-template-40857426e0.md): Define (ou substitui integralmente) a lista de campos de um template já existente — a segunda etapa obrigatória da criação de um template, e também o caminho para corrigir a origem de um campo (por exemplo, trocar de campo de fase para campo do formulário inicial). - Root > 🇧🇷 Português > Documentos [Configurar regras condicionais do template](https://docs.agrisk.app/configurar-regras-condicionais-do-template-40857427e0.md): Configura regras condicionais para os campos do template — por exemplo, exibir, ocultar, tornar obrigatório/opcional ou limpar o valor de um campo com base no valor de outro campo (`onChange`). - Root > 🇧🇷 Português > Documentos [Atualizar arquivo do template](https://docs.agrisk.app/atualizar-arquivo-do-template-40857428e0.md): Envia um novo arquivo `.docx` para substituir o conteúdo de um template existente. - Root > 🇧🇷 Português > Cards [Listar cards de uma fase](https://docs.agrisk.app/listar-cards-de-uma-fase-40857429e0.md): Retorna os cards que estão atualmente na fase informada, dentro do flow indicado. - Root > 🇧🇷 Português > Cards [Mover card de fase](https://docs.agrisk.app/mover-card-de-fase-40857430e0.md): Move um card da fase atual (informada no caminho) para outra fase do mesmo flow, informada no corpo da requisição. - Root > 🇧🇷 Português > Cards [Criar card](https://docs.agrisk.app/criar-card-40857431e0.md): Cria um novo card (oportunidade) em um flow, a partir dos campos definidos no formulário de entrada (start-form) do flow. - Root > 🇧🇷 Português > Cards [Listar cards do flow](https://docs.agrisk.app/listar-cards-do-flow-40857432e0.md): Atenção: uma chamada direta a esta listagem simples não está disponível — o servidor retorna erro 404 (rota inexistente), e não um 404 de recurso não encontrado. - Root > 🇧🇷 Português > Cards [Criar card via link público](https://docs.agrisk.app/criar-card-via-link-p%C3%BAblico-40857433e0.md): Cria um novo card a partir de um formulário de entrada acessado publicamente, sem necessidade de autenticação — por exemplo, um link de auto-cadastro compartilhado com um cliente final. - Root > 🇧🇷 Português > Cards [Buscar cards](https://docs.agrisk.app/buscar-cards-40857434e0.md): Busca cards de um flow que correspondam a um termo de busca informado no parâmetro `search`. - Root > 🇧🇷 Português > Cards [Obter card](https://docs.agrisk.app/obter-card-40857435e0.md): Retorna os dados completos de um card específico, incluindo os campos preenchidos, a fase atual, o responsável e as etiquetas aplicadas. - Root > 🇧🇷 Português > Cards [Atualizar card](https://docs.agrisk.app/atualizar-card-40857436e0.md): Atualiza propriedades nativas do card (por exemplo, o valor estimado da oportunidade ou outras propriedades de topo do registro) por meio de uma atualização parcial — apenas os campos enviados são alterados. - Root > 🇧🇷 Português > Cards [Atualizar responsável do card](https://docs.agrisk.app/atualizar-respons%C3%A1vel-do-card-40857437e0.md): Atualiza o responsável (assignee) por um card. - Root > 🇧🇷 Português > Cards [Atualizar campos via link público](https://docs.agrisk.app/atualizar-campos-via-link-p%C3%BAblico-40857438e0.md): Atenção: usar este endpoint em um card que já avançou de fase pode apagar (zerar) todos os campos da fase atual do card, sem retornar nenhum erro HTTP — a resposta chega vazia e os dados de fase preenchidos anteriormente são perdidos. Esse comportamento foi observado ao tentar usá-lo para atualizar campos do formulário de entrada (start-form) de um card já existente: os campos do formulário de entrada não são atualizados (permanecem com o valor antigo) e os campos da fase atual são apagados. - Root > 🇧🇷 Português > Cards [Atualizar campos de fase do card](https://docs.agrisk.app/atualizar-campos-de-fase-do-card-40857439e0.md): Atualiza os campos referentes à fase atual de um card. - Root > 🇧🇷 Português > Cards [Remover cards em lote](https://docs.agrisk.app/remover-cards-em-lote-40857440e0.md): Remove um ou mais cards em lote, informando os identificadores no corpo da requisição. - Root > 🇧🇷 Português > Cards [Atualizar Ficha Cadastral do card](https://docs.agrisk.app/atualizar-ficha-cadastral-do-card-40857441e0.md): Atualiza os campos da Ficha Cadastral do card, endereçando o card diretamente pelo seu identificador — sem informar o flow no caminho. - Root > 🇧🇷 Português > Cards [Obter responsável do card](https://docs.agrisk.app/obter-respons%C3%A1vel-do-card-40857442e0.md): Retorna o responsável (assignee) atualmente atribuído ao card. - Root > 🇧🇷 Português > Cards [Listar etiquetas do card](https://docs.agrisk.app/listar-etiquetas-do-card-40857443e0.md): Retorna as etiquetas atualmente aplicadas ao card. - Root > 🇧🇷 Português > Cards [Listar campos de uma fase do card](https://docs.agrisk.app/listar-campos-de-uma-fase-do-card-40857444e0.md): Retorna os campos e respectivos valores de uma fase específica do card, informada no caminho. - Root > 🇧🇷 Português > Cards [Listar campos de uma fase do card (link público)](https://docs.agrisk.app/listar-campos-de-uma-fase-do-card-link-p%C3%BAblico-40857445e0.md): Equivalente ao endpoint de leitura de campos de fase, mas destinado a acesso sem autenticação — por exemplo, para uso em uma tela pública de acompanhamento do card. - Root > 🇧🇷 Português > Cards [Obter histórico do card](https://docs.agrisk.app/obter-hist%C3%B3rico-do-card-40857446e0.md): Retorna o histórico de eventos do card — movimentações de fase, atualizações de campos e demais ações registradas ao longo do ciclo de vida do card. - Root > 🇧🇷 Português > Cards [Listar clientes do card](https://docs.agrisk.app/listar-clientes-do-card-40857447e0.md): Retorna os clientes (pessoas físicas ou jurídicas) associados ao card — o cliente principal e, quando aplicável, os demais integrantes de um grupo associado ao card (avalistas, cônjuge, sócios, entre outros). - Root > 🇧🇷 Português > Cards [Criar comentário no card](https://docs.agrisk.app/criar-coment%C3%A1rio-no-card-40857448e0.md): Cria um comentário em um card. - Root > 🇧🇷 Português > Cards [Listar comentários do card](https://docs.agrisk.app/listar-coment%C3%A1rios-do-card-40857449e0.md): Lista os comentários registrados em um card. - Root > 🇧🇷 Português > Cards [Remover comentário do card](https://docs.agrisk.app/remover-coment%C3%A1rio-do-card-40857450e0.md): Remove um comentário de um card. - Root > 🇧🇷 Português > Cards [Listar anexos do card](https://docs.agrisk.app/listar-anexos-do-card-40857451e0.md): Lista os anexos registrados em um card. - Root > 🇧🇷 Português > Cards [Cadastrar anexo no card](https://docs.agrisk.app/cadastrar-anexo-no-card-40857452e0.md): Registra um anexo em um card. - Root > 🇧🇷 Português > Cards [Remover anexo do card](https://docs.agrisk.app/remover-anexo-do-card-40857453e0.md): Remove um anexo do card. - Root > 🇧🇷 Português > Cards [Remover vínculo do anexo com campo de fase](https://docs.agrisk.app/remover-v%C3%ADnculo-do-anexo-com-campo-de-fase-40857454e0.md): Remove a associação de um anexo com o campo de fase (do tipo anexo) ao qual ele está vinculado no card. - Root > 🇧🇷 Português > Cards [Adicionar membros ao grupo do card](https://docs.agrisk.app/adicionar-membros-ao-grupo-do-card-40857455e0.md): Adiciona membros ao grupo de clientes associado ao card — por exemplo, avalistas, sócios ou demais integrantes que devem compor, junto ao cliente principal, a análise realizada sobre o card. - Root > 🇧🇷 Português > Cards [Remover membro do grupo do card](https://docs.agrisk.app/remover-membro-do-grupo-do-card-40857456e0.md): Remove um membro do grupo de clientes associado ao card. - Root > 🇧🇷 Português > Configuração de Cliente [Obter configuração de cliente por empresa](https://docs.agrisk.app/obter-configura%C3%A7%C3%A3o-de-cliente-por-empresa-40857457e0.md): Retorna a configuração de campos de cliente de uma empresa, incluindo as seções e todos os campos cadastrados. Cada empresa possui no máximo uma configuração de cliente. - Root > 🇧🇷 Português > Configuração de Cliente [Criar configuração de cliente](https://docs.agrisk.app/criar-configura%C3%A7%C3%A3o-de-cliente-40857458e0.md): Cria a configuração de campos de cliente de uma empresa, incluindo o conjunto inicial de campos. Como cada empresa pode ter apenas uma configuração, este endpoint deve ser utilizado somente quando a empresa ainda não possui nenhuma — verifique previamente com a consulta por empresa. Caso já exista uma configuração, utilize a criação de campos ou de seções para adicioná-los à configuração existente. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar configuração de cliente](https://docs.agrisk.app/atualizar-configura%C3%A7%C3%A3o-de-cliente-40857459e0.md): Substitui integralmente a lista de campos de uma configuração de cliente existente. O array `fields` enviado passa a ser a única fonte de verdade da configuração: qualquer campo existente que não conste no array é efetivamente descartado. - Root > 🇧🇷 Português > Configuração de Cliente [Obter configuração de cliente](https://docs.agrisk.app/obter-configura%C3%A7%C3%A3o-de-cliente-40857460e0.md): Retorna os detalhes de uma configuração de cliente a partir do seu identificador, incluindo a lista completa de campos e seções cadastrados. - Root > 🇧🇷 Português > Configuração de Cliente [Remover configuração de cliente](https://docs.agrisk.app/remover-configura%C3%A7%C3%A3o-de-cliente-40857461e0.md): Remove permanentemente a configuração de campos de cliente de uma empresa, incluindo todas as suas seções, campos e regras associadas. - Root > 🇧🇷 Português > Configuração de Cliente [Listar seções](https://docs.agrisk.app/listar-se%C3%A7%C3%B5es-40857462e0.md): Lista todas as seções cadastradas em uma configuração de cliente, ordenadas pelo respectivo índice. As seções funcionam como agrupamentos visuais dos campos do cadastro de cliente — por exemplo, 'Dados pessoais', 'Endereço' ou 'Informações financeiras'. - Root > 🇧🇷 Português > Configuração de Cliente [Criar seções](https://docs.agrisk.app/criar-se%C3%A7%C3%B5es-40857463e0.md): Cria uma ou mais seções em uma configuração de cliente existente, em lote. Cada seção requer `name` e `index`: o índice determina a posição relativa da seção em relação às demais e é o único mecanismo de ordenação honrado pela API neste nível — a ordenação dos campos dentro de cada seção segue a ordem em que eles forem associados a ela, não um índice individual. - Root > 🇧🇷 Português > Configuração de Cliente [Obter seção](https://docs.agrisk.app/obter-se%C3%A7%C3%A3o-40857464e0.md): Retorna os detalhes de uma seção específica de uma configuração de cliente. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar seção](https://docs.agrisk.app/atualizar-se%C3%A7%C3%A3o-40857465e0.md): Atualiza uma seção existente substituindo integralmente os seus dados. Como se trata de uma substituição completa, tanto `name` quanto `index` devem ser enviados: a omissão de qualquer um deles retorna erro 400. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar seção parcialmente](https://docs.agrisk.app/atualizar-se%C3%A7%C3%A3o-parcialmente-40857466e0.md): Atualiza parcialmente uma seção existente. Diferentemente da substituição completa, esta operação aceita apenas os campos que devem ser alterados: qualquer campo omitido permanece com o valor atual, incluindo o índice de ordenação. - Root > 🇧🇷 Português > Configuração de Cliente [Remover seção](https://docs.agrisk.app/remover-se%C3%A7%C3%A3o-40857467e0.md): Remove uma seção de uma configuração de cliente. Campos que estejam associados à seção removida deixam de pertencer a um agrupamento visual; recomendamos reassociá-los a outra seção ou desassociá-los antes de remover o agrupamento, conforme a necessidade do cadastro. - Root > 🇧🇷 Português > Configuração de Cliente [Listar campos](https://docs.agrisk.app/listar-campos-40857468e0.md): Lista todos os campos cadastrados em uma configuração de cliente, incluindo tipo, categoria, seção associada (quando houver) e demais metadados de cada campo. - Root > 🇧🇷 Português > Configuração de Cliente [Criar campos](https://docs.agrisk.app/criar-campos-40857469e0.md): Cria um ou mais campos em uma configuração de cliente existente, em lote. Utilize este endpoint para adicionar novos campos a uma configuração já criada — para a criação inicial de uma configuração e seus campos, utilize a criação de configuração de cliente. - Root > 🇧🇷 Português > Configuração de Cliente [Obter campo](https://docs.agrisk.app/obter-campo-40857470e0.md): Retorna os detalhes de um campo específico de uma configuração de cliente. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar campo](https://docs.agrisk.app/atualizar-campo-40857471e0.md): Atualiza um campo existente substituindo integralmente os seus dados, incluindo `name`, `type`, `index`, `description` e `help`. Por se tratar de uma substituição completa, os atributos obrigatórios do cadastro original devem ser reenviados; a omissão de `description` ou `help`, por exemplo, retorna erro 400. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar campo parcialmente](https://docs.agrisk.app/atualizar-campo-parcialmente-40857472e0.md): Atualiza parcialmente um campo existente. Diferentemente da substituição completa, aceita apenas os atributos que devem ser alterados — os demais permanecem com o valor atual. - Root > 🇧🇷 Português > Configuração de Cliente [Remover campo](https://docs.agrisk.app/remover-campo-40857473e0.md): Remove um campo de uma configuração de cliente, incluindo quaisquer regras associadas a ele. - Root > 🇧🇷 Português > Configuração de Cliente [Listar regras](https://docs.agrisk.app/listar-regras-40857474e0.md): Lista as regras condicionais associadas a um campo de uma configuração de cliente. As regras definem comportamentos de exibição ou de cálculo automático que dependem do valor de outros campos do cadastro. - Root > 🇧🇷 Português > Configuração de Cliente [Criar regra](https://docs.agrisk.app/criar-regra-40857475e0.md): Cria uma regra condicional associada a um campo de uma configuração de cliente. Uma regra descreve um gatilho (`trigger`) e um entre dois comportamentos possíveis: - Root > 🇧🇷 Português > Configuração de Cliente [Obter regra](https://docs.agrisk.app/obter-regra-40857476e0.md): Retorna os detalhes de uma regra específica associada a um campo de uma configuração de cliente. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar regra](https://docs.agrisk.app/atualizar-regra-40857477e0.md): Atualiza uma regra existente substituindo integralmente sua definição, incluindo o gatilho e o comportamento associado (exibição condicional ou cálculo). Como se trata de uma substituição completa, o corpo enviado deve conter a definição completa da regra desejada. - Root > 🇧🇷 Português > Configuração de Cliente [Atualizar regra parcialmente](https://docs.agrisk.app/atualizar-regra-parcialmente-40857478e0.md): Atualiza parcialmente uma regra existente, alterando apenas os atributos informados — como a ativação (`active`) da regra ou ajustes pontuais nas condições, ações ou no cálculo — e preservando os demais. - Root > 🇧🇷 Português > Configuração de Cliente [Remover regra](https://docs.agrisk.app/remover-regra-40857479e0.md): Remove uma regra condicional de um campo de uma configuração de cliente. O campo permanece no cadastro, mas deixa de ter o comportamento de exibição condicional ou de cálculo automático definido pela regra removida. - Root > 🇧🇷 Português > Fase [Criar ação de fase](https://docs.agrisk.app/criar-a%C3%A7%C3%A3o-de-fase-40857480e0.md): Habilita um módulo — como aprovação, parecer, motores de crédito/decisão ou mensageria — em uma fase. - Root > 🇧🇷 Português > Fase [Criar fase](https://docs.agrisk.app/criar-fase-40857481e0.md): Cria uma nova fase (etapa) dentro de um flow existente. - Root > 🇧🇷 Português > Fase [Remover ação de fase](https://docs.agrisk.app/remover-a%C3%A7%C3%A3o-de-fase-40857482e0.md): Remove uma ação de fase, desabilitando o módulo correspondente. A configuração base do módulo (`approval-config`, `opinion-config`, entre outras) não é removida por esta operação — apenas sua ativação e visibilidade na fase. - Root > 🇧🇷 Português > Fase [Remover fase](https://docs.agrisk.app/remover-fase-40857483e0.md): Remove uma fase do flow. - Root > 🇧🇷 Português > Fase [Listar ações da fase](https://docs.agrisk.app/listar-a%C3%A7%C3%B5es-da-fase-40857484e0.md): Retorna os módulos (phase-actions) habilitados em uma fase, como aprovação, parecer, motores de decisão e mensageria. - Root > 🇧🇷 Português > Fase [Listar fases](https://docs.agrisk.app/listar-fases-40857485e0.md): Retorna todas as fases (etapas) de um flow, ordenadas pelo campo `index`. - Root > 🇧🇷 Português > Fase [Atualizar ação de fase](https://docs.agrisk.app/atualizar-a%C3%A7%C3%A3o-de-fase-40857486e0.md): Atualiza uma ação de fase existente. Esta operação substitui integralmente os dados da ação — os campos não enviados não são preservados do estado anterior. - Root > 🇧🇷 Português > Fase [Atualizar fase](https://docs.agrisk.app/atualizar-fase-40857487e0.md): Atualiza os campos de uma fase existente por meio de uma atualização parcial. - Root > 🇺🇸 English > Phase [Create phase action](https://docs.agrisk.app/create-phase-action-40857488e0.md): Enables a module — such as approval, opinion, credit/decision engines, or messaging — on a phase. - Root > 🇺🇸 English > Phase [Create phase](https://docs.agrisk.app/create-phase-40857489e0.md): Creates a new phase (stage) within an existing flow. - Root > 🇺🇸 English > Phase [Delete phase action](https://docs.agrisk.app/delete-phase-action-40857490e0.md): Removes a phase action, disabling the corresponding module. The module's base configuration (`approval-config`, `opinion-config`, among others) is not removed by this operation — only its activation and visibility on the phase. - Root > 🇺🇸 English > Phase [Delete phase](https://docs.agrisk.app/delete-phase-40857491e0.md): Deletes a phase from the flow. - Root > 🇺🇸 English > Phase [List phase actions](https://docs.agrisk.app/list-phase-actions-40857492e0.md): Returns the modules (phase-actions) enabled on a phase, such as approval, opinion, decision engines, and messaging. - Root > 🇺🇸 English > Phase [List phases](https://docs.agrisk.app/list-phases-40857493e0.md): Returns all phases (stages) of a flow, ordered by the `index` field. - Root > 🇺🇸 English > Phase [Update phase action](https://docs.agrisk.app/update-phase-action-40857494e0.md): Updates an existing phase action. This operation fully replaces the action's data — fields that are not sent are not preserved from the previous state. - Root > 🇺🇸 English > Phase [Update phase](https://docs.agrisk.app/update-phase-40857495e0.md): Updates the fields of an existing phase through a partial update. - Root > 🇺🇸 English > Approval [Get approval configuration](https://docs.agrisk.app/get-approval-configuration-40857496e0.md): Returns the approval configuration set up for a phase, including the general voting parameters and the rules already created, each with its trigger conditions and the corresponding approver hierarchy. - Root > 🇺🇸 English > Approval [Create approval configuration](https://docs.agrisk.app/create-approval-configuration-40857497e0.md): Creates the base configuration of a phase's approval chain — the general voting parameters, without rules and without approvers. - Root > 🇺🇸 English > Approval [Update approval configuration](https://docs.agrisk.app/update-approval-configuration-40857498e0.md): Updates the base configuration of an approval chain that already exists in a phase. - Root > 🇺🇸 English > Approval [Add approval rule](https://docs.agrisk.app/add-approval-rule-40857499e0.md): Adds a rule to a phase's approval configuration. A rule defines, through conditions, when it applies to a card, and who the approvers responsible for voting are once it is triggered. - Root > 🇺🇸 English > Approval [Update approval rule](https://docs.agrisk.app/update-approval-rule-40857500e0.md): Updates a rule that already exists in a phase's approval configuration. The call replaces the rule entirely — resend all conditions and the desired approver hierarchy, not just the changed field. - Root > 🇺🇸 English > Approval [Delete approval configuration](https://docs.agrisk.app/delete-approval-configuration-40857501e0.md): Removes a phase's approval configuration entirely, including all rules associated with it. - Root > 🇺🇸 English > Approval [Get card approval](https://docs.agrisk.app/get-card-approval-40857502e0.md): Retrieves the approval voting record of a card — the votes already registered, the comment and value informed by each approver, and the chain's consolidated result so far. - Root > 🇺🇸 English > Approval [Register approval vote](https://docs.agrisk.app/register-approval-vote-40857503e0.md): Registers a new approval vote for a card, in the indicated phase. The call is used by the current approver within the chain configured for the phase — the phase must already have at least one approval rule registered; otherwise, the call returns an error for not finding an applicable rule for the card. - Root > 🇺🇸 English > Approval [Update approval vote](https://docs.agrisk.app/update-approval-vote-40857504e0.md): Updates an approval vote already registered for a card in a phase. Uses the same fields and validation rules as registering a new vote: `status`, `value` and `comment` are required, and a rejection `status` requires `value` to equal zero. - Root > 🇺🇸 English > Flow [Health check](https://docs.agrisk.app/health-check-40857505e0.md): Simple monitoring endpoint that requires no authentication, used to check whether the AgFlow API is available. It returns no business data — it exists purely as a liveness probe for external monitoring tools. - Root > 🇺🇸 English > Flow [Create flow](https://docs.agrisk.app/create-flow-40857506e0.md): Creates a new flow (business process) inside the authenticated company. - Root > 🇺🇸 English > Flow [List flows](https://docs.agrisk.app/list-flows-40857507e0.md): Returns the flows of the authenticated company. - Root > 🇺🇸 English > Flow [Get flow](https://docs.agrisk.app/get-flow-40857508e0.md): Returns the data for a specific flow, including name, description, icon, color, and the configured labels (`labelOptions`). - Root > 🇺🇸 English > Flow [Update flow](https://docs.agrisk.app/update-flow-40857509e0.md): Updates the data of an existing flow. - Root > 🇺🇸 English > Flow [Delete flow](https://docs.agrisk.app/delete-flow-40857510e0.md): Deletes a flow entirely, including its phases, cards, and associated configurations (approval, opinion, engines, messaging, among others). - Root > 🇺🇸 English > Flow [Add user to flow](https://docs.agrisk.app/add-user-to-flow-40857511e0.md): Grants a user access to a flow, associating them with a specific role within it. - Root > 🇺🇸 English > Flow [Remove user from flow](https://docs.agrisk.app/remove-user-from-flow-40857512e0.md): Removes a user's access to a flow. The role associated with the user on this flow also stops applying — the removal does not affect the user's access to other flows within the same company. - Root > 🇺🇸 English > Flow [List dynamic field paths](https://docs.agrisk.app/list-dynamic-field-paths-40857513e0.md): Returns the catalog of field paths available to reference in this flow's conditions, rules, and templates — for example, when building a trigger condition or an automation filter. - Root > 🇺🇸 English > Bureau Query [Get bureau query configuration](https://docs.agrisk.app/get-bureau-query-configuration-40857514e0.md): Returns the bureau query configuration defined for a phase — including the configuration title and the list of bureau/AgRisk product identifiers that will be queried when a card enters that phase. - Root > 🇺🇸 English > Bureau Query [Create bureau query configuration](https://docs.agrisk.app/create-bureau-query-configuration-40857515e0.md): Creates the bureau query configuration for a phase, defining the configuration title and the list of bureau/AgRisk product identifiers to be queried when a card enters the phase. - Root > 🇺🇸 English > Bureau Query [Update bureau query configuration](https://docs.agrisk.app/update-bureau-query-configuration-40857516e0.md): Updates the existing bureau query configuration of a phase, replacing the title and the list of bureau/AgRisk product identifiers to be queried. - Root > 🇺🇸 English > Fields [List phase fields](https://docs.agrisk.app/list-phase-fields-40857517e0.md): Returns the custom fields configured on a phase of the flow — the fields shown to and filled in by users while a card sits in that step of the process. - Root > 🇺🇸 English > Fields [Update phase fields](https://docs.agrisk.app/update-phase-fields-40857518e0.md): Fully replaces the list of custom fields on a phase. This operation is a full replace: the `fields` array you send becomes the complete configuration of the phase — you cannot add or remove a single field in isolation, the entire set must be resent on every call. - Root > 🇺🇸 English > Fields [Update phase field rules](https://docs.agrisk.app/update-phase-field-rules-40857519e0.md): Configures conditional rules between the fields of a phase — for example, showing, hiding, or requiring a field based on the value of another field (`onChange` trigger), or automatically calculating a field's value from an expression involving other fields (`onCalculate` trigger). - Root > 🇺🇸 English > Engines [Get card decision engine result](https://docs.agrisk.app/get-card-decision-engine-result-40857520e0.md): Retrieves the most recent decision engine result for the client linked to the given card. - Root > 🇺🇸 English > Engines [Run card decision engine](https://docs.agrisk.app/run-card-decision-engine-40857521e0.md): Runs the decision engine configured on the flow for the client linked to the given card, processing the card's and client's current data through the Taktile policy and returning the result grouped by module. - Root > 🇺🇸 English > Engines [Get card credit engine inputs](https://docs.agrisk.app/get-card-credit-engine-inputs-40857522e0.md): Returns the input values that would be sent to the credit engine's Taktile policy for the client linked to the given card — without running the engine. Useful for inspecting, before running the analysis, exactly which card and client values are mapped to each input configured (`input[]`) on the flow's credit engine configuration. - Root > 🇺🇸 English > Engines [Get card credit engine result](https://docs.agrisk.app/get-card-credit-engine-result-40857523e0.md): Retrieves the most recent credit engine result for the client linked to the given card — score, rating, suggested value, and the criteria grouped under `output[]`, computed by the Taktile policy. - Root > 🇺🇸 English > Engines [Run card credit engine](https://docs.agrisk.app/run-card-credit-engine-40857524e0.md): Runs (or re-runs) the credit engine configured on the flow for the client linked to the given card, processing the current data through the Taktile policy and returning score, rating, suggested value, and the criteria under `output[]`. - Root > 🇺🇸 English > Engines [Get decision engine configuration](https://docs.agrisk.app/get-decision-engine-configuration-40857525e0.md): Returns the decision engine configuration associated with the given flow — the linked Taktile policy (`policyId`) and the defined input (`input[]`) and output (`output[]`) mappings. - Root > 🇺🇸 English > Engines [Create decision engine configuration](https://docs.agrisk.app/create-decision-engine-configuration-40857526e0.md): Creates the decision engine configuration for a flow, linking it to a previously registered Taktile policy (`policyId`) and defining the input (`input[]`) and output (`output[]`) mappings. - Root > 🇺🇸 English > Engines [Update decision engine configuration](https://docs.agrisk.app/update-decision-engine-configuration-40857527e0.md): Updates the flow's existing decision engine configuration, fully replacing the submitted `input[]`/`output[]`. - Root > 🇺🇸 English > Engines [Delete decision engine configuration](https://docs.agrisk.app/delete-decision-engine-configuration-40857528e0.md): Removes the flow's decision engine configuration. - Root > 🇺🇸 English > Engines [Get credit engine configuration detail](https://docs.agrisk.app/get-credit-engine-configuration-detail-40857529e0.md): Returns the full detail of a credit engine configuration, given its identifier. - Root > 🇺🇸 English > Engines [Create credit engine configuration](https://docs.agrisk.app/create-credit-engine-configuration-40857530e0.md): Creates the credit engine configuration for a flow, linking it to a previously registered Taktile policy (`policyId`) and defining the input (`input[]`) and output (`output[]`) mappings. - Root > 🇺🇸 English > Engines [List flow credit engine configurations](https://docs.agrisk.app/list-flow-credit-engine-configurations-40857531e0.md): Lists the credit engine configurations registered on the flow — usually a single active configuration per flow — returning, for each one, an identifier (`id`), a title and a short description. - Root > 🇺🇸 English > Engines [List credit policies applicable to a card](https://docs.agrisk.app/list-credit-policies-applicable-to-a-card-40857532e0.md): Lists the flow's credit engine configurations applicable to the given card and client, in the order they should be considered. - Root > 🇺🇸 English > Engines [Update credit engine configuration](https://docs.agrisk.app/update-credit-engine-configuration-40857533e0.md): Updates the flow's existing credit engine configuration, fully replacing the submitted `input[]`/`output[]`. - Root > 🇺🇸 English > Engines [Delete credit engine configuration](https://docs.agrisk.app/delete-credit-engine-configuration-40857534e0.md): Removes the flow's credit engine configuration. - Root > 🇺🇸 English > Conversation [Get conversation configuration](https://docs.agrisk.app/get-conversation-configuration-40857535e0.md): Returns the conversation configuration (conversation-config) currently defined on a phase — the WhatsApp message structure used to capture, directly by message, the responses of whoever takes part in an approval or validation step, without that person needing to access AgFlow. - Root > 🇺🇸 English > Conversation [Create conversation configuration](https://docs.agrisk.app/create-conversation-configuration-40857536e0.md): Creates the conversation configuration (conversation-config) of a phase — a WhatsApp message-template state machine that captures responses directly by message, without the person involved needing to access AgFlow. It is commonly used to run approvals entirely over WhatsApp. - Root > 🇺🇸 English > Conversation [Delete conversation configuration](https://docs.agrisk.app/delete-conversation-configuration-40857537e0.md): Permanently removes the conversation configuration identified by `id`. The successful response returns no content. - Root > 🇺🇸 English > Opinion [Get opinion configuration](https://docs.agrisk.app/get-opinion-configuration-40857538e0.md): Returns the opinion configuration associated with the flow, including the title shown to analysts and the list of complementary fields that have been configured. - Root > 🇺🇸 English > Opinion [Create opinion configuration](https://docs.agrisk.app/create-opinion-configuration-40857539e0.md): Creates the technical opinion configuration for a flow, enabling the collection of a structured opinion on analysis phases. - Root > 🇺🇸 English > Opinion [Update opinion configuration](https://docs.agrisk.app/update-opinion-configuration-40857540e0.md): Updates (replaces) the flow's opinion configuration. As with creation, the payload only accepts `title` and `fields` at the top level — the same forbidden keys (description, blocksMovement, slug, uiComponent, active, rules) continue to be rejected with a 400 error. - Root > 🇺🇸 English > Opinion [Get card opinion](https://docs.agrisk.app/get-card-opinion-40857541e0.md): Returns the technical opinion registered for a card on a specific phase: the status set by the analyst (approved or rejected), the approved value, the opinion text, and the values filled in for the complementary fields configured on the flow. - Root > 🇺🇸 English > Opinion [Create card opinion](https://docs.agrisk.app/create-card-opinion-40857542e0.md): Registers an analyst's technical opinion for a card on a specific phase. The request body uses three native top-level fields — `status`, `value`, and `opinion` — plus a `fields` array for the values of the complementary fields configured on the flow. - Root > 🇺🇸 English > Opinion [Update card opinion](https://docs.agrisk.app/update-card-opinion-40857543e0.md): Updates the technical opinion already registered for a card on a specific phase, using the same body format as creation (`status`, `value`, `opinion`, and `fields`). Use this call to revise an existing opinion — for example, correcting the approved value or adding to the text — without creating a new record. - Root > 🇺🇸 English > Start Form [Create start form](https://docs.agrisk.app/create-start-form-40857544e0.md): Creates the start form (initial application form) for a flow that does not have one yet. The start form is the step filled out by the requester, and submitting it is what generates a new card in the flow. - Root > 🇺🇸 English > Start Form [Set start form conditional rules](https://docs.agrisk.app/set-start-form-conditional-rules-40857545e0.md): Defines, fully replacing the current rule set, the conditional behavior of the start form — reactions to a field's value changing, or the automatic calculation of a field's value. - Root > 🇺🇸 English > Start Form [Update start form metadata](https://docs.agrisk.app/update-start-form-metadata-40857546e0.md): Updates the metadata of an existing start form: title, background color, create-button text, description, logo and the associated start phase. - Root > 🇺🇸 English > Start Form [Get start form](https://docs.agrisk.app/get-start-form-40857547e0.md): Returns the complete configuration of a flow's start form: metadata (title, background color, button text, description, logo) and the full list of fields (`fields`), including identifiers, types, sections and — when configured — the conditional rules associated with each field. - Root > 🇺🇸 English > Start Form [Get public start form](https://docs.agrisk.app/get-public-start-form-40857548e0.md): Returns the public version of the start form, in the format used by the fill-in page shown to the requester — the same content displayed outside of an authenticated user session. - Root > 🇺🇸 English > Start Form [Update start form fields](https://docs.agrisk.app/update-start-form-fields-40857549e0.md): Fully replaces the list of fields (`fields`) of the start form. This is a complete replacement — the array sent becomes the entire content of the form. - Root > 🇺🇸 English > Start Form [Delete start form](https://docs.agrisk.app/delete-start-form-40857550e0.md): Permanently removes a flow's start form. - Root > 🇺🇸 English > Filters [List saved filters](https://docs.agrisk.app/list-saved-filters-40857551e0.md): Returns the saved filters of the flow associated with the authenticated user. - Root > 🇺🇸 English > Filters [Create saved filter](https://docs.agrisk.app/create-saved-filter-40857552e0.md): Creates the saved filter of the authenticated user for the given flow — a pre-configured view of the kanban board, with its own sorting, field projection and conditions. - Root > 🇺🇸 English > Filters [Update saved filter](https://docs.agrisk.app/update-saved-filter-40857553e0.md): Updates the saved filter of the authenticated user for the given flow, fully replacing the previous sorting, limit, field projection and conditions with the content sent. - Root > 🇺🇸 English > Filters [Search flow cards](https://docs.agrisk.app/search-flow-cards-40857554e0.md): Runs a card search within a single flow, using a condition language that supports nested filter trees and aggregations over collections. - Root > 🇺🇸 English > Filters [Search cards across flows](https://docs.agrisk.app/search-cards-across-flows-40857555e0.md): Runs a card search across every flow accessible to the authenticated user, instead of restricting the search to a single flow. Use this endpoint when the search needs to span cards from more than one flow at once; to restrict the search to a specific flow, use the per-flow search endpoint (`/v1/filters/flows/{flowId}/search`). - Root > 🇺🇸 English > AgRisk [List AgRisk query products](https://docs.agrisk.app/list-agrisk-query-products-40857556e0.md): Returns the catalog of credit bureau query products available through AgRisk, the external data layer integrated with the AgFlow API. Each product represents a type of query — such as financial restriction records, protests, lawsuits, vehicle assets, or property records — identified by an `id` and a human-readable `name`. - Root > 🇺🇸 English > Triggers [List flow triggers](https://docs.agrisk.app/list-flow-triggers-40857557e0.md): Returns all triggers configured across the phases of a flow. - Root > 🇺🇸 English > Triggers [Create trigger](https://docs.agrisk.app/create-trigger-40857558e0.md): Creates a new trigger in a phase of the flow. - Root > 🇺🇸 English > Triggers [Update trigger](https://docs.agrisk.app/update-trigger-40857559e0.md): Updates an existing trigger. This operation fully replaces the trigger's data — fields and actions not included in the payload are not preserved from the previous state. - Root > 🇺🇸 English > Triggers [Delete trigger](https://docs.agrisk.app/delete-trigger-40857560e0.md): Permanently removes a trigger from a phase. - Root > 🇺🇸 English > Triggers [List phase triggers](https://docs.agrisk.app/list-phase-triggers-40857561e0.md): Returns the triggers configured on a specific phase. - Root > 🇺🇸 English > Authentication [Authenticate user](https://docs.agrisk.app/authenticate-user-40857562e0.md): Authenticates a user against the AgFlow API using an email address (or username) and password, returning a Bearer access token (JWT) that must be sent in the `Authorization` header of every subsequent API call. - Root > 🇺🇸 English > Messaging [Configure phone](https://docs.agrisk.app/configure-phone-40857563e0.md): Registers the WhatsApp Business phone number that will be used to send the automatic messages configured on the flow's phases. - Root > 🇺🇸 English > Messaging [Get messaging config](https://docs.agrisk.app/get-messaging-config-40857564e0.md): Retrieves the messaging configuration currently defined for the phase — fixed and dynamic contacts, template variables (fields), and the firing rules (rules), including the channels and templates associated with each one. - Root > 🇺🇸 English > Messaging [Create messaging config](https://docs.agrisk.app/create-messaging-config-40857565e0.md): Creates the messaging configuration of a phase — the contacts that should receive automatic notifications and, optionally, the template variables used in the message body. - Root > 🇺🇸 English > Messaging [Update messaging config](https://docs.agrisk.app/update-messaging-config-40857566e0.md): Updates the messaging configuration of an existing phase — contacts and template variables. This call fully replaces contacts and the root fields[] of the configuration: send the complete desired content, not just the changed fields. The rules (rules[]) are not affected by this call; to update them, use the rule creation and update endpoints in this domain. - Root > 🇺🇸 English > Messaging [Create messaging rules](https://docs.agrisk.app/create-messaging-rules-40857567e0.md): Adds one or more firing rules to a phase's messaging configuration. Each rule combines one or more sending channels (email, WhatsApp) with conditions that determine when it should apply. - Root > 🇺🇸 English > Messaging [Update messaging rule](https://docs.agrisk.app/update-messaging-rule-40857568e0.md): Fully updates a specific rule of the phase's messaging configuration, identified by ruleId in the request path. - Root > 🇺🇸 English > Messaging [Delete messaging config](https://docs.agrisk.app/delete-messaging-config-40857569e0.md): Permanently removes the messaging configuration of a phase, including its contacts, template variables, and all associated rules. This operation is irreversible. - Root > 🇺🇸 English > Companies & Roles [List company users](https://docs.agrisk.app/list-company-users-40857570e0.md): Returns the list of users belonging to a company (organization) in AgFlow. - Root > 🇺🇸 English > Companies & Roles [List company roles](https://docs.agrisk.app/list-company-roles-40857571e0.md): Returns the list of roles registered for a company. - Root > 🇺🇸 English > Companies & Roles [Update role](https://docs.agrisk.app/update-role-40857572e0.md): Updates an existing role. - Root > 🇺🇸 English > Companies & Roles [List permissions catalog](https://docs.agrisk.app/list-permissions-catalog-40857573e0.md): Returns the full catalog of permissions available on the platform, grouped by module and resource. - Root > 🇺🇸 English > Companies & Roles [Create role](https://docs.agrisk.app/create-role-40857574e0.md): Creates a new role for the company. - Root > 🇺🇸 English > Companies & Roles [Generate company logo upload URL](https://docs.agrisk.app/generate-company-logo-upload-url-40857575e0.md): Generates a pre-signed URL to upload a company's logo. - Root > 🇺🇸 English > Companies & Roles [Generate company logo download URL](https://docs.agrisk.app/generate-company-logo-download-url-40857576e0.md): Generates a pre-signed URL to download a company's currently registered logo. - Root > 🇺🇸 English > Companies & Roles [Assign roles to a user](https://docs.agrisk.app/assign-roles-to-a-user-40857577e0.md): Assigns one or more roles to a user. - Root > 🇺🇸 English > Documents [Create automatic document configuration](https://docs.agrisk.app/create-automatic-document-configuration-40857578e0.md): Creates the automatic document generation configuration of a phase, linking one or more templates (`documents`) that will be used to generate the document automatically as the card advances through the process. - Root > 🇺🇸 English > Documents [Delete automatic document configuration](https://docs.agrisk.app/delete-automatic-document-configuration-40857579e0.md): Removes the automatic document generation configuration of a phase. - Root > 🇺🇸 English > Documents [Get automatic document configuration](https://docs.agrisk.app/get-automatic-document-configuration-40857580e0.md): Returns the automatic document generation configuration of a phase, if one exists — including the configuration title and the list of linked templates (`documents`). - Root > 🇺🇸 English > Documents [Update automatic document configuration](https://docs.agrisk.app/update-automatic-document-configuration-40857581e0.md): Directly updates the automatic document generation configuration already existing in a phase, accepting the same payload format as creation (`title` and `documents`). - Root > 🇺🇸 English > Documents [Get fields for document generation](https://docs.agrisk.app/get-fields-for-document-generation-40857582e0.md): Returns the field structure pre-filled with the card's data, ready to serve as the basis for the document generation request body. The response includes the clients linked to the card (`clients`) and the template's other general sections (`generalSections`), each already listing the fields that need to be filled in. - Root > 🇺🇸 English > Documents [Generate document from template](https://docs.agrisk.app/generate-document-from-template-40857583e0.md): Generates the document (a filled-in .docx file) from a template and the data of a specific card. - Root > 🇺🇸 English > Documents [Get template by ID](https://docs.agrisk.app/get-template-by-id-40857584e0.md): Returns the full details of a document template from its identifier — including name, processor used, configured fields, and sections. - Root > 🇺🇸 English > Documents [List card templates](https://docs.agrisk.app/list-card-templates-40857585e0.md): Returns the list of document templates available for generation from a specific card — that is, the active templates whose scope matches the flow the card belongs to. - Root > 🇺🇸 English > Documents [Activate template](https://docs.agrisk.app/activate-template-40857586e0.md): Activates a document template, making it available for document generation. This call requires an empty request body (`{}`) — sending the request without a body is rejected. - Root > 🇺🇸 English > Documents [Create document template](https://docs.agrisk.app/create-document-template-40857587e0.md): Creates a new document template. Creating a template is a multi-step process, and this endpoint only performs the first of them: it registers the template's metadata (name, processor, scope, sections, and the initial field definition) and returns a temporary signed URL (`fileUploadUrl`) for uploading the corresponding `.docx` file. - Root > 🇺🇸 English > Documents [Delete template](https://docs.agrisk.app/delete-template-40857588e0.md): Permanently removes a document template. - Root > 🇺🇸 English > Documents [List templates](https://docs.agrisk.app/list-templates-40857589e0.md): Lists the registered document templates, with optional filtering by scope (`scope`, the flow identifier) and by application (`application`). - Root > 🇺🇸 English > Documents [Set template fields](https://docs.agrisk.app/set-template-fields-40857590e0.md): Defines (or fully replaces) the field list of an existing template — the mandatory second step of template creation, and also the way to fix a field's origin (for example, switching from a phase field to a field from the initial form). - Root > 🇺🇸 English > Documents [Configure template conditional rules](https://docs.agrisk.app/configure-template-conditional-rules-40857591e0.md): Configures conditional rules for the template's fields — for example, showing, hiding, making required/optional, or clearing the value of a field based on the value of another field (`onChange`). - Root > 🇺🇸 English > Documents [Update template file](https://docs.agrisk.app/update-template-file-40857592e0.md): Uploads a new `.docx` file to replace the content of an existing template. - Root > 🇺🇸 English > Cards [List cards in a phase](https://docs.agrisk.app/list-cards-in-a-phase-40857593e0.md): Returns the cards currently in the given phase, within the specified flow. - Root > 🇺🇸 English > Cards [Move card to another phase](https://docs.agrisk.app/move-card-to-another-phase-40857594e0.md): Moves a card from its current phase (given in the path) to another phase of the same flow, given in the request body. - Root > 🇺🇸 English > Cards [Create card](https://docs.agrisk.app/create-card-40857595e0.md): Creates a new card (deal) in a flow, from the fields defined in the flow's entry form (start-form). - Root > 🇺🇸 English > Cards [List flow cards](https://docs.agrisk.app/list-flow-cards-40857596e0.md): Warning: a direct call to this simple listing is not available — the server returns a 404 error (route does not exist), rather than a resource-not-found 404. - Root > 🇺🇸 English > Cards [Create card via public link](https://docs.agrisk.app/create-card-via-public-link-40857597e0.md): Creates a new card from an entry form accessed publicly, without authentication — for example, a self-registration link shared with an end client. - Root > 🇺🇸 English > Cards [Search cards](https://docs.agrisk.app/search-cards-40857598e0.md): Searches for cards in a flow that match a search term given in the `search` parameter. - Root > 🇺🇸 English > Cards [Get card](https://docs.agrisk.app/get-card-40857599e0.md): Returns the full data of a specific card, including its filled-in fields, current phase, assignee and applied labels. - Root > 🇺🇸 English > Cards [Update card](https://docs.agrisk.app/update-card-40857600e0.md): Updates native card properties (for example, the deal's estimated value, or other top-level record properties) through a partial update — only the fields sent are changed. - Root > 🇺🇸 English > Cards [Update card assignee](https://docs.agrisk.app/update-card-assignee-40857601e0.md): Updates the assignee responsible for a card. - Root > 🇺🇸 English > Cards [Update fields via public link](https://docs.agrisk.app/update-fields-via-public-link-40857602e0.md): Warning: using this endpoint on a card that has already advanced past its initial phase can wipe (zero out) every field of the card's current phase, without returning any HTTP error — the response comes back empty and the previously filled-in phase data is lost. This behavior was observed when attempting to use it to update entry-form (start-form) fields on an already-existing card: the entry-form fields are not updated (they keep their old value), and the current phase's fields are wiped. - Root > 🇺🇸 English > Cards [Update card phase fields](https://docs.agrisk.app/update-card-phase-fields-40857603e0.md): Updates the fields belonging to a card's current phase. - Root > 🇺🇸 English > Cards [Delete cards in bulk](https://docs.agrisk.app/delete-cards-in-bulk-40857604e0.md): Deletes one or more cards in bulk, given their identifiers in the request body. - Root > 🇺🇸 English > Cards [Update card registration record](https://docs.agrisk.app/update-card-registration-record-40857605e0.md): Updates a card's registration record ("Ficha Cadastral") fields, addressing the card directly by its identifier — without specifying the flow in the path. - Root > 🇺🇸 English > Cards [Get card assignee](https://docs.agrisk.app/get-card-assignee-40857606e0.md): Returns the assignee currently assigned to the card. - Root > 🇺🇸 English > Cards [List card labels](https://docs.agrisk.app/list-card-labels-40857607e0.md): Returns the labels currently applied to the card. - Root > 🇺🇸 English > Cards [List card phase fields](https://docs.agrisk.app/list-card-phase-fields-40857608e0.md): Returns the fields and their values for a specific phase of the card, given in the path. - Root > 🇺🇸 English > Cards [List card phase fields (public link)](https://docs.agrisk.app/list-card-phase-fields-public-link-40857609e0.md): Equivalent to the phase-fields reading endpoint, but intended for unauthenticated access — for example, for use in a public card-tracking page. - Root > 🇺🇸 English > Cards [Get card history](https://docs.agrisk.app/get-card-history-40857610e0.md): Returns the card's event history — phase moves, field updates, and other actions recorded throughout the card's lifecycle. - Root > 🇺🇸 English > Cards [List card clients](https://docs.agrisk.app/list-card-clients-40857611e0.md): Returns the clients (individuals or companies) associated with the card — the main client and, when applicable, the other members of a group associated with the card (guarantors, spouse, partners, among others). - Root > 🇺🇸 English > Cards [Create card comment](https://docs.agrisk.app/create-card-comment-40857612e0.md): Creates a comment on a card. - Root > 🇺🇸 English > Cards [List card comments](https://docs.agrisk.app/list-card-comments-40857613e0.md): Lists the comments recorded on a card. - Root > 🇺🇸 English > Cards [Delete card comment](https://docs.agrisk.app/delete-card-comment-40857614e0.md): Deletes a comment from a card. - Root > 🇺🇸 English > Cards [List card attachments](https://docs.agrisk.app/list-card-attachments-40857615e0.md): Lists the attachments recorded on a card. - Root > 🇺🇸 English > Cards [Register card attachment](https://docs.agrisk.app/register-card-attachment-40857616e0.md): Registers an attachment on a card. - Root > 🇺🇸 English > Cards [Delete card attachment](https://docs.agrisk.app/delete-card-attachment-40857617e0.md): Deletes an attachment from a card. - Root > 🇺🇸 English > Cards [Delete attachment's phase-field link](https://docs.agrisk.app/delete-attachments-phase-field-link-40857618e0.md): Removes the association between an attachment and the phase field (of the attachment type) it is linked to on the card. - Root > 🇺🇸 English > Cards [Add members to card group](https://docs.agrisk.app/add-members-to-card-group-40857619e0.md): Adds members to the client group associated with the card — for example, guarantors, partners, or other members that should join the main client in the analysis performed on the card. - Root > 🇺🇸 English > Cards [Remove card group member](https://docs.agrisk.app/remove-card-group-member-40857620e0.md): Removes a member from the client group associated with the card. - Root > 🇺🇸 English > Client Configuration [Get client configuration by company](https://docs.agrisk.app/get-client-configuration-by-company-40857621e0.md): Returns a company's client configuration, including its sections and all registered fields. Each company has at most one client configuration. - Root > 🇺🇸 English > Client Configuration [Create client configuration](https://docs.agrisk.app/create-client-configuration-40857622e0.md): Creates a company's client configuration, including the initial set of fields. Since each company can have only one configuration, this endpoint should be used only when the company does not yet have one — check beforehand with the get-by-company lookup. If a configuration already exists, use field or section creation to add to the existing configuration instead. - Root > 🇺🇸 English > Client Configuration [Update client configuration](https://docs.agrisk.app/update-client-configuration-40857623e0.md): Fully replaces the list of fields of an existing client configuration. The `fields` array sent becomes the configuration's single source of truth: any existing field not included in the array is effectively discarded. - Root > 🇺🇸 English > Client Configuration [Get client configuration](https://docs.agrisk.app/get-client-configuration-40857624e0.md): Returns the details of a client configuration from its identifier, including the full list of registered fields and sections. - Root > 🇺🇸 English > Client Configuration [Delete client configuration](https://docs.agrisk.app/delete-client-configuration-40857625e0.md): Permanently removes a company's client configuration, including all of its sections, fields and associated rules. - Root > 🇺🇸 English > Client Configuration [List sections](https://docs.agrisk.app/list-sections-40857626e0.md): Lists all sections registered in a client configuration, ordered by their index. Sections act as visual groupings of the client registration fields — for example, 'Personal data', 'Address' or 'Financial information'. - Root > 🇺🇸 English > Client Configuration [Create sections](https://docs.agrisk.app/create-sections-40857627e0.md): Creates one or more sections in an existing client configuration, in a batch. Each section requires `name` and `index`: the index determines the section's relative position among the others and is the only ordering mechanism honored by the API at this level — the ordering of fields within each section follows the order in which they are associated with it, not an individual index. - Root > 🇺🇸 English > Client Configuration [Get section](https://docs.agrisk.app/get-section-40857628e0.md): Returns the details of a specific section of a client configuration. - Root > 🇺🇸 English > Client Configuration [Update section](https://docs.agrisk.app/update-section-40857629e0.md): Updates an existing section by fully replacing its data. Since this is a complete replacement, both `name` and `index` must be sent: omitting either one returns a 400 error. - Root > 🇺🇸 English > Client Configuration [Partially update section](https://docs.agrisk.app/partially-update-section-40857630e0.md): Partially updates an existing section. Unlike the full replacement, this operation accepts only the fields that should change: any omitted field keeps its current value, including the ordering index. - Root > 🇺🇸 English > Client Configuration [Delete section](https://docs.agrisk.app/delete-section-40857631e0.md): Removes a section from a client configuration. Fields associated with the removed section stop belonging to a visual grouping; we recommend reassigning them to another section or unassigning them before removing the grouping, depending on the registration's needs. - Root > 🇺🇸 English > Client Configuration [List fields](https://docs.agrisk.app/list-fields-40857632e0.md): Lists all fields registered in a client configuration, including type, category, associated section (when any) and the remaining metadata of each field. - Root > 🇺🇸 English > Client Configuration [Create fields](https://docs.agrisk.app/create-fields-40857633e0.md): Creates one or more fields in an existing client configuration, in a batch. Use this endpoint to add new fields to an already created configuration — for the initial creation of a configuration and its fields, use client configuration creation instead. - Root > 🇺🇸 English > Client Configuration [Get field](https://docs.agrisk.app/get-field-40857634e0.md): Returns the details of a specific field of a client configuration. - Root > 🇺🇸 English > Client Configuration [Update field](https://docs.agrisk.app/update-field-40857635e0.md): Updates an existing field by fully replacing its data, including `name`, `type`, `index`, `description` and `help`. Since this is a complete replacement, the required attributes from the original record must be resent; omitting `description` or `help`, for example, returns a 400 error. - Root > 🇺🇸 English > Client Configuration [Partially update field](https://docs.agrisk.app/partially-update-field-40857636e0.md): Partially updates an existing field. Unlike the full replacement, it accepts only the attributes that should change — the rest keep their current value. - Root > 🇺🇸 English > Client Configuration [Delete field](https://docs.agrisk.app/delete-field-40857637e0.md): Removes a field from a client configuration, including any rules associated with it. - Root > 🇺🇸 English > Client Configuration [List rules](https://docs.agrisk.app/list-rules-40857638e0.md): Lists the conditional rules associated with a field of a client configuration. Rules define display or automatic calculation behaviors that depend on the value of other registration fields. - Root > 🇺🇸 English > Client Configuration [Create rule](https://docs.agrisk.app/create-rule-40857639e0.md): Creates a conditional rule associated with a field of a client configuration. A rule describes a trigger (`trigger`) and one of two possible behaviors: - Root > 🇺🇸 English > Client Configuration [Get rule](https://docs.agrisk.app/get-rule-40857640e0.md): Returns the details of a specific rule associated with a field of a client configuration. - Root > 🇺🇸 English > Client Configuration [Update rule](https://docs.agrisk.app/update-rule-40857641e0.md): Updates an existing rule by fully replacing its definition, including the trigger and the associated behavior (conditional display or calculation). Since this is a complete replacement, the sent body must contain the full definition of the desired rule. - Root > 🇺🇸 English > Client Configuration [Partially update rule](https://docs.agrisk.app/partially-update-rule-40857642e0.md): Partially updates an existing rule, changing only the attributes provided — such as the rule's activation (`active`) or targeted adjustments to conditions, actions or the calculation — and preserving the rest. - Root > 🇺🇸 English > Client Configuration [Delete rule](https://docs.agrisk.app/delete-rule-40857643e0.md): Removes a conditional rule from a field of a client configuration. The field remains in the registration schema, but no longer has the conditional display or automatic calculation behavior defined by the removed rule. ## Schemas - Root > API Requests [ClientResponse](https://docs.agrisk.app/clientresponse-13359461d0.md):