Corgi BankDocumentation
OpenAPI

Read complete ordinal discovery pages with captured metadata, current preservation/disposition and immutable access evidence

POST/bank-records/discoveries/{discovery}/pages

Dedicated 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

discoverystringRequired

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

afterintegerRequired
purposestringRequired

Returns

200 OK

afterintegerRequired
before_sha256stringRequired
completebooleanRequired
discoveryobjectRequired
8 child attributes
actorstringRequired
created_atstring · date-timeRequired
high_waterintegerRequired
idstringRequired
requestobjectRequired
8 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_fromstring · date-time or nullOptional
created_throughstring · date-time or nullOptional
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

purposestringRequired
servicestringOptional
sourcestringOptional
request_sha256stringRequired
root_sha256stringRequired
rowsintegerRequired
itemsarray of objectsRequired
6 child attributes
captured_metadata_sha256stringRequired
chain_sha256stringRequired
current_active_holdsarray of stringsRequired
current_disposed_atstring · date-time or nullOptional
ordinalintegerRequired
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.

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
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.

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
next_cursorintegerRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close