Corgi BankDocumentation
OpenAPI

Independently decide archive policy, retention event, legal hold release or eligible payload disposition

POST/bank-records/controls/{control}/decisions

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

controlstringRequired

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

decisionstringRequired

Approve/reject

evidence_refstringRequired
evidence_sha256stringRequired
reasonstringRequired

Returns

200 OK

actorstringRequired
created_atstring · date-timeRequired
decided_atstring · date-time or nullOptional
decided_bystringOptional
idstringRequired
preservationarray of objectsRequired
6 child attributes
decisionstringRequired
last_attempt_atstring · date-time or nullOptional
receiptobject or nullOptional
5 child attributes
enforcementstringRequired
recorded_atstring · date-timeRequired
requestobjectRequired
8 child attributes
command_idstringRequired
decisionstringRequired
evidence_sha256stringRequired
matter_idstringRequired
on_behalf_ofstringRequired
purposestringRequired
sourcestringRequired
versionintegerRequired
request_sha256stringRequired
servicestringRequired
statusstringRequired
targetobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired
versionintegerRequired
requestobjectRequired
13 child attributes
bank_widebooleanRequired
categorystringOptional
event_atstring · date-time or nullOptional
evidence_refstringRequired
evidence_sha256stringRequired
expected_versionintegerOptional
hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
matter_refstringRequired
reasonstringRequired
record_idstringOptional
targetobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired
throughstring · date-time or nullOptional

Through bounds a dispose_versions control: the source removes its retained row versions superseded on or before this time, once the control is independently approved and no archive hold covers the source.

statusstringRequired
versionintegerRequired
version_dispositionobject or nullOptional

VersionDisposition is the source's receipt for an approved dispose_versions control; until it is recorded the approved control is still to be propagated.

5 child attributes
deletedintegerRequired
recorded_atstring · date-timeRequired
requestobjectRequired

VersionDispositionRequest is the hub's independently approved instruction to remove an inventory source's retained row versions superseded on or before Through. It applies only to a source under no acknowledged preservation; the archive keeps what it captured.

7 child attributes
command_idstringRequired
evidence_sha256stringRequired
matter_idstringRequired
on_behalf_ofstringRequired
purposestringRequired
sourcestringRequired
throughstring · date-timeRequired
request_sha256stringRequired
servicestringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close