Corgi BankDocumentation
OpenAPI

Page the frozen collection with reviewer decisions and production numbers

GET/bank-records/productions/{production}/items

Path parameters

productionstringRequired

Query parameters

afterstringOptional
purposestringOptional

Returns

200 OK

completebooleanRequired
itemsarray of objectsRequired
17 child attributes
account_idsarray of stringsRequired
attachmentsarray of objectsRequired
8 child attributes
attachmentstringRequired
bytesintegerRequired
encodingstringRequired
ingest_idstringOptional
partsintegerRequired
recorded_atstring · date-timeRequired
recorded_bystringRequired
sha256stringRequired
chain_sha256stringRequired
custodianstringRequired
customer_idsarray of stringsRequired
decisionobject or nullOptional
4 child attributes
actorstringRequired
basisstringRequired
decided_atstring · date-timeRequired
reasonstringRequired
document_sha256stringRequired
familyobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired
item_idstringRequired
kindstringRequired

Bank_record or retained_record

metadata_sha256stringRequired
ordinalintegerRequired
production_numberstringOptional
record_datestring · date-timeRequired
record_date_basisstringRequired
review_requiredarray of stringsRequired
source_keystringRequired
next_cursorintegerRequired
productionobjectRequired
16 child attributes
actorstringRequired
approved_bystringOptional
created_atstring · date-timeRequired
high_waterintegerOptional
holdsarray of objectsRequired
5 child attributes
bank_widebooleanOptional
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Bank_archive or customer_archive

targetobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired
idstringRequired
itemsintegerRequired
legal_request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

packageobject or nullOptional
7 child attributes
first_numberstringOptional
last_numberstringOptional
manifest_sha256stringRequired
package_sha256stringRequired
packaged_atstring · date-timeRequired
packaged_bystringRequired
partsintegerRequired
released_atstring · date-time or nullOptional
required_determinationsarray of stringsRequired
review_requiredintegerRequired
root_sha256stringOptional
scopeobjectRequired

LegalScope selects what a production collects. Every named dimension must match; within a dimension any listed value matches. Families name registered sources, RetainedRecords or ExternalDocuments; no families means every archive family, which the request must acknowledge with BankWide and its reason, because that places a bank-wide hold: every registered connector starts retaining superseded rows in its own database until the hold is released.

8 child attributes
account_idsarray of stringsRequired
bank_widebooleanOptional
bank_wide_reasonstringOptional
custodiansarray of stringsRequired
customer_idsarray of stringsRequired
familiesarray of objectsRequired
2 child attributes
servicestringRequired
sourcestringRequired
fromstring · date-time or nullOptional
throughstring · date-time or nullOptional
sequenceintegerRequired
statusstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close