Freeze the production's archive collection with exact hashes, BSA indicator flags and automatic BSA-confidential exclusions
/bank-records/productions/{production}/collectionReviewed legal production under the dedicated records:bank staff authority with step-up within five minutes; records:bank:approve decides a package and records determinations, and a decision or determination refuses everyone who shaped the production: its legal request's opener, maker, collector, item reviewers, review completer and packager. Intake retains the process, its legal basis evidence and, for a government authority or bank regulator, the bank's Right to Financial Privacy Act determination (12 U.S.C. 3403(b)); it places automatic archive holds that cannot be released while the production is open, and a scope naming no family must acknowledge the bank-wide hold it places. Collection freezes exact hashes; BSA-confidential families and documents in scope are excluded automatically and logged internally only, and a SAR or material revealing one is never produced, numbered, manifested or privilege-logged (31 CFR 1020.320(e)). Every collected item takes one reviewer decision before review closes (text matching a SAR indicator, unscanned binary content and incomplete captures are flagged and decided individually; a page of at most 200 unflagged items may be cleared in one decision); nothing is produced by default. Release needs the independent approval, the recorded notices (FinCEN under 31 CFR 1020.320(e)(1)(i) and the OCC Litigation Division under 12 CFR 21.11(k)(1)(i)(A) for any BSA withholding; the OCC Litigation Division under 12 CFR 4.37(b)(3)(i) when non-public OCC information was withheld), the counsel named at intake, and returns the package key to the releasing staff member; nothing is transmitted.
Path parameters
productionstringRequiredHeaders
Idempotency-KeystringOptionalSend 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
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