Review every account for dormancy and list escheat candidates by state
POST
/accounts/dormancy-runsHeaders
Idempotency-KeystringOptionalSend 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_datestringOptionaloperatorstringRequiredReturns
200 OK
accountsarray of objectsRequired14 child attributes
abandonment_basisstringRequiredStatute, tables or default
abandonment_citationstringRequiredabandonment_yearsintegerRequiredaccount_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
balance_amountintegerRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
eligiblebooleanRequiredeligible_onstring · dateRequiredA business date, YYYY-MM-DD
inactive_monthsintegerRequiredlast_activity_datestring · dateRequiredA business date, YYYY-MM-DD
notice_sent_atstring · date or nullOptionalA business date, YYYY-MM-DD
notice_windowobjectRequiredDueDiligence is a state's due-diligence notice window before an escheat.
3 child attributes
citationstringRequiredmax_daysintegerRequiredmin_daysintegerRequiredstatestringRequiredstatusstringRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
escheat_candidatesintegerRequirednewly_dormantintegerRequiredoperatorstringRequiredreplayedbooleanRequiredreviewedintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503