Corgi BankDocumentation
OpenAPI

Independently decide a disposition; approval destroys only the encrypted documents and retains receipts

POST/bsa-filings/retention/{packet_id}/dispositions/{version}/reviews

Confidential five-year retention of filed reports and supporting documentation (31 CFR 1020.320(d), 1010.306(a)(2), 1010.430(d)), with dedicated compliance:filings staff authority and recent step-up for controls. Only an accepted production filing has a schedule, starting on the later of its authenticated transmission day and the batch's filing date; other packets are retained without disposition. A legal hold on named packets or every filing record applies immediately and ends only when a reviewer who neither placed it nor proposed the release approves. Disposition is refused under any active hold or on or before the last retained day; a different reviewer's approval destroys only the encrypted documents in one transaction and retains a receipt for each, leaving packet metadata, decisions, signed receipts and access history. These records are excluded from general audit export and the bank-records archive.

Path parameters

packet_idstringRequired
versionstringRequired

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.

Body parameters

approvebooleanRequired
content_sha256stringRequired

Returns

200 OK

active_holdsarray of integersRequired
as_ofstring · dateRequired

A business date, YYYY-MM-DD

content_sha256stringRequired
dispositionsarray of objectsRequired
12 child attributes
basisstringRequired
content_sha256stringRequired
evidence_referencestringRequired
evidence_sha256stringRequired
packet_content_sha256stringRequired
packet_idstringRequired
proposed_atstring · date-timeRequired
proposed_bystringRequired
retain_throughstring · dateRequired

A business date, YYYY-MM-DD

reviewobject or nullOptional

RetentionDispositionReview is the independent decision. An approval retains the verified accepted status the destroyed acknowledgment established.

5 child attributes
actorstringRequired
approvebooleanRequired
atstring · date-timeRequired
content_sha256stringRequired
packet_statusstringOptional
rules_idstringRequired
versionintegerRequired
environmentstringRequired
formstringRequired
packet_idstringRequired
receiptsarray of objectsRequired
7 child attributes
content_sha256stringRequired
disposition_versionintegerRequired
envelope_sha256stringRequired
key_idstringRequired
kindstringRequired
packet_idstringRequired
recorded_atstring · date-timeRequired
scheduleobject or nullOptional

RetentionSchedule exists only for an accepted production filing: drafts, cancelled, rejected, unreleased and test packets have none and are never disposed.

8 child attributes
created_atstring · date-timeRequired
filing_datestring · dateRequired

A business date, YYYY-MM-DD

formstringRequired
packet_idstringRequired
report_datestring · dateRequired

A business date, YYYY-MM-DD

retain_throughstring · dateRequired

A business date, YYYY-MM-DD

retention_startstring · dateRequired

A business date, YYYY-MM-DD

rules_idstringRequired
stagestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close