Skip to content

Corgi BankDocumentation

OpenAPI

Read a correction proposal and review

GET/accounts/{id}/statements/{period}/corrections/{correction}

Path parameters

idstringRequired

periodstringRequired

correctionstringRequired

Returns

200 OK

candidateobjectRequired

9 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

documentobjectRequired

26 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

account_number_last4stringRequired

addressstringRequired

apy_earned_percentstringRequired

average_daily_balance_amountintegerRequired

bankobjectRequired

5 child attributes

addressstringRequired

error_noticestringRequired

localbooleanRequired

namestringRequired

phonestringRequired

closing_amountintegerRequired

correctionobject or nullOptional

3 child attributes

replaces_idstringRequired

replaces_issued_atstring · date-timeRequired

summarystringRequired

currency_codestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

customer_namestringRequired

daysintegerRequired

feesarray of objectsRequired

4 child attributes

amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

final_statementbooleanOptional

fromstring · dateRequired

A business date, YYYY-MM-DD

generated_atstring · date-timeRequired

interest_earned_amountintegerRequired

interest_paid_amountintegerRequired

linesarray of objectsRequired

8 child attributes

balance_amountintegerRequired

credit_amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

debit_amountintegerRequired

descriptionstringRequired

detailobject or nullOptional

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

opening_amountintegerRequired

periodstringRequired

period_feesobjectRequired

2 child attributes

overdraft_amountintegerRequired

returned_item_amountintegerRequired

productstringRequired

throughstring · dateRequired

A business date, YYYY-MM-DD

versionintegerRequired

year_feesobjectRequired

2 child attributes

overdraft_amountintegerRequired

returned_item_amountintegerRequired

idstringRequired

issued_atstring · date-timeRequired

issued_bystringRequired

periodstringRequired

previous_idstringOptional

revisionintegerRequired

sha256stringRequired

idstringRequired

proposed_atstring · date-timeRequired

proposed_bystringRequired

requestobjectRequired

3 child attributes

base_idstringRequired

customer_summarystringRequired

reasonstringRequired

reviewobject or nullOptional

4 child attributes

actorstringRequired

created_atstring · date-timeRequired

decisionstringRequired

reasonstringRequired

source_sha256stringRequired

Errors

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

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/accounts/{id}/statements/{period}/corrections/{correction}' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "candidate": {
    "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "document": {
      "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "account_number_last4": "string",
      "address": "string",
      "apy_earned_percent": "string",
      "average_daily_balance_amount": 10000,
      "bank": {
        "address": "string",
        "error_notice": "string",
        "local": false,
        "name": "string",
        "phone": "string"
      },
      "closing_amount": 10000,
      "correction": {
        "replaces_id": "string",
        "replaces_issued_at": "2026-09-17T14:30:00Z",
        "summary": "string"
      },
      "currency_code": "USD",
      "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "customer_name": "string",
      "days": 0,
      "fees": [
        {}
      ],
      "final_statement": false,
      "from": "2026-09-17",
      "generated_at": "2026-09-17T14:30:00Z",
      "interest_earned_amount": 10000,
      "interest_paid_amount": 10000,
      "lines": [
        {}
      ],
      "opening_amount": 10000,
      "period": "string",
      "period_fees": {
        "overdraft_amount": 10000,
        "returned_item_amount": 10000
      },
      "product": "string",
      "through": "2026-09-17",
      "version": 0,
      "year_fees": {
        "overdraft_amount": 10000,
        "returned_item_amount": 10000
      }
    },
    "id": "string",
    "issued_at": "2026-09-17T14:30:00Z",
    "issued_by": "string",
    "period": "string",
    "previous_id": "string",
    "revision": 0,
    "sha256": "string"
  },
  "id": "string",
  "proposed_at": "2026-09-17T14:30:00Z",
  "proposed_by": "string",
  "request": {
    "base_id": "string",
    "customer_summary": "string",
    "reason": "string"
  },
  "review": {
    "actor": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "decision": "string",
    "reason": "string"
  },
  "source_sha256": "string"
}