Corgi BankDocumentation
OpenAPI

Retrieve ICMM-style NVF notifications from the IDES simulator

POST/fatca-reports/{id}/notifications

Confidential Form 8966 API: dedicated compliance:fatca staff scope, verified staff identity and no API keys. The bank files as a U.S. withholding agent that is not an FFI (FATCA610) reporting substantial U.S. owners of a passive NFFE (FATCA102, W-8BEN-E chapter 4 status 24). Writes, approval and export require step-up within five minutes; the approver cannot be the preparer. XML and IDES packets are encrypted and excluded from ordinary audit exports. Deposit interest is not a chapter 4 withholdable payment; payment amounts on the prepare request are those the withholding agent names. CRS is disabled by default because the United States is not a CRS participating jurisdiction.

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.

Returns

200 OK

accountsarray of objectsRequired
6 child attributes
account_numberstringRequired
balance_minorintegerRequired
closedbooleanRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

interest_minorintegerOptional
paymentsarray of objectsOptional
3 child attributes
amount_minorintegerRequired
deposit_interestbooleanOptional
typestringRequired
corr_report_idstringOptional

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

doc_typestringRequired
idstringRequired
message_ref_idstringRequired
notification_cdstringOptional
packet_filenamestringOptional
proposed_bystringRequired
statusstringRequired
tax_yearintegerRequired
transmission_idstringOptional

Errors

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

400401403404409412413422424429500503

to move to open esc to close