Skip to main content
API docs by Redocly

LinX API (Deprecated) (v1)

LinX

/api/linx/convert

The Convert service provides normalized transaction data with optional categorization.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeRecurrence
boolean
Example: false

Enable recurrent transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "format": "string",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "accounts": [
    ],
  • "businesses": [
    ],
  • "groups": [
    ],
  • "categories": [
    ],
  • "naces": [
    ],
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a"
}

/api/linx/indicator/ilt

The Consumer Indicator service returns an analysis divided in multiple indicators. Each indicator contains a statistical analysis performed on a specific subset of transactions.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeRecurrence
boolean
Example: false

Enable recurrent transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

ReportingPeriod
string <json>
Example: {"PeriodUnit": "month","FullPeriodsOnly": true}

Configure periods for indicators

DateRange
string <json>
Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Configure range of transactions to select for indicators

Responses

Response samples

Content type
application/json
{
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
  • "profile": {
    },
  • "indicators": [
    ]
}

/api/linx/indicator/consumer

The Consumer Indicator service returns an analysis divided in multiple indicators. Each indicator contains a statistical analysis performed on a specific subset of transactions.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeRecurrence
boolean
Example: false

Enable recurrent transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

ReportingPeriod
string <json>
Example: {"PeriodUnit": "month","FullPeriodsOnly": true}

Configure periods for indicators

DateRange
string <json>
Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Configure range of transactions to select for indicators

Responses

Response samples

Content type
application/json
{
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
  • "profile": {
    },
  • "indicators": [
    ]
}

/api/linx/indicator/business

The Business Indicator service returns an analysis divided in multiple indicators based on B2B categorization. Each indicator contains a statistical analysis performed on a specific subset of transactions.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeRecurrence
boolean
Example: false

Enable recurrent transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

ReportingPeriod
string <json>
Example: {"PeriodUnit": "month","FullPeriodsOnly": true}

Configure periods for indicators

DateRange
string <json>
Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Configure range of transactions to select for indicators

Responses

Response samples

Content type
application/json
{
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
  • "profile": {
    },
  • "indicators": [
    ]
}

/api/linx/pivot

The Pivot service aggregates and analyzes a household's (or client's) bank transactions across multiple accounts, potentially from different banks.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

File to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "unit": "0 = None",
  • "groups": [
    ]
}

/api/linx/pivotgroup

The PivotGroup service is designed to aggregate and analyze bank transactions from multiple accounts, possibly across several banks, into a unified dataset.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

File to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "unit": "0 = None",
  • "groups": [
    ]
}

/api/linx/aggregate

The Aggregate service aggregates bank transaction data for a household or client, combining it with the household's profile.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

SchemaId
integer
Example: 0

Select a specific aggregate schema to use. If not given it will use the default

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "aggregated": {
    },
  • "profile": {
    }
}

/api/linx/profile

The Profile service is designed to extract detailed household information from bank transaction data, enabling the generation of a profile for calculating Nibud reference numbers.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

SchemaId
integer
Example: 0

Select a specific aggregate schema to use. If not given it will use the default

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "besteedbaarInkomen": 0.1,
  • "hoofdpersonen": [
    ],
  • "huisgenoten": [
    ],
  • "kinderen": [
    ],
  • "autos": [
    ],
  • "woning": {
    },
  • "incomes": [
    ]
}

/api/linx/budget

The Budget service calculates the monthly spending capacity of a household across various categories based on the household's aggregated financial data and profile.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "nodes": [
    ],
  • "transactions": 0,
  • "categorized": 0,
  • "amount": 0.1,
  • "debit": 0.1,
  • "credit": 0.1,
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "imported": true
}

/api/linx/periodical_expenses

The Periodical Expenses service is a Legacy service that predicts recurring expenses, identifying fixed, frequent costs across multiple categories.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/periodical_income

The Periodical Income service is a Legacy service that predicts fixed and regular income sources. It identifies recurring income transactions.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

ConsentCollectionId
string <uuid>
Example: d2c95f1b-6802-459e-ba7d-70491ac27d24

Provide either a FileBody or a ConsentCollectionId

Accounts
string
Example: [{"iban":"NL69INGB0123456789","dateFrom":"2024-05-05T00:00:00+02:00"},{"iban":"NL00RABO0123456789"}]

Specifies the bank accounts and data range to be downloaded from the ConsentCollection.

Options
integer
Example: 33

The options to indicate what results should be returned. Leave this empty for all results

KvK
string
Example: 27136700

Kvk number to start B2B categorization

SBI
string
Example: 6201

SBI code for B2B categorization. SBI code from Kvk will be used if not specified

IncludePending
boolean
Example: false

Enable pending transactions. Default is false

IncludeMachineLearning
boolean
Example: true

Enable transaction categorization using machine learning. Default is true

Businesses
string <json>
Example: [{"IBan": "NL69RABO0123456789","KvK": "01234567","SBI": "1234"},{"IBan": "NL69INGB0123456789","KvK": "01234567"}]

JSON input to specify additional B2B categorization information

Virtuals
string <json>
Example: ["NL01INGB0123456789","NL01ABNA0123456789"]

JSON for defining IBANs of other non-included internal accounts

DateTo
string
Example: 2025-01-01T18:25:43.511Z

Enable cutoff point for transaction input

Request Body schema: application/octet-stream
required

The file to process

object <file>

The file to process, provided as binary data byte[]. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/schemamodel

The SchemaModel service returns an aggregate schema that will be used in the Aggregate service.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
SchemaId
integer
Example: 0

Select a specific aggregate schema to obtain. If not given it will obtain the default

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CacheInfo

/api/linx/banks

Obtain a list of banks used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/categories

Obtain a list of categories used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/groups

Obtain a list of category groups used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/paymentcodes

Obtain a list of payment codes used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/costtypes

Obtain a list of cost types used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/countries

Obtain a list of countries used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/linx/nibudmodel

Obtain a nibud family template used by Invers

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ClientId
string
Example: YourAppName

A unique identifier used for tracking and personalized responses.

Responses

Response samples

Content type
application/json
{
  • "geslacht": [
    ],
  • "bouwjaar": [
    ],
  • "eigenRisico": [
    ],
  • "energielabel": [
    ],
  • "schooltype": [
    ],
  • "soortWoning": [
    ],
  • "typeWoning": [
    ],
  • "statusAuto": [
    ],
  • "woonsituatie": [
    ],
  • "gemeentes": [
    ],
  • "typeAuto": [
    ],
  • "leeftijd": [
    ],
  • "kilometers": [
    ],
  • "wozWaardes": [
    ]
}

Consents

/api/v1/Consents/generateConsentWizardUrl

Starts a new ConsentWizard session with the specified parameters.

The end-user should be redirected to the returned url to access the ConsentWizard and provide consent. After the end-user finishes up the consent flow he will be redirected to returnUrl.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

query Parameters
consentCollectionId
required
string
Example: consentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24

Identifier of the ConsentCollection.

returnUrl
required
string
Example: returnUrl=https://mywebsite.nl/callback

After finishing the consent flow, the end-user will be redirected to this url. Status information is added to the url, so you can take the appropriate follow-up actions.

The added fields added are:
• RequestId
• ConsentCollectionId
• ConsentCount, number of bank accounts the user gave consent for

Example of modified returnUrl: https://mywebsite.nl/callback?ConsentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24&RequestId=099220f7-9a3f-4446-be30-3064d2a590d7&ConsentCount=0

customerSubType
string
Example: customerSubType=default

Optional. If multiple text subprofiles are defined for you, you can activate one of them for this ConsentWizard session by setting this parameter.

collectionType
integer <int32>
Default: 1
Example: collectionType=0

Optional. ConsentCollections can be restricted to only access recent (90 days) PSD2 data instead of the historical data range (18-24 months depending on banks). If you only want to access data no older than 90 days, set collectionType to 0. The collectionType can be changed from 0 to 1 at a later point. By default the collectionType will be set to 1 to provide the option of retrieving full historical data.

defaultAccountType
integer <int32>
Default: 0
Example: defaultAccountType=0

Optional. When set, the account type of all bank accounts added, will default to this value and prevent the account type selection dialog from popping up.

The possible values are:
• 0 = Unknown, default, account type selection dialog will be shown
• 1 = OwnAccount, for when a end-user adds their own personal account
• 2 = ThirdPartyAccount, for when a end-user adds a personal account beloging to someone else
• 3 = BusinessAccount, for when a end-user adds a business account

header Parameters
ApiKey
required
string
Example: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

Your unique ApiKey, given to you during onboarding.

X-Request-ID
required
string <uuid>
Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Should be unique for each call, subsequent calls with the same guid will be rejected, is meant for correlating logs and responses.

ExpectedIbans
string
Example: ["NL02ABNA0123456789","NL12SNSB0123456789"]

Optional. A JSON array with valid IBANs. When this is given, accounts placeholders will appear in the wizard to show the user for which accounts consent is expected.

On-Behalf-Of
string <uuid>
Example: 27af4bef-d108-4b3a-81ad-56da089f2657

Optional. When set, the request will be handled on behalf of the specified partner. The value must be a valid customer identifier. Available only for specific partners that facilitate connectivity for other partners.

Responses

Response samples

Content type
application/json
{}

/api/v1/Consents/generateUrl

Generate a URL where users can give consent for accounts from a specific bank.
The ConsentWizard will not be used in this flow.

The end-user should be redirected to the returned consentRequestUrl to provide consent. The consentRequestUrl could be a url directly to the bank or first stop on openbanking.invers.nl if GDPR consent is missing. After the end-user finishes up the consent flow he will be redirected to returnUrl.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

query Parameters
consentCollectionId
required
string
Example: consentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24

Identifier of the ConsentCollection.

returnUrl
required
string
Example: returnUrl=https://mywebsite.nl/callback

After finishing the consent flow, the end-user will be redirected to this url. Status information is added to the url, so you can take the appropriate follow-up actions.

The added fields added are:
• RequestId
• ConsentCollectionId
• ConsentCount, number of bank accounts the user gave consent for

Example of modified returnUrl: https://mywebsite.nl/callback?ConsentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24&RequestId=099220f7-9a3f-4446-be30-3064d2a590d7&ConsentCount=0

bankId
required
string
Example: bankId=ec3e0888-36ac-4a96-aaf7-4aa744f0d5d7

Bank identifier. Values can be retrieved with a call to /api/linx/banks

collectionType
integer <int32>
Default: 1
Example: collectionType=0

Optional. ConsentCollections can be restricted to only access recent (90 days) psd2 data instead of the historical data range (18-24 months depending on banks) If you only want to access data, no older than 90 days, you could set collectionType to 0. By default the ConsentCollection will be set to 1 to provide the option of retrieving full historical data.

defaultAccountType
integer <int32>
Default: 0
Example: defaultAccountType=0

Optional. When set, the account type of all bank accounts added, will default to this value and prevent the account type selection dialog from popping up

The possible values are:
• 0 = Unknown, default, account type selection dialog will be shown
• 1 = OwnAccount, for when a end-user adds their own account
• 2 = ThirdPartyAccount, for when a end-user adds an account beloging to someone else
• 3 = BusinessAccount, for when a end-user adds a business account

header Parameters
ApiKey
required
string
Example: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

Your unique ApiKey, given to you during onboarding.

X-Request-ID
required
string <uuid>
Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Should be unique for each call, subsequent calls with the same guid will be rejected, is meant for correlating logs and responses.

On-Behalf-Of
guid
Example: 27af4bef-d108-4b3a-81ad-56da089f2657

Optional. When set, the request will be handled on behalf of the specified partner. The value must be a valid customer identifier. Available only for specific partners that facilitate connectivity for other partners.

Responses

Response samples

Content type
application/json
{}

/api/v1/Consents/accounts

Retrieve a detailed overview of the bank accounts associated with the supplied consentCollectionId.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

query Parameters
consentCollectionId
required
string
Example: consentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24

Identifier of the ConsentCollection.

header Parameters
ApiKey
required
string
Example: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

Your unique ApiKey, given to you during onboarding.

X-Request-ID
required
string <uuid>
Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Should be unique for each call, subsequent calls with the same guid will be rejected, is meant for correlating logs and responses.

On-Behalf-Of
string <uuid>
Example: 27af4bef-d108-4b3a-81ad-56da089f2657

Optional. When set, the request will be handled on behalf of the specified partner. The value must be a valid customer identifier. Available only for specific partners that facilitate connectivity for other partners.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/v1/Consents/clearCollection

Remove all bank accounts from a ConsentCollection.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

query Parameters
consentCollectionId
required
string <uuid>
Example: consentCollectionId=d2c95f1b-6802-459e-ba7d-70491ac27d24

Identifier of the ConsentCollection.

header Parameters
ApiKey
required
string
Example: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

Your unique ApiKey, given to you during onboarding.

X-Request-ID
required
string <uuid>
Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Should be unique for each call, subsequent calls with the same guid will be rejected, is meant for correlating logs and responses.

On-Behalf-Of
string <uuid>
Example: 27af4bef-d108-4b3a-81ad-56da089f2657

Optional. When set, the request will be handled on behalf of the specified partner. The value must be a valid customer identifier. Available only for specific partners that facilitate connectivity for other partners.

Responses

Response samples

Content type
application/json
{
  • "clearSuccessfull": true,
  • "collectionId": "d2c95f1b-6802-459e-ba7d-70491ac27d24",
  • "message": "Removed 2 accounts for collection d46b5c4d-4d0f-4770-b510-2623214360a1"
}

Status

/api/v1/Status/BankHealth

Retrieves the current health status of banks integrated with the system. This is determined by monitoring our communication with the bank APIs.

Note: The required security headers have been omitted for clarity, check documentation for details HTTP Request signing

header Parameters
ApiKey
required
string
Example: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

Your unique ApiKey, given to you during onboarding.

X-Request-ID
required
string <uuid>
Example: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Should be unique for each call, subsequent calls with the same guid will be rejected, is meant for correlating logs and responses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]