v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

LoanProducts

Create loan product (BR alias)

BR-aliased path for creating a loan product. Resolves to the same handler as the core endpoint.

post/api/v1/br/loan-products

Request body

jurisdictionCodestring required

Jurisdiction profile code (e.g. BR).

jurisdictionExtensionsobject

Opaque per-jurisdiction product fields.

loanTypestring required

Loan product type.

namestring required

Loan product display name.

Example request

{
  "jurisdictionCode": "BR",
  "loanType": "personal"
}

Response

Created

createdAtstring required

Creation timestamp (RFC3339, UTC).

currentVersionIdstring

Identifier (uuid) of the pinned active version; empty until activation.

idstring required

Server-assigned loan product identifier (uuid).

jurisdictionCodestring required

Jurisdiction profile code (e.g. BR).

loanTypestring required

Loan product type.

namestring required

Loan product display name.

statusstring required

Lifecycle status (e.g. draft|active).

Example response

{
  "createdAt": "2026-06-14T12:00:00Z",
  "currentVersionId": "550e8400-e29b-41d4-a716-44665544000a",
  "id": "550e8400-e29b-41d4-a716-446655440009",
  "jurisdictionCode": "BR",
  "loanType": "personal",
  "status": "active"
}