Criar configuração do parecer técnico

Cria a configuração do parecer técnico (opinion) de um fluxo, habilitando a coleta de um parecer estruturado nas fases de análise.

O payload aceita exatamente duas chaves no nível superior: title (o rótulo do parecer, exibido aos analistas) e fields (a lista de campos complementares). Qualquer outra chave no nível superior — como description, blocksMovement, slug, uiComponent, active ou rules — é rejeitada com erro 400.

Assim que a configuração é salva, a API cria automaticamente três campos nativos: o status definido pelo analista (aprovado ou reprovado), o limite de crédito aprovado (valor monetário) e o texto do parecer do analista. Não inclua em fields nenhum campo com esse mesmo propósito — nomes como 'Aprovado', 'Reprovado', 'Parecer do Analista', 'Conclusão', 'Recomendação' ou 'Justificativa' duplicam os nativos, resultando em exibição repetida na interface. Utilize fields apenas para informações complementares específicas da análise, como garantias oferecidas, vencimento de garantia ou score interno.

Cada item de fields exige name, type, index (posição de exibição) e editable. Para campos do tipo seleção (select, radio ou checkList), as opções em options devem ser uma lista simples de strings — não um objeto com label e value. O parâmetro help é opcional e adiciona um texto de apoio ao campo. Não inclua a chave active dentro dos itens de fields — ela é rejeitada com erro 400; o estado de ativação de cada campo é controlado pela própria API.

A configuração do parecer é única por fluxo, independentemente da fase informada no caminho. Se o fluxo já possuir uma configuração, o comportamento equivale a uma atualização da configuração existente.

Criar esta configuração, por si só, não é suficiente para que o parecer apareça para os usuários na fase — é necessário também habilitar o módulo por meio da ação de fase correspondente (action: opinion), da mesma forma que os demais módulos do fluxo.

application/json

A configuração do parecer técnico foi criada com sucesso, já incluindo os três campos nativos gerados automaticamente pela API.

Bodyapplication/json

curl --location '/v1/flows//phases//opinion-config' \ --header 'Content-Type: application/json' \ --data '{ "title": "string", "fields": [ { "name": "string", "type": "shortText", "help": "string", "index": 0, "editable": true, "options": [ "string" ] } ] }'

{ "id": "string", "title": "string", "fields": [ { "id": "string", "name": "string", "type": "string", "active": true, "index": 0, "editable": true, "help": "string", "options": [ "string" ] } ] }

Criar configuração do parecer técnico

Requisição

Respostas