Corgi BankDocumentation
OpenAPI

Read a legal request and its productions with an audited purpose

GET/bank-records/legal-requests/{request}

Path parameters

requeststringRequired

Query parameters

purposestringOptional

Returns

200 OK

actorstringRequired
created_atstring · date-timeRequired
idstringRequired
productionsarray of objectsRequired
16 child attributes
actorstringRequired
approved_bystringOptional
created_atstring · date-timeRequired
high_waterintegerOptional
holdsarray of objectsRequired
5 child attributes
bank_widebooleanOptional
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Bank_archive or customer_archive

targetobjectRequired
2 child attributes
servicestringRequired
sourcestringRequired
idstringRequired
itemsintegerRequired
legal_request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

packageobject or nullOptional
7 child attributes
first_numberstringOptional
last_numberstringOptional
manifest_sha256stringRequired
package_sha256stringRequired
packaged_atstring · date-timeRequired
packaged_bystringRequired
partsintegerRequired
released_atstring · date-time or nullOptional
required_determinationsarray of stringsRequired
review_requiredintegerRequired
root_sha256stringOptional
scopeobjectRequired

LegalScope selects what a production collects. Every named dimension must match; within a dimension any listed value matches. Families name registered sources, RetainedRecords or ExternalDocuments; no families means every archive family, which the request must acknowledge with BankWide and its reason, because that places a bank-wide hold: every registered connector starts retaining superseded rows in its own database until the hold is released.

8 child attributes
account_idsarray of stringsRequired
bank_widebooleanOptional
bank_wide_reasonstringOptional
custodiansarray of stringsRequired
customer_idsarray of stringsRequired
familiesarray of objectsRequired
2 child attributes
servicestringRequired
sourcestringRequired
fromstring · date-time or nullOptional
throughstring · date-time or nullOptional
sequenceintegerRequired
statusstringRequired
requestobjectRequired
12 child attributes
basisobjectRequired

LegalBasis is the retained evidence of the process itself. The code decides no legal question: validity, privilege, confidentiality and Right to Financial Privacy Act determinations are the bank's, evidenced here.

4 child attributes
citationstringRequired
evidence_refstringRequired
evidence_sha256stringRequired
reasonstringRequired
counselstringRequired
issuing_authoritystringRequired
kindstringRequired

Subpoena, court_order or regulator_request

matter_refstringRequired
production_prefixstringRequired
purposestringRequired
received_atstring · date-timeRequired
requester_typestringRequired

Private_party, court, government_authority or bank_regulator

response_due_atstring · date-time or nullOptional
rfpaobject or nullOptional

RFPADetermination records the bank's determination for a government authority's request: the written certificate of compliance 12 U.S.C. 3403(b) requires before customer financial records are released, or the evidenced determination that the certificate does not apply.

4 child attributes
determinationstringRequired

Certificate_received or not_applicable

evidence_refstringRequired
evidence_sha256stringRequired
reasonstringRequired
scopeobjectRequired

LegalScope selects what a production collects. Every named dimension must match; within a dimension any listed value matches. Families name registered sources, RetainedRecords or ExternalDocuments; no families means every archive family, which the request must acknowledge with BankWide and its reason, because that places a bank-wide hold: every registered connector starts retaining superseded rows in its own database until the hold is released.

8 child attributes
account_idsarray of stringsRequired
bank_widebooleanOptional
bank_wide_reasonstringOptional
custodiansarray of stringsRequired
customer_idsarray of stringsRequired
familiesarray of objectsRequired
2 child attributes
servicestringRequired
sourcestringRequired
fromstring · date-time or nullOptional
throughstring · date-time or nullOptional

Errors

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

400401403404409412413422424429500503

to move to open esc to close