GET
/
statements
/
{statement_id}
Get a statement
curl --request GET \
  --url https://api.synctera.com/v1/statements/{statement_id} \
  --header 'Authorization: Bearer <token>'
{
  "saving_summary": {
    "apy": 550,
    "interest_earned": 150,
    "interest_earned_previous_month": 150,
    "interest_earned_previous_year": 10000,
    "interest_earned_ytd": 10000
  },
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "end_date": "2023-12-25",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issue_date": "2023-12-25",
  "start_date": "2023-12-25",
  "account_summary": {
    "account_number": "<string>",
    "account_status": "<string>",
    "account_type": "<string>",
    "balance_ceiling": {
      "balance": 123
    },
    "balance_floor": {
      "balance": 123
    },
    "creation_time": "2023-11-07T05:31:56Z",
    "currency": "USD",
    "customer_type": "<string>",
    "financial_institution": {
      "legal_address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "name": "<string>",
      "phone_number": "<string>"
    },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_updated_time": "2023-11-07T05:31:56Z",
    "nickname": "<string>"
  },
  "authorized_signers": [
    {
      "creation_time": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "relationship_type": "<string>"
    }
  ],
  "closing_balance": 123,
  "customer_service_details": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country_code": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "email": "<string>",
    "phone_number": "<string>"
  },
  "disclosure": "<string>",
  "exclude_jit_transactions": false,
  "include_child_transactions": false,
  "joint_account_holders": [
    {
      "creation_time": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "middle_name": "<string>",
      "relationship_type": "<string>"
    }
  ],
  "opening_balance": 123,
  "primary_account_holder_business": {
    "creation_time": "2023-11-07T05:31:56Z",
    "ein": "<string>",
    "email": "<string>",
    "entity_name": "<string>",
    "formation_date": "2023-12-25",
    "formation_state": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_updated_time": "2023-11-07T05:31:56Z",
    "phone_number": "<string>",
    "status": "<string>",
    "structure": "<string>",
    "trade_names": [
      "<string>"
    ],
    "verification_last_run": "2023-11-07T05:31:56Z",
    "verification_status": "<string>"
  },
  "primary_account_holder_personal": {
    "creation_time": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_name": "<string>",
    "last_updated_time": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "relationship_type": "<string>"
  },
  "statement_type": "CHARGE_SECURED",
  "total_transactions": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
statement_id
string<uuid>
required

The unique identifier of a statement

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

statement

A statement for a depository account

​
saving_summary
object
required

A summary of the accrued interest for the saving account in the current period

​
exclude_jit_transactions
boolean
default:false
required

Ignore "JIT funding" transactions when generating a statement

Example:

false

​
include_child_transactions
boolean
default:false
required

Include transactions from sub-accounts when generating a statement

Example:

false

​
statement_type
enum<string>
required

The type of statement

Available options:
CHARGE_SECURED,
CHARGE_UNSECURED,
DEPOSIT,
LINE_OF_CREDIT
​
account_id
string<uuid>

The unique identifier of the account the statement belongs to

​
end_date
string<date>

The date indicating the ending of the time interval covered by the statement

​
id
string<uuid>

statement ID

​
issue_date
string<date>

The date when the statement has been issued

​
start_date
string<date>

The date indicating the beginning of the time interval covered by the statement

​
account_summary
object
​
authorized_signers
Person · object[]
​
closing_balance
integer

The account balance at the end of the statement period, in ISO 4217 minor currency units.

​
customer_service_details
object

The customer service details of the fintech partner, e.g. phone number, email address, etc.

​
disclosure
string
​
joint_account_holders
Person · object[]
​
opening_balance
integer

The account balance at the start of the statement period, in ISO 4217 minor currency units.

​
primary_account_holder_business
object
​
primary_account_holder_personal
object
​
total_transactions
integer

The total number of transactions for this statement period.