The API-specification in Swagger is the technical specification to follow when implementing the API’s in Control Information. As an addition to the technical specification it is created a description of the output parameters, for each API. The full description of the output parameters for the current version is to be found on: data model.
Each of the API’s consist of several fields and subfields. All fields are to be provided, delivered and formatted according to the API-spesification and the description of the field, unless otherwise stated.
|Version 1.0||Original version when financial institutions joined the pilot||API-specification V.1.0|
|Version 1.1||Current version for all financial institutions||API-specification V.1.1|
|Version 1.2||Working document for new version - for pilot banks||API-specification V.1.2|
(For Konkursbehandling: Brønnøysundregistrene shall only have access to these API’s: accounts, account details, transactions)
Error codes with associated error situations
There are several reasons which can cause errors in the API’s, some of them are:
- Security errors related to access to the API’s.
- Incorrect input parameters either query, header or path parameters
- Invalid combinations of input parameters
- Errors on the Data Providers’ side when they are not able to respond or return data.
The link below describes some of these specific error situations that the Data Consumers may encounter, with http error codes and associated message codes (ACC-xxx) to be returned by the Data Providers. They must be returned in a consistent manner. The intention is to ensure that Data Consumers get harmonized API behaviour across all API providers. The Data Providers will strive to follow the specification as far as possible, and return descriptive messages so that the Data Consumers understand error situations as best as possible.
Change log pilot project period
|Date||Version||Change||Link in document|
|11.02.21||V.1.2.0||For the pilot banks, added working document of the next API-version in the table.||Link to the working document for next API-version - for pilot banks|
|27.11.20||V.1.1.1||Change in all API error descriptions so that API providers understand what to return in different error situations. Fixed misspelling from RithtToSeeOnly to RightToSeeOnly.||Link to API-spesification and Link to Error codes with associated error situations|
|17.09.20||V.1.1.0||Changes from V.1.0 to V.1.1||Link til change log data model|