v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Connect

Get Statements

To retrieve PDF statements from a customer's financial institution, use the /GetStatements endpoint.

post/v3/{customerId}/BankingServices/GetStatements

Path parameters

customerIdstring required

Key that grants access to the environment.

Headers

x-api-keystring

Security feature that grants access to this endpoint.

Request body

RequestIdstring required

Unique identifier provided after a successful request to the /Authorize endpoint.

NumberOfStatements'MostRecent' | 'Months3' | 'Months12'

Number of PDF banking statements that are returned per customer account.

AccountsFilterstring[]

You can include the AccountsFilter parameter in the request body.

Example request

{
  "NumberOfStatements": "MostRecent"
}

Response

Success

HttpStatusCodeinteger
Institutionstring
RequestIdstring