Corgi BankDocumentation
OpenAPI

Read retained placement controls and independent review

GET/placement-controls/{id}

Verified placement staff/service reader only; original program/capacity and independent decision.

Path parameters

idstringRequired

Returns

200 OK

actorstringRequired
capacityobject or nullOptional
7 child attributes
capacitystringRequired

Single only in this implementation

evidenceobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
external_amountinteger or nullOptional

Includes principal + accrued interest, excludes this module's positions

fdic_certificatestringRequired
observed_atstring · date-timeRequired
owner_idstringRequired
valid_untilstring · date-timeRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
kindstringRequired
programobject or nullOptional
24 child attributes
agency_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
agency_titlestringRequired
annual_rate_bpsintegerRequired

Same actual and customer-facing terms

bank_eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
capacity_rulesobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
customer_disclosureobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
fdic_certificatestringRequired
interest_basisstringRequired
interest_reserve_amountintegerRequired
legal_entitystringRequired
maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

max_principal_amountintegerRequired
productstringRequired

Demand or certificate

providerstringRequired
receipt_keysobjectRequired
receiver_referencestringRequired
receiving_bank_namestringRequired
routing_numberstringRequired
tax_reporterstringRequired
tax_reporting_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

Errors

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

400401403404409412413422424429500503

to move to open esc to close