---
title: "Get credit operation descriptor"
method: GET
path: "/api/v1/br/loan-accounts/{id}/credit-descriptor"
tags: ["Loan Accounts"]
---

# Get credit operation descriptor

`GET /api/v1/br/loan-accounts/{id}/credit-descriptor`

## Request

- Base URL: `https://identity.sandbox.lerian.net`
- URL: `https://identity.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-descriptor`
- Auth: none required
- TypeScript: <https://skmtc.dev/lerian/apis/identity-plugin/docs/api/v1/br/loan-accounts/:id/credit-descriptor/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the Res. CMN 5.004/2022 credit operation descriptor, optionally reconstructed as of a business date.

## Path parameters

- `id` string, uuid, required: Loan account identifier.

## Query parameters

- `asOfDate` string, date: Optional as-of date (YYYY-MM-DD) to reconstruct the descriptor.

## Response `200`

OK

- CreditOperationDescriptorResponse
  - `accrualState` string: Interest accrual state: accruing or suspended; omitted when not set.
  - `annualRate` string, required: Contractual nominal annual interest rate as a percentage decimal string.
  - `asOfDate` string, required: Valuation date the financial figures are reconstructed as of (YYYY-MM-DD, UTC).
  - `cetAnnualPct` string, required: Custo Efetivo Total, annualized, as a percentage decimal string.
  - `cetMonthlyPct` string, required: Custo Efetivo Total, monthly, as a percentage decimal string.
  - `consumerProtectionRegime` string: Applicable consumer-protection regime label; omitted when not classified.
  - `createdAt` string, required: RFC3339 UTC timestamp when the descriptor record was created.
  - `descriptorDate` string, required: Date the descriptor snapshot was generated (YYYY-MM-DD, UTC).
  - `id` string, required: Unique identifier (UUID) of the credit operation descriptor snapshot.
  - `installmentCount` integer, required: Total number of installments in the amortization schedule.
  - `iofAmount` string: IOF (Imposto sobre Operacoes Financeiras) amount as a decimal string, scale 2; omitted when not applicable.
  - `jurisdictionCode` string, required: ISO jurisdiction code governing the descriptor (e.g. "BR").
  - `lastPaymentDate` string: Date of the most recent payment received (YYYY-MM-DD, UTC); omitted if no payment recorded.
  - `loanAccountId` string, required: UUID of the loan account the descriptor summarizes.
  - `loanApplicationId` string, required: UUID of the originating loan application.
  - `monthlyRate` string, required: Contractual nominal monthly interest rate as a percentage decimal string.
  - `nextDueDate` string: Due date of the next scheduled installment (YYYY-MM-DD, UTC); omitted if none pending.
  - `originalTerm` integer, required: Original contracted term of the loan in number of installments.
  - `outstandingBalance` string, required: Total outstanding balance (principal plus accrued charges) as a decimal string, scale 2.
  - `overdueInstallmentCount` integer, required: Number of installments currently past due.
  - `paidInstallmentCount` integer, required: Number of installments fully paid to date.
  - `pddStage` string: Current PDD delinquency staging: one of current, stage_1, stage_2, stage_3; omitted when unstaged.
  - `prepaymentSettlementId` string: UUID of the prepayment settlement that closed the operation; omitted unless settled via prepayment.
  - `principalOutstanding` string, required: Outstanding principal as a decimal string in major currency units, scale 2.
  - `profileVersion` string, required: Jurisdiction profile version used to compute the descriptor.
  - `refreshedAt` string, required: RFC3339 UTC timestamp when the descriptor figures were last refreshed.
  - `status` string, required: Lifecycle status of the credit operation (e.g. active, settled).
  - `totalCharges` string, required: Cumulative fees and charges as a decimal string in major currency units, scale 2.
  - `totalTaxes` string, required: Cumulative taxes as a decimal string in major currency units, scale 2.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/lerian/apis/identity-plugin.md) - [All operations](https://skmtc.dev/lerian/apis/identity-plugin/llms.txt) - [OpenAPI document](https://skmtc.dev/lerian/apis/identity-plugin/revisions/25daba385532?raw)