Skip to main content
POST
Create assignment fund document template draft

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

fundId
string<uuid>
obrigatório

Owning assignment fund identifier.

Corpo

application/json
kind
enum<string>
obrigatório

Document kind; a fund owns the endorsement-term clausulado and nothing else.

Opções disponíveis:
assignment_term
sections
object[] | null
obrigatório

Ordered clauses.

Minimum array length: 1
signatureBlock
string
obrigatório

Signature block text.

title
string
obrigatório

Template title.

requiredFields
string[] | null

Placeholder field names this template declares it needs; the term recorder supplies them from the approved set's frozen snapshot.

Resposta

Created

active
boolean
obrigatório

Whether this is the currently active published version.

createdAt
string
obrigatório

Creation timestamp (RFC3339, UTC).

id
string
obrigatório

Template version identifier (uuid).

kind
string
obrigatório

Document kind.

requiredFields
string[] | null
obrigatório

Declared placeholder field names.

scopeId
string
obrigatório

Owner identifier (uuid): the loan product or the assignment fund.

scopeKind
string
obrigatório

Owner kind this template hangs off (loan_product|assignment_fund).

sections
object[] | null
obrigatório

Ordered clauses.

signatureBlock
string
obrigatório

Signature block text.

status
string
obrigatório

Lifecycle status (draft|published).

title
string
obrigatório

Template title.

updatedAt
string
obrigatório

Last-update timestamp (RFC3339, UTC).

versionNumber
integer<int64>
obrigatório

Sequential version number within (tenant, product, kind).

loanProductId
string

Owning loan product identifier (uuid); absent on a fund-scoped template.

publishedAt
string

Publication timestamp (RFC3339, UTC); absent while draft.