Skip to main content
POST
Create document template draft

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

productId
string<uuid>
required

Owning loan product identifier.

Body

application/json
kind
enum<string>
required

Document kind. A loan product owns the CCB clausulado and nothing else: the registry's kind and scope form one closed domain, and the assignment endorsement term is published per fund under /api/v1/assignment/funds/{fundId}/document-templates.

Available options:
ccb
sections
object[] | null
required

Ordered clauses.

Minimum array length: 1
signatureBlock
string
required

Signature block text.

title
string
required

Template title.

requiredFields
string[] | null

Placeholder field names this template declares it needs; unioned with the jurisdiction's own minimum catalog at render time (Task 4.5.2).

Response

Created

active
boolean
required

Whether this is the currently active published version.

createdAt
string
required

Creation timestamp (RFC3339, UTC).

id
string
required

Template version identifier (uuid).

kind
string
required

Document kind.

requiredFields
string[] | null
required

Declared placeholder field names.

scopeId
string
required

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

scopeKind
string
required

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

sections
object[] | null
required

Ordered clauses.

signatureBlock
string
required

Signature block text.

status
string
required

Lifecycle status (draft|published).

title
string
required

Template title.

updatedAt
string
required

Last-update timestamp (RFC3339, UTC).

versionNumber
integer<int64>
required

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.