Corgi BankDocumentation
OpenAPI

Read complete ingestion custody, source snapshot, verified cursor and completion state

GET/bank-records/ingests/{ingest}

Path parameters

ingeststringRequired

Query parameters

purposestringOptional

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