Corgi BankDocumentation
OpenAPI

The Collateral Loan object

CollateralLoan is what the ledger's collateral register asks lending about a loan: the facts it values and judges eligibility on, and the loan's current encumbrance in that register.

Attributes

as_ofstring · dateRequired

A business date, YYYY-MM-DD

asset_classstringRequired

The collateral class the product's Call Report RC-C item maps to

charged_offbooleanRequired
days_past_dueintegerRequired
encumbranceobject or nullOptional

LoanEncumbrance is the register's live pledge of a loan: while set, the loan cannot be sold or participated out.

5 child attributes
atstring · date-timeRequired
lender_idintegerRequired
lender_namestringRequired
pledge_idintegerRequired
statestringRequired

Reserved, pledged or releasing

loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired

A legacy loan whose maturity could not be derived; never pledgeable

nonaccrualbooleanRequired
participations_sold_amountintegerRequired
product_codestringRequired
statusstringRequired
unpaid_principal_amountintegerRequired

Outstanding less the participated-out share

to move to open esc to close