Endpoints

Parameters and Responses

auth

Get the auth token

POST https://api.nordigen.com/oauth/token
REQUEST BODY SCHEMA: application/json
Parameters:

  • audience: string
  • client_id: string
  • client_secret: string
  • grant_type: string

Response Example

All endpoints use token from this response as Oauth 2 bearer token.


{
"audience": "https://nordigen/api",
"client_id": "YOUR_ID",
"client_secret": "YOUR_SECRET",
"grant_type": "client_credentials"
}

HTTP code 200

report

Upload one or multiple accounts

POST https://api.nordigen.com/v2/report
REQUEST BODY SCHEMA: multipart/form-data
Parameters:

  • input: array of strings (Account data file, can be multiple files)

Response Example


{
  "data": {
    "attributes": {
      "available-operations": [
        "categorisation"
      ],
      "request-id": "162d7bb2-855c-477d-ad39-fd43fec5c44a",
      "status": "completed"
    },
    "relationships": {
      "operations": {
        "links": {
          "related": "https://api.nordigen.com/v2/report/process/162d7bb2-855c-477d-ad39-fd43fec5c44a",
          "self": "https://api.nordigen.com/v2/report"
        }
      }
    },
    "type": "report pre-processing record"
  }
}

HTTP code 200

Apply operations to uploaded account data

PUT https://api.nordigen.com/v2/report/process/{request-id} Request samples
REQUEST BODY SCHEMA: application/json
Parameters:

  • request_id: any (as path parameter, Request ID you get in response after uploading account data);
  • country: string (Any of supported countries);
  • operations: array of strings (Any of available operations you got in response after uploading account data);
  • params: object (Optional argument that allows configuration for products, details will be specified under the respective product documentation);
  • use_webhook: boolean (Should webhook be sent after finishing processing)

Response


{
  "data": {
    "attributes": {
      "request-id": "162d7bb2-855c-477d-ad39-fd43fec5c44a",
      "status": "queued"
    },
    "relationships": {
      "result": {
        "links": {
          "related": "https://api.nordigen.com/v2/report/162d7bb2-855c-477d-ad39-fd43fec5c44a",
          "self": "https://api.nordigen.com/v2/report/process/162d7bb2-855c-477d-ad39-fd43fec5c44a"
        }
      }
    },
    "type": "report processing record"
  }
}

HTTP code 202

Get the status of the task (if status is completed, the result of processing is also returned)

GET https://api.nordigen.com/v2/report/{request-id}
Parameters:

  • request_id: any (Request ID you get in response after uploading account data);

Response


{
  "data": {
    "attributes": {
      "request-id": "162d7bb2-855c-477d-ad39-fd43fec5c44a",
      "status": "processing"
    },
    "type": "report processing result"
  }
}

HTTP code 200

Get scoring models available for your company

GET https://api.nordigen.com/v2/available-models

Response Example


{
  "data": {
    "attributes": {
      "available-models": [
        "some_model_1.model",
        "some_model_2.model"
      ]
    },
    "type": "models list"
  }
}

HTTP code 200

categories

Retrieve the latest category tree

GET https://api.nordigen.com/v2/category-tree/{country}
Parameters:

  • country: string (Two letter country code filter for categories)

Response


{
  "data": [
    {
      "attributes": {
        "categories": [
          {
            "id": 1,
            "level": 0,
            "parent_id": 93,
            "readable-title": "Food",
            "type": "expense"
          }
        ]
      },
      "type": "category tree"
    }
  ]
}

HTTP code 200

webhooks

Set up webhooks (processing happens asynchronously)

POST https://api.nordigen.com/v2/webhook-settings
REQUEST BODY SCHEMA: application/json
Parameters:

  • auth_method: string (Authentication Method to use for webhook, possible options are OAuth2 and Basic Auth);
  • auth_password: string (Used for Basic Auth as password);
  • auth_username: string (Used for Basic Auth as username);
  • callback_url: string (URL to which POST webhook request will be sent);
  • oauth_audience: string (Used for Oauth2 as audience when fetching token);
  • oauth_client_audience: string (Used for Oauth2 as scope when fetching token);
  • oauth_client_id: string (Used for Oauth2 as client id when fetching token);
  • oauth_client_secret: string (Used for Oauth2 as client secret when fetching token);
  • oauth_token_url: string (Used for Oauth2 as location from which to fetch token)

Response


{
  "data": {
    "attributes": {
      "success": true
    },
    "type": "report processing record"
  }
}

HTTP code 202
Jump to