Corgi BankDocumentation
OpenAPI

Create a durable source-verified evidence ingestion under an independently reviewed source retention policy

POST/bank-records/ingests

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.

Headers

Idempotency-KeystringRequired

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

policy_idstringRequired
purposestringRequired

Returns

200 OK

actorstringRequired
attachments_failedintegerOptional
attachments_pendingintegerOptional
categorystringRequired
chain_sha256stringRequired
completebooleanRequired

Complete is true once every source page is archived and every attachment those pages declared is captured or recorded as a failure; SourceComplete covers the pages alone.

created_atstring · date-timeRequired
cursorintegerRequired
idstringRequired
requestobjectRequired
2 child attributes
policy_idstringRequired
purposestringRequired
snapshotobject or nullOptional
10 child attributes
databasestringRequired
descriptionobjectRequired
7 child attributes
capturestringOptional
coveragestringRequired
excludedarray of stringsRequired
projection_sha256stringRequired
servicestringRequired
sourcestringRequired
versionstringRequired
idstringRequired
mvcc_snapshotstringRequired
requestobjectRequired
4 child attributes
on_behalf_ofstringRequired
purposestringRequired
request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

sourcestringRequired
root_sha256stringRequired
rowsintegerRequired
schemastringRequired
shapeobject or nullOptional
6 child attributes
attachmentsarray of stringsRequired
columnsarray of objectsRequired
2 child attributes
namestringRequired
typestringRequired
excludedarray of stringsRequired
keyarray of stringsRequired
redactedarray of stringsRequired
sha256stringRequired
taken_atstring · date-timeRequired
source_completebooleanOptional
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