Get opinion configuration

Returns the opinion configuration associated with the flow, including the title shown to analysts and the list of complementary fields that have been configured.

The technical opinion always includes three native fields, created automatically by the API as soon as the configuration is saved: the status set by the analyst (approved or rejected), the approved credit limit (a monetary value), and the analyst's opinion text. Beyond these three, the configuration can include complementary fields specific to the analysis — for example, guarantees offered, guarantee expiration date, or an internal score. Each complementary field returned carries its identifier (id), which is required to reference it in a future update.

Although the path includes a phase identifier, the opinion configuration is unique per flow, not per phase — it is created once (on any phase) and then enabled on each analysis phase through the corresponding phase action.

When the flow does not yet have an opinion configuration, the API returns success with an empty body, rather than a not-found error. Treat an empty body as 'not configured yet', not as a failure.

The returned fields can include entries that were soft-deleted, identified by active:false and a null index. When using this response as the basis for building an update payload, discard those entries before resubmitting.

application/json

The flow's opinion configuration. When the flow does not yet have opinion configured, the API responds 200 with an empty body ({}) instead of an error.

Bodyapplication/json

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

Get opinion configuration

Requisição

Respostas