Corgi BankDocumentation
OpenAPI

Report a loan's current facts (the lending service): a pledged loan that went past due, to nonaccrual, charged off or paid off stops lending at once

POST/ledger/collateral/loan-facts

Only the lending service's own identity svc_lending holding ledger:post (never staff or an API key) reports a loan's facts; any other caller is refused 403 forbidden. A live pledge is re-evaluated at once; an acknowledged pledge on a loan paid off, charged off or matured opens a pledged_asset_ended break.

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

as_ofstring · dateRequired

A business date, YYYY-MM-DD

asset_classstringRequired
charged_offbooleanRequired
days_past_dueintegerRequired
loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired
nonaccrualbooleanRequired
participations_sold_amountintegerRequired
product_codestringRequired
statusstringRequired
unpaid_principal_amountintegerRequired

Returns

200 OK

assetobjectRequired

CollateralAsset is one bank-owned asset the register values.

12 child attributes
asset_classstringRequired
idintegerRequired
kindstringRequired

Securities_lot or loan

loanobject or nullOptional

LoanCollateralFacts are the lending service's facts about a loan as of a date.

12 child attributes
as_ofstring · dateRequired

A business date, YYYY-MM-DD

asset_classstringRequired
charged_offbooleanRequired
days_past_dueintegerRequired
loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired
nonaccrualbooleanRequired
participations_sold_amountintegerRequired
product_codestringRequired
statusstringRequired
unpaid_principal_amountintegerRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired
referencestringRequired
updated_atstring · date-timeRequired
valuation_as_ofstring · dateRequired

A business date, YYYY-MM-DD

valuation_basisstringRequired
valuation_sha256stringOptional
value_amountintegerRequired
created_atstring · date-timeRequired
eligiblebooleanRequired
haircut_bpsintegerRequired
idintegerRequired
ineligibilityarray of stringsRequired
lendable_amountintegerRequired
lender_idintegerRequired
makerstringRequired
pledge_referencestringOptional
statestringRequired

Reserved, pledged, releasing or released

updated_atstring · date-timeRequired
value_amountintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close