Corgi BankDocumentation
OpenAPI

Propose a versioned bank-reviewed customer record retention schedule

POST/record-schedules

Dedicated customers:records:write staff authority and authentication within five minutes required. No production retention period is assumed. Provide bank-reviewed authority and evidence, category version, creation or evidenced_event trigger, future/effective date and days or permanent retention. Another staff member with customers:records:approve decides the schedule; stale versions cannot override an approved successor or change an existing category's trigger.

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

authority_refstringRequired
categorystringRequired
effective_atstring · date-timeRequired
evidence_refstringRequired
evidence_sha256stringRequired
expected_versionintegerRequired
permanentbooleanRequired
reasonstringRequired
retention_daysintegerRequired
triggerstringRequired

Creation or evidenced_event

Returns

200 OK

decided_atstring · date-time or nullOptional
decided_bystringOptional
idstringRequired
proposed_atstring · date-timeRequired
proposed_bystringRequired
requestobjectRequired
10 child attributes
authority_refstringRequired
categorystringRequired
effective_atstring · date-timeRequired
evidence_refstringRequired
evidence_sha256stringRequired
expected_versionintegerRequired
permanentbooleanRequired
reasonstringRequired
retention_daysintegerRequired
triggerstringRequired

Creation or evidenced_event

statusstringRequired
versionintegerRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close