Skip to main content
POST
Issue credit instrument

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

applicationId
string<uuid>
required

Loan application identifier.

Body

application/json
idempotencyKey
string
required

Caller idempotency key. The same key replays the same instrument; the same key with a different parties block is refused.

Minimum string length: 1
parties
object

Caller-supplied parties block (issuer/creditor names and documents, place of issuance/payment, and any other field the resolved template or the jurisdiction's legal catalog declares). Frozen into the instrument's snapshot; the core stores no borrower PII beyond it.

Response

Created

contentDigest
string
required

sha-256 hex digest of the rendered PDF bytes.

createdAt
string
required

Row creation timestamp (RFC3339, UTC).

documentTemplateVersionId
string
required

Exact template version rendered (uuid).

emittedAt
string
required

Emission instant (RFC3339, UTC).

emittedBy
string
required

Validated actor identity that requested emission.

id
string
required

Instrument identifier (uuid).

idempotencyKey
string
required

Caller's idempotency key.

loanApplicationId
string
required

Owning loan application identifier (uuid).

sizeBytes
integer<int64>
required

Size of the rendered document in bytes.

supersededByInstrumentId
string

Identifier (uuid) of the later instrument, for the same loan application, that superseded this one. Set only on the list endpoint; absent means this is the current instrument for its application.