API ReferenceFiles

Get Statements

Authentication

AuthorizationBearer

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

Query parameters

statement_typeenumRequired

Type of statement to retrieve. Account statements require account_id. Institution statements require institution_id.

account_idstring or nullOptional

Required for account-level statement types.

institution_idstring or nullOptionalformat: "uuid"

Required for institution-level statement types.

start_datestring or nullOptionalformat: "date"

Filter to include only statements after this date (inclusive).

end_datestring or nullOptionalformat: "date"

Filter to include only statements before this date (inclusive)

id_typeenum or nullOptional
Type of the account id. Must be 'institution' or 'None'.
Allowed values:

Response

Successful Response
statementslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error