Skip to main content
POST
Declare a qualitative problem-asset assessment

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Canonical idempotency request ID. Required: a declaration changes what the contract is provisioned at, so without a key a retry cannot be told apart from a second characterisation.

Path Parameters

id
string<uuid>
required

Loan account (contract) identifier.

Body

application/json
characterizesProblemAsset
boolean
required

The verdict. False records that the trigger was evaluated and did NOT characterise the asset — which is how a prior characterisation is withdrawn, and is not the same as never having looked.

evaluatedOn
string
required

The business day the assessment was made (YYYY-MM-DD). A day and not an instant: it is compared against a competencia, which is a civil day.

Example:

"2026-09-30"

evidenceReference
string
required

Mandatory pointer to the evidence: a document id, a case number, a URL. Required because this declaration suspends the contract's income recognition and raises its provision, and one that cites nothing cannot be reviewed.

Maximum string length: 512
Example:

"proc-0801234-56.2026.8.26.0100"

source
string
required

Where the characterisation came from: the credit committee, the bureau feed, the court notice.

Maximum string length: 256
Example:

"Comite de credito 2026-09-30"

trigger
string
required

The norm article the assessment invokes. Free text because art. 3 par. 2 is an open list ("entre outros"): the console offers the incisos as presets and accepts any other article an assessor names. Stored trimmed and lower-cased, because the article is the identity a later withdrawal has to match: sent as ART_3_P2_III it is stored, returned and withdrawn as art_3_p2_iii. Examples: art_3_p1, art_3_p2_i, art_3_p2_iii, art_3_p2_iv, art_3_p2_vi.

Maximum string length: 128
Example:

"art_3_p2_iii"

declaredBy
string

Declaring subject, used ONLY on a deployment with authentication disabled. When the request carries a validated identity, that subject is recorded and this field is ignored.

Maximum string length: 256
evidenceNotes
string

The assessor's own notes. Optional: the reference is what makes the declaration checkable, the prose is what makes it readable.

Maximum string length: 4096

Response

Created

assessmentId
string
required

Identity of this declaration.

characterizesProblemAsset
boolean
required

The verdict recorded.

createdAt
string
required

When the declaration was recorded (RFC 3339, UTC).

declaredBy
string
required

Authenticated subject that declared it, as free text.

evaluatedOn
string
required

Business day the assessment was made (YYYY-MM-DD).

evidenceNotes
string
required

The assessor's own notes, empty when none were written.

evidenceReference
string
required

Pointer to the evidence behind the declaration.

loanAccountId
string
required

Contract the declaration is about.

source
string
required

Where the characterisation came from.

trigger
string
required

The norm article invoked, trimmed and lower-cased. This is the form a withdrawal of this declaration must use.