Configuração de Cliente
Copiar Página
AgRisk
AgRisk
Documentação
AgRisk
API - AgRisk
Login
Atualizar token
Autenticar usuário
Consultas
Solicitar consulta
Listar consultas
Listar consultas da empresa
Listagem de Produtos
Listar produtos
Clientes
Listar clientes
Criar cliente
Listar contadores de clientes
Deletar cliente
Listar contadores de clientes no grupo
Dados Cadastrais
Buscar dados cadastrais
Grupos
Listar grupos
Criar grupo
Listar clientes em grupo
Criar cliente em grupo
Atualizar nome do grupo
Deletar grupo
Inserir cliente em grupo
Remover cliente de grupo
Análise de Matrícula
Listar análises de matrículas
Criar análise de matrícula
Buscar análise de matrícula
Deletar análise de matrícula
Contatos
Listar contatos
BNDES
Listar BNDES
Boa Vista
Listar Boa Vista
Compliance
Listar compliance
CPRs
Listar CPRs
Buscar CPR
Grupo econômico
familiar
Listar grupo econômico
Listar grupo familiar
Imposto de Renda
Criar ativo financeiro
Listar ativos financeiros
Criar dívida
Importar dívidas
Listar dívidas
Atualizar dívida
Deletar dívida
Criar ativo móvel
Listar ativos móveis
Atualizar ativo móvel
Deletar ativo móvel
Criar imóvel urbano
Listar imóveis urbanos
Atualizar imóvel urbano
Deletar imóvel urbano
Judicial
Listar processos judiciais
Buscar processo judicial
Solicitar análise por IA
Protestos
Listar protestos
Imóveis Rurais - Simples
Criar imóvel rural
Listar imóveis rurais
Buscar imóvel rural
Endividamento
Listar SCR (endividamento)
Imóveis Rurais - CAR
Listar CAR (Cadastro Ambiental Rural)
Buscar CAR
Deletar CAR
Criar CAR
Download certidão CAR
QUOD
Buscar Quod
Restritivo Nacional
Buscar Restritivo Nacional
Veicular
Buscar Patrimônio Veicular
Sintegra
Listar Sintegras
APIs
Raiz
Esquemas
API Requests
ClientResponse
AgFlow
🇧🇷 Português
Aprovação
Aprovação — Visão Geral
Consultar configuração de aprovação
Criar configuração de aprovação
Atualizar configuração de aprovação
Adicionar regra de aprovação
Atualizar regra de aprovação
Remover configuração de aprovação
Consultar aprovação do card
Registrar voto de aprovação
Atualizar voto de aprovação
Fluxo
Fluxo — Visão Geral
Verificar disponibilidade
Criar fluxo
Listar fluxos
Obter fluxo
Atualizar fluxo
Remover fluxo
Adicionar usuário ao fluxo
Remover usuário do fluxo
Listar caminhos de campos dinâmicos
Consulta a Bureau
Consulta a Bureau — Visão Geral
Obter configuração de consulta a bureau
Criar configuração de consulta a bureau
Atualizar configuração de consulta a bureau
Campos
Campos — Visão Geral
Listar campos da fase
Atualizar campos da fase
Atualizar regras de campos da fase
Conversa
Conversa — Visão Geral
Obter configuração de conversa
Criar configuração de conversa
Remover configuração de conversa
Motores
Motores — Visão Geral
Consultar resultado do motor de decisão do card
Executar motor de decisão no card
Consultar inputs do motor de crédito para o card
Consultar resultado do motor de crédito do card
Executar motor de crédito no card
Consultar configuração do motor de decisão
Criar configuração do motor de decisão
Atualizar configuração do motor de decisão
Remover configuração do motor de decisão
Consultar detalhe da configuração do motor de crédito
Criar configuração do motor de crédito
Listar configurações do motor de crédito do flow
Listar políticas de crédito aplicáveis a um card
Atualizar configuração do motor de crédito
Remover configuração do motor de crédito
Parecer
Parecer — Visão Geral
Consultar configuração do parecer técnico
Criar configuração do parecer técnico
Atualizar configuração do parecer técnico
Consultar parecer registrado no card
Registrar parecer no card
Atualizar parecer no card
Formulário Inicial
Formulário Inicial — Visão Geral
Criar formulário inicial
Definir regras condicionais do formulário
Atualizar metadados do formulário
Consultar formulário inicial
Consultar formulário público
Atualizar campos do formulário
Remover formulário inicial
Filtros
Filtros — Visão Geral
Listar filtros salvos
Criar filtro salvo
Atualizar filtro salvo
Buscar cards do flow
Busca global de cards
AgRisk
AgRisk — Visão Geral
Listar produtos de consulta AgRisk
Gatilhos
Gatilhos — Visão Geral
Listar gatilhos do flow
Criar gatilho
Atualizar gatilho
Remover gatilho
Listar gatilhos da fase
Autenticação
Autenticação — Visão Geral
Autenticar usuário
Mensageria
Mensageria — Visão Geral
Configurar telefone
Consultar configuração de mensageria
Criar configuração de mensageria
Atualizar configuração de mensageria
Criar regras de mensageria
Atualizar regra de mensageria
Remover configuração de mensageria
Empresas e Papéis
Empresas e Papéis — Visão Geral
Listar usuários da empresa
Listar papéis da empresa
Atualizar papel
Listar catálogo de permissões
Criar papel
Gerar URL de upload do logotipo
Gerar URL de download do logotipo
Atribuir papéis a um usuário
Documentos
Documentos — Visão Geral
Criar configuração de geração automática de documento
Remover configuração de geração automática de documento
Consultar configuração de geração automática de documento
Atualizar configuração de geração automática de documento
Consultar campos para geração do documento
Gerar documento a partir de template
Consultar template por ID
Listar templates do card
Ativar template
Criar template de documento
Remover template
Listar templates
Definir campos do template
Configurar regras condicionais do template
Atualizar arquivo do template
Cards
Cards — Visão Geral
Listar cards de uma fase
Mover card de fase
Criar card
Listar cards do flow
Criar card via link público
Buscar cards
Obter card
Atualizar card
Atualizar responsável do card
Atualizar campos via link público
Atualizar campos de fase do card
Remover cards em lote
Atualizar Ficha Cadastral do card
Obter responsável do card
Listar etiquetas do card
Listar campos de uma fase do card
Listar campos de uma fase do card (link público)
Obter histórico do card
Listar clientes do card
Criar comentário no card
Listar comentários do card
Remover comentário do card
Listar anexos do card
Cadastrar anexo no card
Remover anexo do card
Remover vínculo do anexo com campo de fase
Adicionar membros ao grupo do card
Remover membro do grupo do card
Configuração de Cliente
Configuração de Cliente — Visão Geral
Obter configuração de cliente por empresa
GET
Criar configuração de cliente
POST
Atualizar configuração de cliente
PUT
Obter configuração de cliente
GET
Remover configuração de cliente
DELETE
Listar seções
GET
Criar seções
POST
Obter seção
GET
Atualizar seção
PUT
Atualizar seção parcialmente
PATCH
Remover seção
DELETE
Listar campos
GET
Criar campos
POST
Obter campo
GET
Atualizar campo
PUT
Atualizar campo parcialmente
PATCH
Remover campo
DELETE
Listar regras
GET
Criar regra
POST
Obter regra
GET
Atualizar regra
PUT
Atualizar regra parcialmente
PATCH
Remover regra
DELETE
Fase
Fase — Visão Geral
Criar ação de fase
Criar fase
Remover ação de fase
Remover fase
Listar ações da fase
Listar fases
Atualizar ação de fase
Atualizar fase
🇺🇸 English
Phase
Phase — Overview
Create phase action
Create phase
Delete phase action
Delete phase
List phase actions
List phases
Update phase action
Update phase
Approval
Approval — Overview
Get approval configuration
Create approval configuration
Update approval configuration
Add approval rule
Update approval rule
Delete approval configuration
Get card approval
Register approval vote
Update approval vote
Flow
Flow — Overview
Health check
Create flow
List flows
Get flow
Update flow
Delete flow
Add user to flow
Remove user from flow
List dynamic field paths
Bureau Query
Bureau Query — Overview
Get bureau query configuration
Create bureau query configuration
Update bureau query configuration
Fields
Fields — Overview
List phase fields
Update phase fields
Update phase field rules
Engines
Engines — Overview
Get card decision engine result
Run card decision engine
Get card credit engine inputs
Get card credit engine result
Run card credit engine
Get decision engine configuration
Create decision engine configuration
Update decision engine configuration
Delete decision engine configuration
Get credit engine configuration detail
Create credit engine configuration
List flow credit engine configurations
List credit policies applicable to a card
Update credit engine configuration
Delete credit engine configuration
Conversation
Conversation — Overview
Get conversation configuration
Create conversation configuration
Delete conversation configuration
Opinion
Opinion — Overview
Get opinion configuration
Create opinion configuration
Update opinion configuration
Get card opinion
Create card opinion
Update card opinion
Start Form
Start Form — Overview
Create start form
Set start form conditional rules
Update start form metadata
Get start form
Get public start form
Update start form fields
Delete start form
Filters
Filters — Overview
List saved filters
Create saved filter
Update saved filter
Search flow cards
Search cards across flows
AgRisk
AgRisk — Overview
List AgRisk query products
Triggers
Triggers — Overview
List flow triggers
Create trigger
Update trigger
Delete trigger
List phase triggers
Authentication
Authentication — Overview
Authenticate user
Messaging
Messaging — Overview
Configure phone
Get messaging config
Create messaging config
Update messaging config
Create messaging rules
Update messaging rule
Delete messaging config
Companies & Roles
Companies & Roles — Overview
List company users
List company roles
Update role
List permissions catalog
Create role
Generate company logo upload URL
Generate company logo download URL
Assign roles to a user
Documents
Documents — Overview
Create automatic document configuration
Delete automatic document configuration
Get automatic document configuration
Update automatic document configuration
Get fields for document generation
Generate document from template
Get template by ID
List card templates
Activate template
Create document template
Delete template
List templates
Set template fields
Configure template conditional rules
Update template file
Cards
Cards — Overview
List cards in a phase
Move card to another phase
Create card
List flow cards
Create card via public link
Search cards
Get card
Update card
Update card assignee
Update fields via public link
Update card phase fields
Delete cards in bulk
Update card registration record
Get card assignee
List card labels
List card phase fields
List card phase fields (public link)
Get card history
List card clients
Create card comment
List card comments
Delete card comment
List card attachments
Register card attachment
Delete card attachment
Delete attachment's phase-field link
Add members to card group
Remove card group member
Client Configuration
Client Configuration — Overview
Get client configuration by company
Create client configuration
Update client configuration
Get client configuration
Delete client configuration
List sections
Create sections
Get section
Update section
Partially update section
Delete section
List fields
Create fields
Get field
Update field
Partially update field
Delete field
List rules
Create rule
Get rule
Update rule
Partially update rule
Delete rule
💼 Visão de Negócio
Fase
Fluxo
Campos — Visão de Negócio
Aprovação
Parecer
Motores
Empresas e Papéis
Gatilhos
Conversa
Documentos
Mensageria
Filtros
Autenticação
Configuração de Cliente
Cards
AgRisk
Formulário Inicial
Consulta a Bureau
💼 Business Overview
Phase
Flow
Approval
Fields — Business Overview
Opinion
Engines
Companies & Roles
Documents
Triggers
Messaging
Conversation
Filters
Authentication
Client Configuration
Cards
AgRisk
Start Form
Bureau Query
Portfolio
Documentação
Empresa
Gestão de portfolio
Análise geral
Dicionário de campos base (Necessário validar)
[Desatualizado]Fluxo de funcionamento
Carteiras
Gestão da carteira
Contratos
Contratos
Template Contratos
Pagamentos
Pagamentos
Baixas
Baixas
Clientes
Devedores e credores (Participantes)
Informações dos clientes
Importação de dados
Importação de dados
Garantia
Colaterais
Gestão de Cobrança
Régua de cobrança
Regras da régua por empresa
Atividades
Regras das Atividades
Configuração de Cliente
Copiar Página
Obter seção
GET
/v1/client-config/{clientConfigId}/sections/{sectionId}
Testar
Run in Apidog
Run in Apidog
Retorna os detalhes de uma seção específica de uma configuração de cliente.
Requisição
Parâmetros de Caminho
Gerar Código
Respostas
🟢
200
Seção encontrada
application/json
A seção foi encontrada.
Body
application/json
Gerar Código
🟠
404
Seção não encontrada
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'/v1/client-config//sections/'
Response
Response Example
200 -
Exemplo 1
{
"id"
:
"string"
,
"name"
:
"string"
,
"index"
:
0
}
Modificado em
2026-07-28 20:38:32
Página anterior
Criar seções
Próxima página
Atualizar seção