API specification

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.

(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.

See the spesific error situations with http error codes and associated message codes (ACC-xxx)

Change log pilot project period