Skip to main content

LinX API (Current)

Consents

/api/v1/Consents/generateConsentWizardUrl

Starts a new ConsentWizard session with the specified parameters.

path Parameters
version
required
string
query Parameters
consentCollectionId
required
string

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

returnUrl
required
string

Redirect URL after consent has been given. A valid URI format [protocol]://[address] is expected (e.g., https://mywebsite.org/callback).

customerSubType
string

Optional. The customer sub type. Leave empty for default.

collectionType
integer <int32>
Default: 1

Optional. The collection type. Leave empty for default.

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ExpectedIbans
string

A JSON array with valid IBANs. When this is given, the accounts automatically appear in the wizard to show the user for which accounts consent is required. Value format: ["NL02ABNA0123456789","NL12SNSB0123456789"]

Responses

/api/v1/Consents/generateUrl

Generate a bank URL where users can give consent.

path Parameters
version
required
string
query Parameters
consentCollectionId
required
string

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

returnUrl
required
string

Redirect URL after consent has been given. Value format: https://mywebsite.org/callback

bankId
required
string

Bank identifier. Value format: f3746abd-df60-4185-9b53-6f4e6652458b

collectionType
integer <int32>
Default: 1
header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Ibans
string

Required for some banks. A JSON array with valid IBANs. Value format: ["NL02ABNA0123456789","NL12SNSB0123456789"]

Responses

Response samples

Content type

/api/v1/Consents/info

Fetch consent details and related bank account information. We recommend using AccountInfo (/api/v1/Consents/accounts) instead.

path Parameters
version
required
string
query Parameters
consentCollectionId
required
string

Consent Collection Identifier from which information is being requested. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Responses

Response samples

Content type
[
  • [
    ]
]

/api/v1/Consents/accounts

Retrieve a detailed overview of the bank accounts associated with a given ConsentCollectionId.

path Parameters
version
required
string
query Parameters
consentCollectionId
required
string

Consent Collection Identifier from which information is being requested. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Responses

Response samples

Content type
[
  • [
    ]
]

/api/v1/Consents/clearCollection

Remove bank accounts from a consent collection.

path Parameters
version
required
string
query Parameters
consentCollectionId
required
string <uuid>

Consent Collection Identifier from which information is being requested. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Responses

Response samples

Content type
{
  • "clearSuccessfull": true,
  • "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
  • "message": "string"
}

Status

/api/v1/Status/BankHealth

Show the current status of the banks in the form of online or offline state.

path Parameters
version
required
string
header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

Responses

Response samples

Content type
[
  • [
    ]
]

LinX

/api/v3/linx/convert

Enrich one or more files with information.

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

Options
integer

default = 33

KvK
string

A unique Chamber of Commerce identifier for the business. Used to enable business categorization in the request.

SBI
string

An activity code for the business. If not provided, the standard SBI code from the Chamber of Commerce will be used for business categorization.

IncludePending
boolean

When set to true, includes pending transactions in the response. Defaults to false if not specified.

IncludeRecurrence
boolean

When set to true, enables the Recurrence algorithm for the transaction batch.

IncludeMachineLearning
boolean

When set to true, activates the Machine Learning API for the transaction batch.

Businesses
string <json>

Used to enable business-specific categorization and processing in the request.

Virtuals
string <json>

Specify the IBANs of virtual accounts. Used to treat one or more bank accounts as 'part of the batch'.

Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
{
  • "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/pivot

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

InputHash
string
ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

Options
integer

Default = 33

Unit
integer

Possible values: 0 = None 1 = Day 2 = Week 3 = Month 4 = Quarter 5 = Semester 6 = Year; Default = 0

KvK
string

A unique Chamber of Commerce identifier for the business. Used to enable business categorization in the request.

SBI
string

An activity code for the business. If not provided, the standard SBI code from the Chamber of Commerce will be used for business categorization.

Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/api/linx/pivotgroup

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

InputHash
string
ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

Options
integer

Default = 33

Unit
integer

Possible values: 0 = None 1 = Day 2 = Week 3 = Month 4 = Quarter 5 = Semester 6 = Year; Default = 0

KvK
string

A unique Chamber of Commerce identifier for the business. Used to enable business categorization in the request.

SBI
string

An activity code for the business. If not provided, the standard SBI code from the Chamber of Commerce will be used for business categorization.

Request Body schema: application/json
required

File to process

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/api/linx/aggregate

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
SchemaId
integer

The SchemaId parameter is optional. Only provide this parameter if you have received a SchemaId.

Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
{
  • "aggregated": {
    },
  • "profile": {
    }
}

/api/linx/schemamodel

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

SchemaId
integer

The SchemaId parameter is optional. Only provide this parameter if you have received a SchemaId.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/profile

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/api/v3/linx/budget

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

InputHash
string
Request Body schema: application/json
required

The file to process.

aggregated
required
object

The aggregated file content.

profile
required
object

The profile file content.

Responses

Request samples

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

Response samples

Content type
{
  • "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

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
Options
integer

Default = 33

Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
[
  • {
    }
]

/api/linx/periodical_income

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
Options
integer
Request Body schema: application/json
required

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

object <file>

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
[
  • {
    }
]

/api/v3/linx/indicator/consumer

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
KvK
string

A unique Chamber of Commerce identifier for the business. Used to enable business categorization in the request.

SBI
string

An activity code for the business. If not provided, the standard SBI code from the Chamber of Commerce will be used for business categorization.

ReportingPeriod
string <json>

Example: {"PeriodUnit": "month","FullPeriodsOnly": true}

DateRange
string <json>

Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Responses

Response samples

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

/api/v3/linx/indicator/business

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
KvK
string

A unique Chamber of Commerce identifier for the business. Used to enable business categorization in the request.

SBI
string

An activity code for the business. If not provided, the standard SBI code from the Chamber of Commerce will be used for business categorization.

ReportingPeriod
string <json>

Example: {"PeriodUnit": "month","FullPeriodsOnly": true}

DateRange
string <json>

Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Responses

Response samples

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

/api/v1/LinX/recurrence

header Parameters
ApiKey
required
any

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

ConsentCollectionId
string <uuid>

Identifier of the Consent Collection, unique GUID for this collection. Value format: d2c95f1b-6802-459e-ba7d-70491ac27d24

InputHash
string
Options
integer
Request Body schema: application/json
required

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

file

Responses

Request samples

Content type
application/json
null

Response samples

Content type
{
  • "accountsCount": 0,
  • "recurrenceCategoriesCount": 0,
  • "recurrenceContractsCount": 0,
  • "recurrenceTransactionsCount": 0,
  • "totalRecurrenceIncome": 0.1,
  • "monthlyRecurrenceIncome": 0.1,
  • "totalRecurrenceExpense": 0.1,
  • "monthlyRecurrenceExpense": 0.1,
  • "accounts": [
    ]
}

CacheInfo

/api/linx/banks

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/categories

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/groups

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/paymentcodes

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/costtypes

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/countries

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

Content type
[
  • {
    }
]

/api/linx/nibudmodel

header Parameters
ApiKey
required
string <uuid>

Value format: cEZrSmVPLTN1XzVDM09nVDhEanlZaUJwYzRXTldpVUc=

X-Request-ID
required
string <uuid>

Value format: f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f

ClientId
string

Identifier for the client or application making the API request, used for tracking or personalized responses.

Responses

Response samples

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