Skip to main content
POST
Issue credit instrument

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

applicationId
string<uuid>
obrigatório

Loan application identifier.

Corpo

application/json
idempotencyKey
string
obrigatório

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.

Resposta

Created

contentDigest
string
obrigatório

sha-256 hex digest of the rendered PDF bytes.

createdAt
string
obrigatório

Row creation timestamp (RFC3339, UTC).

documentTemplateVersionId
string
obrigatório

Exact template version rendered (uuid).

emittedAt
string
obrigatório

Emission instant (RFC3339, UTC).

emittedBy
string
obrigatório

Validated actor identity that requested emission.

id
string
obrigatório

Instrument identifier (uuid).

idempotencyKey
string
obrigatório

Caller's idempotency key.

loanApplicationId
string
obrigatório

Owning loan application identifier (uuid).

sizeBytes
integer<int64>
obrigatório

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.