Read the sealed manifest and, after independent approval, page the encrypted package parts
/bank-records/productions/{production}/packagePath parameters
productionstringRequiredQuery parameters
afterstringOptionalpurposestringOptionalReturns
200 OK
completebooleanRequiredmanifestobjectRequiredManifest is the package's own description. It names only produced items and privilege-log entries: material withheld for BSA confidentiality appears nowhere in it.
13 child attributes
component_formatobjectRequiredcounselstringRequiredcreated_atstring · date-timeRequiredcustody_logarray of objectsRequired6 child attributes
actorstringRequiredatstring · date-timeRequiredchain_sha256stringRequireddetailstringRequiredeventstringRequiredsequenceintegerRequiredencryptionstringRequiredformatstringRequiredlegal_request_idstringRequiredExample req_2tVh8nqLxq4GbDe0K1F6S9zRcWm
matter_refstringRequiredpackage_root_sha256stringRequiredprivilege_logarray of objectsRequired5 child attributes
basisstringRequiredcustodianstringRequiredentryintegerRequiredfamilyobjectRequired2 child attributes
servicestringRequiredsourcestringRequiredreasonstringRequiredproducedarray of objectsRequired7 child attributes
componentsarray of objectsRequired4 child attributes
bytesintegerRequirednamestringRequiredpartsintegerRequiredsha256stringRequiredcustodianstringRequiredfamilyobjectRequired2 child attributes
servicestringRequiredsourcestringRequiredproduction_numberstringRequiredrecord_datestring · date-timeRequiredrecord_date_basisstringRequiredsource_keystringRequiredproduction_idstringRequiredsequenceintegerRequirednext_cursorintegerRequiredpartsarray of objectsRequired9 child attributes
bytesintegerRequiredchain_sha256stringRequiredciphertextstringRequiredciphertext_sha256stringRequiredcomponentstringRequiredpartintegerRequiredplain_sha256stringRequiredproduction_numberstringRequiredsequenceintegerRequiredproductionobjectRequired16 child attributes
actorstringRequiredapproved_bystringOptionalcreated_atstring · date-timeRequiredhigh_waterintegerOptionalholdsarray of objectsRequired5 child attributes
bank_widebooleanOptionalcustomer_idstringOptionalExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
hold_idstringRequiredExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredBank_archive or customer_archive
targetobjectRequired2 child attributes
servicestringRequiredsourcestringRequiredidstringRequireditemsintegerRequiredlegal_request_idstringRequiredExample req_2tVh8nqLxq4GbDe0K1F6S9zRcWm
packageobject or nullOptional7 child attributes
first_numberstringOptionallast_numberstringOptionalmanifest_sha256stringRequiredpackage_sha256stringRequiredpackaged_atstring · date-timeRequiredpackaged_bystringRequiredpartsintegerRequiredreleased_atstring · date-time or nullOptionalrequired_determinationsarray of stringsRequiredreview_requiredintegerRequiredroot_sha256stringOptionalscopeobjectRequiredLegalScope 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 stringsRequiredbank_widebooleanOptionalbank_wide_reasonstringOptionalcustodiansarray of stringsRequiredcustomer_idsarray of stringsRequiredfamiliesarray of objectsRequired2 child attributes
servicestringRequiredsourcestringRequiredfromstring · date-time or nullOptionalthroughstring · date-time or nullOptionalsequenceintegerRequiredstatusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503