Skip to main content
POST
Record the assignment set's endorsement term

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

setId
string<uuid>
requerido

Approved assignment set identifier (uuid).

Cuerpo

application/json
coObligation
boolean
requerido

Whether this term binds the assignor to answer for the receivable it sold (coobrigação). REQUIRED, and the only accepted value is false. An omitted field is refused rather than read as false: silence about a signed instrument is not a statement about its clauses, and this table is append-only, so a term recorded under an assumption cannot be corrected afterwards. Same reason riskRetention is required on the fund route. A term WITH co-obligation is a retained-risk assignment under Res. CMN 4.966: the receivable stays on the balance sheet, the price is recorded as a liability and the result is appropriated over the remaining term. That treatment does not exist yet, so the clause is refused rather than recorded and then booked as an outright sale. Declared here as a structured fact and never read out of the document's wording.

idempotencyKey
string
requerido

Caller idempotency key. The same key replays the same term; the same key over a different approved composition, a different template version or different artifact bytes is refused.

Required string length: 1 - 256
artifact
string<byte>

The administrator's own signed endorsement term, base64-encoded. Required if and only if this fund's administrator generates the term; refused for a fund the Lender emits for.

artifactReference
string

The administrator's own identifier for that document (its term/protocol number). Required alongside artifact.

Maximum string length: 256

Respuesta

OK

assignmentFundId
string
requerido

The fund whose configured mode decided the origin (uuid).

assignmentSetId
string
requerido

The approved set this term covers (uuid).

coObligation
boolean | null
requerido

Whether this term binds the assignor to answer for the receivable it sold (coobrigação). Always false on a term this service recorded: the retained-risk treatment TRUE implies does not exist yet. NULL on a term recorded before the declaration existed — that is a gap in the record, not a statement that the instrument carries no recourse, and it must not be read as false.

contentDigest
string
requerido

sha-256 of the term document.

digestMethod
enum<string>
requerido

What contentDigest was computed over: the normalized form of our own render, or the raw bytes exactly as received.

Opciones disponibles:
sha256_pdf_normalized,
sha256_raw
id
string
requerido

Term record identifier (uuid).

idempotencyKey
string
requerido

Caller's idempotency key.

inputFingerprint
string
requerido

sha-256 of the caller-controlled comparison payload.

origin
enum<string>
requerido

Which path produced this term, resolved from the fund's configuration.

Opciones disponibles:
lender_emitted,
administrator_generated
recordedAt
string
requerido

UTC registration instant (RFC3339).

recordedBy
string
requerido

Validated actor identity that recorded the term.

replayed
boolean
requerido

True when this call replayed an existing term under the same idempotency key rather than recording a new one.

setSnapshotDigest
string
requerido

sha-256 of the frozen approved composition this term covers.

sizeBytes
integer<int64>
requerido

Byte count custody actually stored.

documentTemplateVersionId
string

Template version rendered from; present only for a lender-emitted term.

externalReference
string

The administrator's own document identifier; administrator-generated only.

externalSource
string

The administrator on record for the fund; resolved server-side, administrator-generated only.

pageGeometryRef
string

Versioned page geometry; lender-emitted only.

rendererVersion
string

Render engine identity; lender-emitted only.

specVersion
string

Field-assembly rules version; lender-emitted only.