Skip to main content
PUT
Archive or unarchive a loan product

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string<uuid>
required

Loan product identifier.

Example:

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

Body

application/json
archived
boolean
required

true archives the product; false unarchives it.

Example:

true

Response

OK

createdAt
string
required

Creation timestamp (RFC3339, UTC).

Example:

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

id
string
required

Server-assigned loan product identifier (uuid).

Example:

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

jurisdictionCode
string
required

Jurisdiction profile code (e.g. BR).

Example:

"BR"

loanType
string
required

Loan product type.

Example:

"personal"

name
string
required

Loan product display name.

status
string
required

Lifecycle status: draft, active or archived.

Example:

"active"

currentVersionId
string

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

Example:

"550e8400-e29b-41d4-a716-44665544000a"