Corgi BankDocumentation
OpenAPI

List an account's product notices

GET/accounts/{id}/product-notices

Path parameters

idstringRequired

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

pendingstringOptional

Returns

200 OK

dataarray of objectsRequired
9 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

actionsarray of objectsRequired
8 child attributes
actorstringRequired
channelstringOptional
consent_referencestringOptional
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

datestring · dateRequired

A business date, YYYY-MM-DD

kindstringRequired
recorded_atstring · date-timeRequired
referencestringRequired
created_atstring · date-timeRequired
documentobjectRequired
8 child attributes
bankobjectRequired
5 child attributes
addressstringRequired
error_noticestringRequired
localbooleanRequired
namestringRequired
phonestringRequired
changesarray of objectsRequired
3 child attributes
afterstringRequired
beforestringRequired
termstringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

explanationstringRequired
notice_daysintegerRequired
number_last4stringRequired
productstringRequired
recipientsarray of objectsRequired
3 child attributes
addressstringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

namestringRequired
from_versionintegerRequired
idstringRequired
requestobjectRequired
5 child attributes
actorstringOptional
effective_datestring · dateRequired

A business date, YYYY-MM-DD

explanationstringRequired
policy_referencestringRequired
versionintegerRequired
sha256stringRequired
statusstringRequired
has_morebooleanRequired

Whether another page follows

Errors

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

400401403404409412413422424429500503

to move to open esc to close