Corgi BankDocumentation
OpenAPI

Review every account for dormancy and list escheat candidates by state

POST/accounts/dormancy-runs

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

business_datestringOptional
operatorstringRequired

Returns

200 OK

accountsarray of objectsRequired
14 child attributes
abandonment_basisstringRequired

Statute, tables or default

abandonment_citationstringRequired
abandonment_yearsintegerRequired
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

balance_amountintegerRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

eligiblebooleanRequired
eligible_onstring · dateRequired

A business date, YYYY-MM-DD

inactive_monthsintegerRequired
last_activity_datestring · dateRequired

A business date, YYYY-MM-DD

notice_sent_atstring · date or nullOptional

A business date, YYYY-MM-DD

notice_windowobjectRequired

DueDiligence is a state's due-diligence notice window before an escheat.

3 child attributes
citationstringRequired
max_daysintegerRequired
min_daysintegerRequired
statestringRequired
statusstringRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

escheat_candidatesintegerRequired
newly_dormantintegerRequired
operatorstringRequired
replayedbooleanRequired
reviewedintegerRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close