Get Account Documents Details

Use this API to retrieve the details of all documents linked to a specific savings account. This is typically used as the second step after generating an account statement to obtain the documentId needed to download the PDF.

Prerequisites

  • Pass the savingsAccountId as a path parameter.

Example Request

GET /v1/savingsaccounts/{savingsAccountId}/documents

Filtering Results

Use the following query parameters to narrow down the documents returned:

ParameterDescription
typeFilter by document type. Supported values: statement, receipt, report, passport.
nameFilter by document name (e.g., January 01st - July 17st).
createdAtFromReturn only documents created on or after this date. Format: yyyy-MM-dd HH:mm:ss.
createdAtToReturn only documents created on or before this date. Format: yyyy-MM-dd HH:mm:ss.

What's Next?

Once you have the documentId from the response, use it to download the document file (e.g., the statement PDF).

Path Params
integer
required
Defaults to 123

The Id associated with the account
Example: 123

Query Params
date-time

Filter documents created from this date.
Format: yyyy-MM-dd HH:mm:ss
Example: 2023-01-01 00:00:00

date-time

Filter documents created up to this date.
Format: yyyy-MM-dd HH:mm:ss
Example: 2023-12-31 23:59:00

string

Name of the document.
example: January 01st - July 17st

string
enum

Filter documents by type.
Example: statement

Allowed:
Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json