API Documentation

Introduction

This document explains how to integrate with Nordigen API to process and analyse account information. Nordigen API is a set of endpoints that allows you to integrate our Transaction Categorisation and Insights solutions with your system. All responses will be shown in JSON format. All endpoints require the Authorization token.
Before you start, make sure you have acquired an API Client ID and Client Secret from the Nordigen Api Dashboard. If you are not a Dashboard user, please contact our support team.
To jump start your integration, head straight to the Quickstart Guide.
More information on Nordigen products can be also found in our knowledge base.

Glossary

  • Operations: an analysis product to be applied on a processing record;
  • Operation keyword: a keyword that needs to be passed when requesting to apply product(s) to a processing record;
  • Request ID: identification for a processing record;
  • Processing record: uploaded statement(s) in either uploaded, processing, or finished state, identified by its request_id;
  • Category tree: a data structure for holding categories, identified by ID, containing relationship between parent and child categories;
  • Optionality: for each key, it is stated whether this key is optional or not. In this context, optional stands for the possibility to return a null value.

Authentication

Nordigen API uses token-based authentication. You'll need the client_id and client_secret assigned to your organisation. These credentials can be found in the Nordigen API Dashboard. To get the token, send the request to https://api.nordigen.com/oauth/token with POST HTTP request body:

KEYVALUEOPTIONAL
client_idYour client ID
client_secretYour client secret
audiencehttps://nordigen/api
grant_typeclient_credentials

Versioning

We periodically release new versions. Current version is v2. You can provide specific version in the request URL; e.g. https://api.nordigen.com/v2/report/process/:request-id.


Error Handling

All error HTTP codes are going to be 4xx or 5xx, so we recommend using success http codes for the control flow and the error codes for informative purposes. If an error has occurred, it will be displayed in the following form:

Possible error codes

Error codeDescriptionHTTP status
API_REQUIRED_PARAMS_MISSINGOne or more params required missing, check source for which elements need to be filled400
TIMEOUT_PROCESSINGProcessing timed out400
ANALYSIS_ALREADY_REQUESTEDAnalysis operations were already requested for this record400
PDF_PARSE_FAILUREUnsupported pdf file was uploaded400
RATE_LIMITToo many requests in a short period of time429
EXCEEDED_LIMITProcessing record limit has been exceeded400
NO_SUITABLE_PARSERSUnsupported file was uploaded but with valid file format400
UNKNOWN_ERRORUnexpected error occurred whilst processing the file500
NOT_FOUNDCould not find specified request_id in database404
GONEStored file associated with the request_id can not be fetched410
UNSUPPORTED_COUNTRY_REQUESTEDGiven country code not in supported country list, see Supported File Formats400
SERVICE_UNAVAILABLEDowntime/misconfiguration on Nordigen part503
FORBIDDENNo access for the resource403
FEATURE_EXTRACT_FAILUREFailed process feature extraction, most likely because of the lack of data400
CREDIT_SCORING_FAILUREFailed process credit scoring calculation, most likely because of the lack of data400

Webhooks

Set up webhooks to send a request with the status of the processing record to your server once analysing account information is finished.

Setup

To set up webhooks see Webhooks under Endpoints section. To apply the webhook, pass "use_webhook": true when requesting which operations to use.

Webhook request body

To the specified URL POST, the request will be sent with body as follows:

Authentication

We support OAuth 2.0 and Basic Auth flows. If Oauth 2.0 is set, a token POST request will be sent with body as follows:

The expected response:

If a webhook request responds with 401, a new token will be requested once.

Retries

For HTTP codes 413, 429, 500, 502, 503, 504 the webhook request will be retried up to 10 times with exponential backoff of 0.5 * (2^n-1), where n is a retry count.


Supported File Formats

The system accepts account information in the following file formats: JSON (most popular), XML and PDF (see the list below for more details). Image files (including scanned bank statements, etc.) are not supported at this time.
Our products currently support 19 markets (see the list below for more details). If our products do not support a country of your interest, please contact us.
Only UTF-8 character encoding supported. Characters not fitting the standard will be replaced as unrepresentable.

Default JSON Input File Structure

When uploading account information to Nordigen API, always make sure that your files have the correct data structure. Please note that some keys in the input files are optional; namely, the key value can be empty. You can download a sample of our default JSON input file here.

KEYDESCRIPTIONOPTIONAL
account_nrIBANYes
holder_nameName of the account holderYes
bank_nameName of the bank the account belongs toYes
currencyA string of currency objectsYes
start_balanceAccount balance at the beginningYes
end_balanceAccount balance after all the transactionsYes
debit_turnoverThe amount of money gained since the first transaction until the last oneYes
credit_turnoverThe amount of money spent since the first transaction until the last oneYes
period_startDate of the first transactionYes
period_endDate of the last transactionYes
transaction_listA list of transaction objects
dateTransaction's date field
partnerTransaction's counterparty name field (e.g. the company's name where you made the purchase from)
infoTransaction's description field
transaction_idTransaction's IDYes
sumThe amount of money earned/spent

Bank Statements from Third Parties

Nordigen supports the default account information outputs from a list of major open banking providers. If you use a third party open banking provider to access bank account information, please see the list of supported file formats below. In case you cannot find your file format among the supported formats, please transform your data to the default JSON input file format.

CountryFormatProvider
*asice*
*bdoc*
*jsonNordigen, Kevin
AUjsonCredit Sense, Proviso
AUxmlYodlee
CZxmlKontomatik
DEjsonArvato, FintecSystems
DKxmlInstantor
EExmlKontomatik
EEpdfCoop Pank, Danske, LHV, Luminor, Nordea, SEB, Swedbank
ESjsonInstantor
ESxmlInstantor, Kontomatik
FIjsonInstantor, Tink
FIxmlInstantor
FIpdfAktia, Danske, Nordea, Pohjola
GBjsonTink
IDjsonInstantor
LTpdfDNB, Luminor, SEB, Swedbank
LVjsonInstantor
LVxmlKontomatik
LVpdfCitadele, DNB, Luminor, Nordea, Norvik, PNB, PrivatBank, SEB, Swedbank, VSAA
NZjsonProviso
PLxmlKontomatik
SEjsonInstantor, Tink
SExmlInstantor

Coverage and Country Codes

Nordigen system is now calibrated for 19 countries in total. Below you can see the list of these countries and their respective country codes. Please note that whenever you are using Nordigen products via API, the country code must be passed in lower case.

  • Latvia: lv
  • Estonia: ee
  • Lithuania: lt
  • Poland: pl
  • Czech Republic: cz
  • Finland: fi
  • Sweden: se
  • Denmark: dk
  • Spain: es
  • Germany: de
  • Brazil: br
  • Australia: au
  • New Zealand: nz
  • Indonesia: id
  • United States of America: us
  • United Kingdom: uk
  • India: in
  • Mexico: mx
  • Kazakhstan: kz