Saltar al contenido principal
POST
Create loan application

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Canonical idempotency request ID (lib-commons enforcer reads this). Required: without a key a retry of this request cannot be told apart from a second instruction, and the duplicate it books is undone by hand.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440003"

Cuerpo

application/json
borrowerId
string<uuid>
requerido

Borrower identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

borrowerKind
enum<string>
requerido

Whose credit this is: the taxpayer kind of the borrower, as established by the KYC the client performed. REQUIRED. Brazil charges a different daily IOF aliquota per kind (Decreto 6.306/2007, art. 7o, I, "b"), so the withholding cannot be computed without it and the service will not guess. The pinned product version must admit the kind named here, or the application is refused with 422 LENDER-0228; a version that declared no kinds admits none.

Opciones disponibles:
pessoaFisica,
pessoaJuridica
Ejemplo:

"pessoaFisica"

expectedDisbursementDate
string
requerido

Expected disbursement date (RFC3339).

Ejemplo:

"2026-06-14T12:00:00Z"

loanProductVersionId
string
requerido

Loan product version identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

requestedInstallments
integer<int64>
requerido

Number of installments.

Rango requerido: 1 <= x <= 600
Ejemplo:

24

requestedInterestRate
string
requerido

Requested monthly interest rate as a decimal string, scale 8 (e.g. "0.00000100").

Ejemplo:

"0.00000100"

requestedPrincipalAmount
string
requerido

Requested principal amount as a decimal string (e.g. "50000.00").

Ejemplo:

"50000.00"

previewScheduleSnapshotId
string<uuid>

Schedule offer this application cites: the scheduleOfferSnapshotId a schedule preview returned. OPTIONAL — an application does not have to be simulated first. When supplied it must name an offer on file, or the application is refused with LENDER-0236; its terms are never compared with the application's.

Ejemplo:

"6ba7b810-9dad-11d1-80b4-00c04fd430c8"

Respuesta

Created

assignedOfficerId
string
requerido

Authenticated officer who created the application (request subject), or empty on a system-originated application, which has no human officer. Whatever the identity provider issues as the subject: not necessarily a UUID, at most 255 characters.

Ejemplo:

"officer-xyz"

borrowerId
string<uuid>
requerido

Borrower identifier (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

expectedDisbursementDate
string
requerido

Expected disbursement date (RFC3339, UTC).

Ejemplo:

"2026-06-14T12:00:00Z"

id
string
requerido

Loan application identifier (UUID).

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

loanProductVersionId
string
requerido

Loan product version this application was created against (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

previewJurisdictionCode
string
requerido

ISO-2 jurisdiction code resolved at preview time.

Ejemplo:

"BR"

previewProfileVersion
string
requerido

Jurisdiction profile version resolved at preview time.

Ejemplo:

"1.0.0"

requestedInstallments
integer<int64>
requerido

Number of installments requested.

Ejemplo:

24

requestedInterestRate
string
requerido

Requested monthly interest rate as a decimal string, scale 8 (e.g. "0.00000100").

Ejemplo:

"0.00000100"

requestedPrincipalAmount
string
requerido

Requested principal amount as a decimal string, minor-unit precision scale 2 (e.g. "50000.00").

Ejemplo:

"50000.00"

status
string
requerido

Lifecycle status: one of pending_approval, approved, rejected, withdrawn, disbursed.

Ejemplo:

"pending_approval"

approvalDecision
object

Approval facts; present only when the application is approved or disbursed.

borrowerKind
string

Whose credit this is, as declared at creation. ABSENT on an application created before the declaration existed: such an application cannot be taxed or described, and the paths that need the kind refuse it with LENDER-0230 rather than assuming one.

Ejemplo:

"pessoaFisica"

disbursementEvent
object

Disbursement facts; present only when the application is disbursed.

previewScheduleSnapshotId
string

Schedule offer this application cites (UUID). ABSENT when it cites none, which is allowed: simulating first is optional.

Ejemplo:

"6ba7b810-9dad-11d1-80b4-00c04fd430c8"

rejectionDecision
object

Rejection facts; present only when the application is rejected.

withdrawalDecision
object

Withdrawal facts; present only when the application is withdrawn.