Retain one exact 512 KiB encrypted part of an open external document ingest
/bank-records/documents/{document}/partsDedicated records:bank staff authority and step-up within five minutes required; customers, services, API keys and third parties refuse. Source retention mappings, release, retention events, disposition and dispose_versions (removal of an unheld inventory source's retained row versions superseded through a nonfuture time, carried to the source by the repair route and worker only while no hub hold covers that source) need independent approval. Holds take effect immediately for existing/future archived facts and stay pending at each source until actual acknowledgment. An attachment the source or hub verification refuses for good, or that staff declare unretrievable after exhausted transport fetches, is recorded as a capture failure rather than blocking the ingest. Ingestion uses dedicated service connections and retained exact source snapshots/pages; users cannot upload or assert source contents. Discovery freezes complete membership and hashes with the requesting staff subject/purpose; every read is audited before release. Full external referenced documents remain outside explicit metadata projection coverage.
Path parameters
documentstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
contentstring · byteRequiredBase64 in JSON; exactly PartBytes except the last part
partintegerRequiredsha256stringRequiredReturns
200 OK
actorstringRequiredcreated_atstring · date-timeRequiredpartsintegerRequiredreceived_partsintegerRequiredrecordobject or nullOptional28 child attributes
active_holdsarray of stringsRequiredattachment_failuresarray of objectsOptional6 child attributes
attachmentstringRequiredcodestringRequiredingest_idstringRequiredreasonstringRequiredrecorded_atstring · date-timeRequiredrecorded_bystringRequiredattachmentsarray of objectsOptional4 child attributes
bytesintegerRequiredcolumnstringRequiredencodingstringRequiredsha256stringRequiredcaptured_atstring · date-timeRequiredcaptured_attachmentsarray of objectsOptional8 child attributes
attachmentstringRequiredbytesintegerRequiredencodingstringRequiredingest_idstringOptionalpartsintegerRequiredrecorded_atstring · date-timeRequiredrecorded_bystringRequiredsha256stringRequiredcategorystringRequiredcreated_atstring · date-timeRequiredcreation_basisstringRequireddisposed_atstring · date-time or nullOptionaldocument_bytesintegerRequireddocument_sha256stringRequiredexternalobject or nullOptionalExternalDocument is the archived metadata of a completed external document.
19 child attributes
account_idsarray of stringsRequiredbsa_confidentialbooleanRequiredBSAConfidential marks a SAR, or material that would reveal one; a production never collects it (31 CFR 1020.320(e)).
bytesintegerRequiredcategorystringRequiredcontent_typestringRequiredcustodianstringRequiredcustomer_idsarray of stringsRequireddocument_datestring · date-timeRequiredemailobject or nullOptionalEmailMetadata describes an email ingested as a complete message/rfc822 document. Mailbox and journaling connectors are vendor systems outside this archive; the bank exports the message.
6 child attributes
ccarray of stringsOptionalfromstringRequiredmessage_idstringRequiredsent_atstring · date-timeRequiredsubjectstringRequiredtoarray of stringsRequiredevidence_refstringRequiredevidence_sha256stringRequiredfilenamestringRequiredkindstringRequiredDocument or email
partsintegerRequiredreasonstringRequiredsha256stringRequiredsource_refstringRequiredsource_systemstringRequiredtitlestringRequiredgenerationintegerRequiredidstringRequiredingest_idstringRequiredpermanentbooleanRequiredprojection_sha256stringRequiredprojection_versionstringRequiredprovenanceobjectRequired6 child attributes
account_idsarray of stringsRequiredcustomer_idsarray of stringsRequiredjoinsarray of objectsRequired3 child attributes
keystringRequiredrelationshipstringRequiredtablestringRequiredledger_account_idsarray of stringsRequirednative_timeobject or nullOptionalNativeTime is the row's own timestamp column an inventory connector observed. It dates the row for discovery and production scope; it is not a retention trigger, because a mutable row's current version can be younger than its creation column.
2 child attributes
atstring · date-timeRequiredcolumnstringRequiredsource_recorded_atstring · date-time or nullOptionalprovenance_sha256stringRequiredrecorded_bystringRequiredretain_untilstring · date-time or nullOptionalretention_event_idstringOptionalretention_starts_atstring · date-time or nullOptionalschedule_idstringRequiredsequenceintegerRequiredsource_keystringRequiredtargetobjectRequired2 child attributes
servicestringRequiredsourcestringRequiredrecord_idstringRequiredrequestobjectRequiredDocumentRequest opens the evidenced ingest of one full external document. Its bytes follow in PartBytes parts and must reproduce SHA256 and Bytes exactly before the document is archived.
18 child attributes
account_idsarray of stringsRequiredbsa_confidentialbooleanRequiredBSAConfidential marks a SAR, or material that would reveal one; a production never collects it (31 CFR 1020.320(e)).
bytesintegerRequiredcategorystringRequiredcontent_typestringRequiredcustodianstringRequiredcustomer_idsarray of stringsRequireddocument_datestring · date-timeRequiredemailobject or nullOptionalEmailMetadata describes an email ingested as a complete message/rfc822 document. Mailbox and journaling connectors are vendor systems outside this archive; the bank exports the message.
6 child attributes
ccarray of stringsOptionalfromstringRequiredmessage_idstringRequiredsent_atstring · date-timeRequiredsubjectstringRequiredtoarray of stringsRequiredevidence_refstringRequiredevidence_sha256stringRequiredfilenamestringRequiredkindstringRequiredDocument or email
reasonstringRequiredsha256stringRequiredsource_refstringRequiredsource_systemstringRequiredtitlestringRequiredstatusstringRequiredOpen, completed or cancelled
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503