Corgi BankDocumentation
OpenAPI

Read integrity-verified encrypted archive content with fresh dedicated authority and audited purpose

GET/bank-records/records/{record}

Path parameters

recordstringRequired

Query parameters

purposestringOptional

Returns

200 OK

documentobjectRequired
recordobjectRequired
28 child attributes
active_holdsarray of stringsRequired
attachment_failuresarray of objectsOptional
6 child attributes
attachmentstringRequired
codestringRequired
ingest_idstringRequired
reasonstringRequired
recorded_atstring · date-timeRequired
recorded_bystringRequired
attachmentsarray of objectsOptional
4 child attributes
bytesintegerRequired
columnstringRequired
encodingstringRequired
sha256stringRequired
captured_atstring · date-timeRequired
captured_attachmentsarray of objectsOptional
8 child attributes
attachmentstringRequired
bytesintegerRequired
encodingstringRequired
ingest_idstringOptional
partsintegerRequired
recorded_atstring · date-timeRequired
recorded_bystringRequired
sha256stringRequired
categorystringRequired
created_atstring · date-timeRequired
creation_basisstringRequired
disposed_atstring · date-time or nullOptional
document_bytesintegerRequired
document_sha256stringRequired
externalobject or nullOptional

ExternalDocument is the archived metadata of a completed external document.

19 child attributes
account_idsarray of stringsRequired
bsa_confidentialbooleanRequired

BSAConfidential marks a SAR, or material that would reveal one; a production never collects it (31 CFR 1020.320(e)).

bytesintegerRequired
categorystringRequired
content_typestringRequired
custodianstringRequired
customer_idsarray of stringsRequired
document_datestring · date-timeRequired
emailobject or nullOptional

EmailMetadata 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 stringsOptional
fromstringRequired
message_idstringRequired
sent_atstring · date-timeRequired
subjectstringRequired
toarray of stringsRequired
evidence_refstringRequired
evidence_sha256stringRequired
filenamestringRequired
kindstringRequired

Document or email

partsintegerRequired
reasonstringRequired
sha256stringRequired
source_refstringRequired
source_systemstringRequired
titlestringRequired
generationintegerRequired
idstringRequired
ingest_idstringRequired
permanentbooleanRequired
projection_sha256stringRequired
projection_versionstringRequired
provenanceobjectRequired
6 child attributes
account_idsarray of stringsRequired
customer_idsarray of stringsRequired
joinsarray of objectsRequired
3 child attributes
keystringRequired
relationshipstringRequired
tablestringRequired
ledger_account_idsarray of stringsRequired
native_timeobject or nullOptional

NativeTime 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-timeRequired
columnstringRequired
source_recorded_atstring · date-time or nullOptional
provenance_sha256stringRequired
recorded_bystringRequired
retain_untilstring · date-time or nullOptional
retention_event_idstringOptional
retention_starts_atstring · date-time or nullOptional
schedule_idstringRequired
sequenceintegerRequired
source_keystringRequired
targetobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close