Instantor JSON reports consist of the account name, transaction list, account owner detail, and several other things.
The report is delivered in the JSON format, and it begins with the unique identifier of the report that we call InstantorRequestId. This ID is important and useful to report errors.
The below report is an example of the report configuration in Sweden and does not contain real data. The configuration of reports and available fields can be slightly different depending on the country.
What does each field mean?
- In general, StartTime when a session is initialised when a customer chooses a bank.
- FinishedTime is a timestamp when a report has been sent to a defined endpoint.
- ProcessStatus indicates the status of activity in iFrame, these states can be "ok", "processError", "invalidLogin", "abandoned" or "blocked".
- ReportNumber - information aggregated from the bank can be sent in batches, by default our solution is set to deliver one batch of reports, that includes all aggregated information from an end-user. For a set-up with multiple reports, which can be set-up through our customer support, Report number 0 indicates the first report and report number 1 indicates the second report.
- miscParams is entirely populated with information that you as our customer chooses to include when loading our iFrame. To differentiate end-users/requests using the iFrame, you can add as much end-user/request-specific information as you need. End-user/request information is stored as key-value pairs, and it is free-form, with some special keywords. When you use userParam to add end-user information, all the data will be returned in the report as "MISC" list (miscEntryList, miscParams...).
In this part, the report will focus on the account report field.
- Number is the full IBAN number of the account. One person usually has two accounts: private account and saving account. Meaning that there will be the second part later in the report.
- totalNumberOfTransactions is self-explanatory, the number of transactions that this account has for the period of 12 months.
- cashFlow contains 12 groups of data (for 12 months) and each group contains information as seen in the picture above.
This section will be the detail of the account owner. Many parts of this section are self-explanatory. The private mark on address, number, and email exist to let the credit company know that the information cannot be stored due to confidentiality.
This is the last section of the report, the transaction list.
- Number will be the account number. Like mentioned before, one person may have more than one account (in the same bank), so this part may repeat.
- transactionList contains list of the transactions since the data aggregation date, up to 12 months before. Since all the transactions will be listed in this section, this may cause the report to be sent to the client delayed, therefore, in case of a big amount of transactions, we break the report down into two or even three chunks.