Corgi BankDocumentation
OpenAPI

Record the due-diligence notice sent to a dormant account's owner

POST/accounts/{id}/escheat-notices

Path parameters

idstringRequired

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

sent_atstringOptional

Returns

200 OK

certificateobject or nullOptional

CertificateTerms are a certificate account's contract.

8 child attributes
at_maturitystringRequired

Rollover or pay_out

grace_daysintegerRequired
maturedbooleanRequired
maturity_datestring · dateRequired

A business date, YYYY-MM-DD

penalty_daysintegerRequired
renewalsintegerRequired
rollover_product_codestringOptional
term_monthsintegerRequired
closed_atstring · date-time or nullOptional
currency_codestringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

default_account_numberstringRequired
default_account_number_idstringRequired

Example acno_2tVh8nqLxq4GbDe0K1F6S9zRcWm

descriptionstringRequired
idstringRequired
interest_planbooleanRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

now_eligibility_idstringOptional
opened_atstring · date-timeRequired
ownersarray of stringsRequired
ownershipobjectRequired

Ownership is how an account is titled, apart from who its owners are.

11 child attributes
beneficiariesarray of objectsOptional
5 child attributes
customer_idstringOptional

The customer record carrying the beneficiary's TIN (required for utma and custodial)

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

date_of_birthstringOptional
namestringRequired
relationshipstringOptional
share_bpsintegerRequired
custodianstringOptional
decedentstringOptional
fiduciarystringOptional
firmstringOptional
ira_typestringOptional
survivorshipbooleanOptional
tax_reportingstringOptional

Derived: how the interest is reported

trust_namestringOptional
trusteesarray of stringsOptional
typestringRequired

Individual, joint, pod, trust, estate, utma, iolta, hsa, ira, custodial

ownership_recorded_atstring · date-time or nullOptional
ownership_revisionintegerOptional

Zero means unknown legacy chronology

product_codestringRequired
product_versionintegerRequired
routing_numberstringRequired
statement_cyclestringRequired
statusstringRequired
status_reasonstringOptional
typestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close