LinX API (Current)
/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: |
returnUrl required | string Redirect URL after consent has been given. A valid URI format [protocol]://[address] is expected (e.g., |
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: |
X-Request-ID required | string <uuid> Value format: |
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: |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "requestId": "1efc3403-3d77-4cb2-91f3-895d48075720"
}
/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: |
returnUrl required | string Redirect URL after consent has been given. Value format: |
bankId required | string Bank identifier. Value format: |
collectionType | integer <int32> Default: 1 |
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
Ibans | string Required for some banks. A JSON array with valid IBANs. Value format: |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "consentCollectionId": "d2c95f1b-6802-459e-ba7d-70491ac27d24",
- "requestId": "f1b8d9bd-0118-47ff-bdb7-5e2956ad0e9f"
}
/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: |
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
Responses
Response samples
- 200
- 400
- 401
- 500
[- [
- {
- "bankId": "f3746abd-df60-4185-9b53-6f4e6652458b",
- "bankName": "SNS bank",
- "consentedOn": "YYYY-MM-DDTHH:MM:SS+HH:MM",
- "expiresOn": "YYYY-MM-DDTHH:MM:SS+HH:MM",
- "fromHistoryDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
- "status": 2,
- "accounts": [
- {
- "iBan": "NL00SNSB0123456789",
- "status": 1,
- "lastdownload": null,
- "historyAvailable": true,
- "name": "Hr A B Janssen",
- "product": "SNS BETALEN"
}
]
}
]
]
/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: |
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
Responses
Response samples
- 200
- 400
- 401
- 500
[- [
- {
- "BankId": "ec3e0888-36ac-4a96-aaf7-4aa744f0d5d7",
- "BankName": "ING bank",
- "ConsentedOn": "2020-08-28T09:45:56",
- "ExpiresOn": "2019-06-30T00:00:00+02:00",
- "FromHistoryDate": "2019-06-30T00:00:00+02:00",
- "Status": "Expired",
- "IBan": "NL69INGB0123456789",
- "Lastdownload": "2020-08-28T00:00:00+02:00",
- "HistoryAvailable": false,
- "Name": "Bob Tuinman",
- "Product": null
}, - {
- "BankId": "ec3e0888-36ac-4a96-aaf7-4aa744f0d5d7",
- "BankName": "ING bank",
- "ConsentedOn": "2020-08-28T09:45:56",
- "ExpiresOn": "2019-06-30T00:00:00+02:00",
- "FromHistoryDate": "2019-06-30T00:00:00+02:00",
- "Status": "Expired",
- "IBan": "NL69INGB0123456789",
- "Lastdownload": "2020-08-28T00:00:00+02:00",
- "HistoryAvailable": false,
- "Name": "Bob Tuinman",
- "Product": null
}
]
]
/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: |
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "clearSuccessfull": true,
- "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
- "message": "string"
}
/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: |
X-Request-ID required | string <uuid> Value format: |
Responses
Response samples
- 200
- 400
- 401
[- [
- {
- "BankId": "3d70e5ae-7fed-4789-963c-a9f9de7cf794",
- "BankName": "Rabobank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T09:57:26.8250588+02:00"
}, - {
- "BankId": "e104cb12-f42a-444b-b65d-20ff1bd70960",
- "BankName": "Triodos bank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T07:21:35.825097+02:00"
}, - {
- "BankId": "f3695e7a-c064-4104-821b-2b707f4a656a",
- "BankName": "Bunq",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T09:17:04.8251103+02:00"
}, - {
- "BankId": "ec3e0888-36ac-4a96-aaf7-4aa744f0d5d7",
- "BankName": "ING bank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T09:58:43.8251214+02:00"
}, - {
- "BankId": "a0ad6e35-766b-4a7a-aecd-21f6dd5d9011",
- "BankName": "Knab",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T09:37:37.8251326+02:00"
}, - {
- "BankId": "6e2336ff-612e-4103-93b4-089d10281265",
- "BankName": "Regiobank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T09:24:04.8251453+02:00"
}, - {
- "BankId": "2466bd30-a9ce-4a7b-b5f4-78e69a176912",
- "BankName": "F. van Lanschot Bankiers",
- "BankStatus": 1,
- "StatusHeldSince": "2021-05-02T15:16:41.8251566+02:00"
}, - {
- "BankId": "f3746abd-df60-4185-9b53-6f4e6652458b",
- "BankName": "SNS bank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T06:38:38.8251678+02:00"
}, - {
- "BankId": "287f6bbe-44d4-4963-987b-fe2122de5239",
- "BankName": "ASN Bank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T07:25:58.8251791+02:00"
}, - {
- "BankId": "d22d49f5-46c1-44f7-974c-c6e2fe7c8f0e",
- "BankName": "ABN-AMRO Bank",
- "BankStatus": 1,
- "StatusHeldSince": "2021-06-28T10:03:32.8251902+02:00"
}
]
]
/api/v3/linx/convert
Enrich one or more files with information.
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
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/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
{- "format": "string",
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "accounts": [
- {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "number": "string",
- "formattedNumber": "string",
- "iBan": "string",
- "swiftCode": "string",
- "beginBalanceDate": "2019-08-24T14:15:22Z",
- "beginBalance": 0.1,
- "endBalanceDate": "2019-08-24T14:15:22Z",
- "endBalance": 0.1,
- "bank": {
- "id": 0,
- "country": "string",
- "bic": "string",
- "name": "string",
- "formats": "string",
- "downloadUrl": "string",
- "iconUrl": "string",
- "infoUrl": "string",
- "isActive": true,
- "isVisible": true,
- "sortOrder": 0,
- "syncKey": "string"
}, - "transactions": [
- {
- "id": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0,
- "endBalance": 0.1,
- "beneficiary": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": null,
- "name": null
}, - "municipality": {
- "id": null,
- "name": null
}, - "province": {
- "id": null,
- "name": null
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}
}, - "code": {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "flags": "0 = None",
- "sequence": 0,
- "categoryId": 0,
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}, - "naceId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "properties": [
- {
- "id": 0,
- "type": "0 = None",
- "context": "0 = Transaction",
- "name": "string",
- "value": "string",
- "properties": [
- { }
]
}
], - "contract": "string",
- "externalTransactionId": "string",
- "inversCategoryId": 0,
- "customCategoryId": 0
}
]
}
], - "businesses": [
- {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}
], - "groups": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": { },
- "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}
]
}
], - "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}
], - "naces": [
- {
- "id": 0,
- "code": "string",
- "description": "string"
}
], - "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a"
}
/api/linx/pivot
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
Options | integer Default = 33 |
Unit | integer Possible values:
|
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/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
{- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "unit": "0 = None",
- "groups": [
- {
- "id": 0,
- "name": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "amount": 0.1,
- "average": 0.1,
- "count": 0,
- "values": [
- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0
}
]
}
], - "amount": 0.1,
- "average": 0.1,
- "count": 0,
- "values": [
- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0
}
]
}
]
}
/api/linx/pivotgroup
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
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/jsonrequired
File to process
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
{- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "unit": "0 = None",
- "groups": [
- {
- "id": 0,
- "name": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "amount": 0.1,
- "average": 0.1,
- "count": 0,
- "values": [
- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0
}
]
}
], - "amount": 0.1,
- "average": 0.1,
- "count": 0,
- "values": [
- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0
}
]
}
]
}
/api/linx/aggregate
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
InputHash | string |
SchemaId | integer The SchemaId parameter is optional. Only provide this parameter if you have received a SchemaId. |
Request Body schema: application/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
{- "aggregated": {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "nodes": [
- {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "tooltip": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "voorbeeld": 0.1,
- "basis": 0.1,
- "nodes": [
- { }
], - "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "amount": 0.1,
- "value": 0.1,
- "count": 0
}
], - "posten": [
- {
- "id": 0,
- "post": "string",
- "name": "string",
- "voorbeeld": 0.1,
- "basis": 0.1
}
], - "amount": 0.1,
- "value": 0.1,
- "interpolatedAmount": 0.1,
- "isEnabled": true,
- "isVisible": true,
- "syncKey": "string",
- "parent": { }
}
], - "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
}, - "profile": {
- "besteedbaarInkomen": 0.1,
- "hoofdpersonen": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man",
- "eigenRisico": "0 = Categorie1"
}
], - "huisgenoten": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man"
}
], - "kinderen": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man",
- "schooltype": "0 = Geen",
- "woonsituatie": "0 = Thuiswonend",
- "leeftijd": "0 = Nul_tot_en_met_vijf"
}
], - "autos": [
- {
- "kilometersPerJaar": 0,
- "nieuwwaarde": 0.1,
- "status": "0 = Nieuw",
- "soort": "0 = Geen",
- "kilometer": "0 = Less_Then_10000",
- "voertuig": {
- "kenteken": "string",
- "soort": "string",
- "merk": "string",
- "handelsbenaming": "string",
- "inrichting": "string",
- "datumTenaamstelling": "2019-08-24T14:15:22Z",
- "zuinigheidslabel": "string",
- "catalogusPrijs": 0.1,
- "aantalZitplaatsen": 0,
- "vervaldatumAPK": "2019-08-24T14:15:22Z",
- "type": "string",
- "variant": "string",
- "taxi": "string",
- "verzekerd": "string",
- "brandstofEndpoint": "string",
- "brandstof": [
- {
- "soort": "string",
- "volgnummer": 0,
- "verbruikBuiten": 0.1,
- "verbruikGecombineerd": 0.1,
- "verbruikStad": 0.1,
- "cO2UitsootGecombineerd": 0.1,
- "emissieCode": "string",
- "geluidsniveau_Stationair": 0.1,
- "kenteken": "string",
- "milieuklasse_eg_goedkeuring_licht": "string",
- "nettoMaximumVermogen": 0.1,
- "geluidsniveau_Toerental": 0.1
}
]
}
}
], - "woning": {
- "bouwjaar": "0 = BouwjaarVoor1946",
- "energielabel": "0 = Onbekend",
- "soort": "0 = Huurwoning",
- "typeWoning": "0 = VrijstaandGroot",
- "wozWaarde": 0.1,
- "woz": "0 = Less_Then_150000",
- "huurPerMaand": 0.1,
- "hypotheekPerMaand": 0.1,
- "gemeenteId": 0,
- "adres": {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
}, - "incomes": [
- {
- "id": 0,
- "partner": true,
- "title": "string",
- "tooltip": "string",
- "unit": "0 = None",
- "div": 0,
- "value": 0.1,
- "categories": [
- {
- "id": 0,
- "amount": 0.1
}
]
}
]
}
}
/api/linx/schemamodel
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
SchemaId | integer The SchemaId parameter is optional. Only provide this parameter if you have received a SchemaId. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "nodes": [
- {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "tooltip": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "voorbeeld": 0.1,
- "basis": 0.1,
- "nodes": [
- { }
], - "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "amount": 0.1,
- "value": 0.1,
- "count": 0
}
], - "posten": [
- {
- "id": 0,
- "post": "string",
- "name": "string",
- "voorbeeld": 0.1,
- "basis": 0.1
}
], - "amount": 0.1,
- "value": 0.1,
- "interpolatedAmount": 0.1,
- "isEnabled": true,
- "isVisible": true,
- "syncKey": "string",
- "parent": { }
}
], - "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/profile
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
InputHash | string |
Request Body schema: application/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
{- "besteedbaarInkomen": 0.1,
- "hoofdpersonen": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man",
- "eigenRisico": "0 = Categorie1"
}
], - "huisgenoten": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man"
}
], - "kinderen": [
- {
- "geboortedatum": "2019-08-24T14:15:22Z",
- "geslacht": "0 = Man",
- "schooltype": "0 = Geen",
- "woonsituatie": "0 = Thuiswonend",
- "leeftijd": "0 = Nul_tot_en_met_vijf"
}
], - "autos": [
- {
- "kilometersPerJaar": 0,
- "nieuwwaarde": 0.1,
- "status": "0 = Nieuw",
- "soort": "0 = Geen",
- "kilometer": "0 = Less_Then_10000",
- "voertuig": {
- "kenteken": "string",
- "soort": "string",
- "merk": "string",
- "handelsbenaming": "string",
- "inrichting": "string",
- "datumTenaamstelling": "2019-08-24T14:15:22Z",
- "zuinigheidslabel": "string",
- "catalogusPrijs": 0.1,
- "aantalZitplaatsen": 0,
- "vervaldatumAPK": "2019-08-24T14:15:22Z",
- "type": "string",
- "variant": "string",
- "taxi": "string",
- "verzekerd": "string",
- "brandstofEndpoint": "string",
- "brandstof": [
- {
- "soort": "string",
- "volgnummer": 0,
- "verbruikBuiten": 0.1,
- "verbruikGecombineerd": 0.1,
- "verbruikStad": 0.1,
- "cO2UitsootGecombineerd": 0.1,
- "emissieCode": "string",
- "geluidsniveau_Stationair": 0.1,
- "kenteken": "string",
- "milieuklasse_eg_goedkeuring_licht": "string",
- "nettoMaximumVermogen": 0.1,
- "geluidsniveau_Toerental": 0.1
}
]
}
}
], - "woning": {
- "bouwjaar": "0 = BouwjaarVoor1946",
- "energielabel": "0 = Onbekend",
- "soort": "0 = Huurwoning",
- "typeWoning": "0 = VrijstaandGroot",
- "wozWaarde": 0.1,
- "woz": "0 = Less_Then_150000",
- "huurPerMaand": 0.1,
- "hypotheekPerMaand": 0.1,
- "gemeenteId": 0,
- "adres": {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
}, - "incomes": [
- {
- "id": 0,
- "partner": true,
- "title": "string",
- "tooltip": "string",
- "unit": "0 = None",
- "div": 0,
- "value": 0.1,
- "categories": [
- {
- "id": 0,
- "amount": 0.1
}
]
}
]
}
/api/v3/linx/budget
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
InputHash | string |
Request Body schema: application/jsonrequired
The file to process.
aggregated required | object The aggregated file content. |
profile required | object The profile file content. |
Responses
Request samples
- Payload
{- "aggregated": { },
- "profile": { }
}
Response samples
- 200
- 400
- 403
- 503
{- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "nodes": [
- {
- "id": 0,
- "name": "string",
- "title": "string",
- "description": "string",
- "tooltip": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "voorbeeld": 0.1,
- "basis": 0.1,
- "nodes": [
- { }
], - "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "amount": 0.1,
- "value": 0.1,
- "count": 0
}
], - "posten": [
- {
- "id": 0,
- "post": "string",
- "name": "string",
- "voorbeeld": 0.1,
- "basis": 0.1
}
], - "amount": 0.1,
- "value": 0.1,
- "interpolatedAmount": 0.1,
- "isEnabled": true,
- "isVisible": true,
- "syncKey": "string",
- "parent": { }
}
], - "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: |
X-Request-ID required | string <uuid> Value format: |
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: |
InputHash | string |
Options | integer Default = 33 |
Request Body schema: application/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
[- {
- "account": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "number": "string",
- "formattedNumber": "string",
- "iBan": "string",
- "swiftCode": "string",
- "beginBalanceDate": "2019-08-24T14:15:22Z",
- "beginBalance": 0.1,
- "endBalanceDate": "2019-08-24T14:15:22Z",
- "endBalance": 0.1,
- "bank": {
- "id": 0,
- "country": "string",
- "bic": "string",
- "name": "string",
- "formats": "string",
- "downloadUrl": "string",
- "iconUrl": "string",
- "infoUrl": "string",
- "isActive": true,
- "isVisible": true,
- "sortOrder": 0,
- "syncKey": "string"
}, - "transactions": [
- {
- "id": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0,
- "endBalance": 0.1,
- "beneficiary": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": null,
- "name": null
}, - "municipality": {
- "id": null,
- "name": null
}, - "province": {
- "id": null,
- "name": null
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}
}, - "code": {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "flags": "0 = None",
- "sequence": 0,
- "categoryId": 0,
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}, - "naceId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "properties": [
- {
- "id": 0,
- "type": "0 = None",
- "context": "0 = Transaction",
- "name": "string",
- "value": "string",
- "properties": [
- { }
]
}
], - "contract": "string",
- "externalTransactionId": "string",
- "inversCategoryId": 0,
- "customCategoryId": 0
}
]
}, - "items": [
- {
- "probability": "0 = Medium",
- "frequenceType": "0 = None",
- "interval": 0,
- "contract": "string",
- "date": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "type": "0 = AC",
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}, - "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "account": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "number": "string",
- "formattedNumber": "string",
- "iBan": "string",
- "bic": "string",
- "incassant": "string",
- "mandate": "string",
- "targetBusinessId": 0,
- "targetBusiness": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "targetName": "string"
}, - "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "name": "string",
- "description": "string",
- "pattern": "string",
- "transactions": [
- {
- "id": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0,
- "endBalance": 0.1,
- "beneficiary": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": null,
- "default": null,
- "street": null,
- "houseNumber": null,
- "houseNumberAddition": null,
- "zipcode": null,
- "city": null,
- "municipality": null,
- "province": null,
- "country": null,
- "type": null,
- "purpose": null,
- "surface": null,
- "surfaceArea": null,
- "latitude": null,
- "longitude": null
}
], - "contacts": [
- {
- "type": null,
- "value": null
}
], - "activities": [
- {
- "code": null,
- "name": null,
- "isMain": null
}
], - "tradenames": [
- "string"
]
}
}, - "code": {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "flags": "0 = None",
- "sequence": 0,
- "categoryId": 0,
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- null
]
}
]
}, - "naceId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "properties": [
- {
- "id": 0,
- "type": "0 = None",
- "context": "0 = Transaction",
- "name": "string",
- "value": "string",
- "properties": [
- { }
]
}
], - "contract": "string",
- "externalTransactionId": "string",
- "inversCategoryId": 0,
- "customCategoryId": 0
}
]
}
]
}
]
/api/linx/periodical_income
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
InputHash | string |
Options | integer |
Request Body schema: application/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
{ }
Response samples
- 200
- 400
- 403
- 503
[- {
- "account": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "number": "string",
- "formattedNumber": "string",
- "iBan": "string",
- "swiftCode": "string",
- "beginBalanceDate": "2019-08-24T14:15:22Z",
- "beginBalance": 0.1,
- "endBalanceDate": "2019-08-24T14:15:22Z",
- "endBalance": 0.1,
- "bank": {
- "id": 0,
- "country": "string",
- "bic": "string",
- "name": "string",
- "formats": "string",
- "downloadUrl": "string",
- "iconUrl": "string",
- "infoUrl": "string",
- "isActive": true,
- "isVisible": true,
- "sortOrder": 0,
- "syncKey": "string"
}, - "transactions": [
- {
- "id": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0,
- "endBalance": 0.1,
- "beneficiary": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": null,
- "name": null
}, - "municipality": {
- "id": null,
- "name": null
}, - "province": {
- "id": null,
- "name": null
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}
}, - "code": {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "flags": "0 = None",
- "sequence": 0,
- "categoryId": 0,
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}, - "naceId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "properties": [
- {
- "id": 0,
- "type": "0 = None",
- "context": "0 = Transaction",
- "name": "string",
- "value": "string",
- "properties": [
- { }
]
}
], - "contract": "string",
- "externalTransactionId": "string",
- "inversCategoryId": 0,
- "customCategoryId": 0
}
]
}, - "items": [
- {
- "probability": "0 = Medium",
- "frequenceType": "0 = None",
- "interval": 0,
- "contract": "string",
- "date": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "type": "0 = AC",
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}, - "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "account": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "number": "string",
- "formattedNumber": "string",
- "iBan": "string",
- "bic": "string",
- "incassant": "string",
- "mandate": "string",
- "targetBusinessId": 0,
- "targetBusiness": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "targetName": "string"
}, - "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": "string",
- "default": true,
- "street": "string",
- "houseNumber": "string",
- "houseNumberAddition": "string",
- "zipcode": "string",
- "city": {
- "id": "string",
- "name": "string"
}, - "municipality": {
- "id": "string",
- "name": "string"
}, - "province": {
- "id": "string",
- "name": "string"
}, - "country": "string",
- "type": "string",
- "purpose": "0 = None",
- "surface": 0,
- "surfaceArea": 0,
- "latitude": 0.1,
- "longitude": 0.1
}
], - "contacts": [
- {
- "type": "0 = Email",
- "value": "string"
}
], - "activities": [
- {
- "code": "string",
- "name": "string",
- "isMain": true
}
], - "tradenames": [
- "string"
]
}, - "name": "string",
- "description": "string",
- "pattern": "string",
- "transactions": [
- {
- "id": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "count": 0,
- "endBalance": 0.1,
- "beneficiary": {
- "id": 0,
- "country": "string",
- "name": "string",
- "originalName": "string",
- "reference": "string",
- "businessId": 0,
- "business": {
- "id": 0,
- "name": "string",
- "country": "string",
- "number": "string",
- "subsidiary": "string",
- "addresses": [
- {
- "id": null,
- "default": null,
- "street": null,
- "houseNumber": null,
- "houseNumberAddition": null,
- "zipcode": null,
- "city": null,
- "municipality": null,
- "province": null,
- "country": null,
- "type": null,
- "purpose": null,
- "surface": null,
- "surfaceArea": null,
- "latitude": null,
- "longitude": null
}
], - "contacts": [
- {
- "type": null,
- "value": null
}
], - "activities": [
- {
- "code": null,
- "name": null,
- "isMain": null
}
], - "tradenames": [
- "string"
]
}
}, - "code": {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "flags": "0 = None",
- "sequence": 0,
- "categoryId": 0,
- "category": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- null
]
}
]
}, - "naceId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}, - "properties": [
- {
- "id": 0,
- "type": "0 = None",
- "context": "0 = Transaction",
- "name": "string",
- "value": "string",
- "properties": [
- { }
]
}
], - "contract": "string",
- "externalTransactionId": "string",
- "inversCategoryId": 0,
- "customCategoryId": 0
}
]
}
]
}
]
/api/v3/linx/indicator/consumer
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
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: |
DateRange | string <json> Example: |
Responses
Response samples
- 200
- 400
- 403
- 503
{- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
- "profile": {
- "zipcode": "string",
- "houseNumber": 0,
- "houseNumberExtra": "string",
- "street": "string",
- "city": "string"
}, - "indicators": [
- {
- "name": "string",
- "recurrenceInfo": {
- "interval": 0,
- "intervalUnit": "0 = None",
- "firstOccurrence": "2019-08-24T14:15:22Z",
- "lastOccurrence": "2019-08-24T14:15:22Z",
- "slopeTotal": 0.1,
- "reliabilityTotal": 0.1,
- "slopeLastThreeMonths": 0.1,
- "reliabilityLastThreeMonths": 0.1
}, - "accounts": [
- {
- "id": 0,
- "accountNumber": "string",
- "accountHolderName": "string"
}
], - "beneficiaries": [
- {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}
], - "transactions": [
- {
- "id": "string",
- "externalTransactionId": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "endBalance": 0.1,
- "transactionCode": {
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "beneficiary": {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}, - "category": "string",
- "categoryId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}
], - "total": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "lastThreeMonths": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "balanceAccounts": [
- {
- "accountNumber": "string",
- "accountHolderName": "string",
- "accountTypeId": 0,
- "accountTypeName": "string",
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "balanceRecords": [
- {
- "date": "2019-08-24T14:15:22Z",
- "balance": 0.1
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "minBalance": 0.1,
- "minBalanceDate": "2019-08-24T14:15:22Z",
- "maxBalance": 0.1,
- "maxBalanceDate": "2019-08-24T14:15:22Z",
- "averageBalance": 0.1,
- "daysPositive": 0.1,
- "daysAboveAverage": 0.1
}
], - "maxBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "minBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "averageBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysPositive": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysAboveAverage": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}
}
], - "balanceTotal": {
- "accountNumber": "string",
- "accountHolderName": "string",
- "accountTypeId": 0,
- "accountTypeName": "string",
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "balanceRecords": [
- {
- "date": "2019-08-24T14:15:22Z",
- "balance": 0.1
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "minBalance": 0.1,
- "minBalanceDate": "2019-08-24T14:15:22Z",
- "maxBalance": 0.1,
- "maxBalanceDate": "2019-08-24T14:15:22Z",
- "averageBalance": 0.1,
- "daysPositive": 0.1,
- "daysAboveAverage": 0.1
}
], - "maxBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "minBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "averageBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysPositive": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysAboveAverage": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}
}, - "groups": [
- {
- "beneficiary": {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}, - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}
}
], - "total": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "lastThreeMonths": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}
}
]
}
]
}
/api/v3/linx/indicator/business
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
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: |
DateRange | string <json> Example: |
Responses
Response samples
- 200
- 400
- 403
- 503
{- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
- "profile": {
- "zipcode": "string",
- "houseNumber": 0,
- "houseNumberExtra": "string",
- "street": "string",
- "city": "string"
}, - "indicators": [
- {
- "name": "string",
- "recurrenceInfo": {
- "interval": 0,
- "intervalUnit": "0 = None",
- "firstOccurrence": "2019-08-24T14:15:22Z",
- "lastOccurrence": "2019-08-24T14:15:22Z",
- "slopeTotal": 0.1,
- "reliabilityTotal": 0.1,
- "slopeLastThreeMonths": 0.1,
- "reliabilityLastThreeMonths": 0.1
}, - "accounts": [
- {
- "id": 0,
- "accountNumber": "string",
- "accountHolderName": "string"
}
], - "beneficiaries": [
- {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}
], - "transactions": [
- {
- "id": "string",
- "externalTransactionId": "string",
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "endBalance": 0.1,
- "transactionCode": {
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}, - "description": "string",
- "originalDescription": "string",
- "beneficiary": {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}, - "category": "string",
- "categoryId": 0,
- "nace": {
- "id": 0,
- "code": "string",
- "description": "string"
}
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}
], - "total": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "lastThreeMonths": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "balanceAccounts": [
- {
- "accountNumber": "string",
- "accountHolderName": "string",
- "accountTypeId": 0,
- "accountTypeName": "string",
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "balanceRecords": [
- {
- "date": "2019-08-24T14:15:22Z",
- "balance": 0.1
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "minBalance": 0.1,
- "minBalanceDate": "2019-08-24T14:15:22Z",
- "maxBalance": 0.1,
- "maxBalanceDate": "2019-08-24T14:15:22Z",
- "averageBalance": 0.1,
- "daysPositive": 0.1,
- "daysAboveAverage": 0.1
}
], - "maxBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "minBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "averageBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysPositive": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysAboveAverage": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}
}
], - "balanceTotal": {
- "accountNumber": "string",
- "accountHolderName": "string",
- "accountTypeId": 0,
- "accountTypeName": "string",
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "balanceRecords": [
- {
- "date": "2019-08-24T14:15:22Z",
- "balance": 0.1
}
], - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "minBalance": 0.1,
- "minBalanceDate": "2019-08-24T14:15:22Z",
- "maxBalance": 0.1,
- "maxBalanceDate": "2019-08-24T14:15:22Z",
- "averageBalance": 0.1,
- "daysPositive": 0.1,
- "daysAboveAverage": 0.1
}
], - "maxBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "minBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "averageBalance": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysPositive": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "daysAboveAverage": {
- "exp": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}
}, - "groups": [
- {
- "beneficiary": {
- "iban": "string",
- "incassant": "string",
- "mandate": "string",
- "bic": "string",
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "device": "string",
- "businessId": 0,
- "denominationId": 0
}, - "periods": [
- {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": null,
- "count": null
}
]
}
}
], - "total": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}, - "lastThreeMonths": {
- "dateFrom": "2019-08-24T14:15:22Z",
- "dateTo": "2019-08-24T14:15:22Z",
- "credit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "debit": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}, - "total": {
- "realisedTotalAmount": 0.1,
- "amountPerPeriod": {
- "mean": 0.1,
- "min": 0.1,
- "max": 0.1,
- "var": 0.1,
- "std": 0.1
}, - "numberOfTransactions": 0,
- "paymentTypes": [
- {
- "type": "0 = AC",
- "count": 0
}
]
}
}
}
]
}
]
}
/api/v1/LinX/recurrence
header Parameters
ApiKey required | any Value format: |
X-Request-ID required | string <uuid> Value format: |
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: |
InputHash | string |
Options | integer |
Request Body schema: application/jsonrequired
The file to process, provided as binary data byte[]
. Leave this field empty if using a ConsentCollectionID to call LinX with PSD2.
Responses
Request samples
- Payload
null
Response samples
- 200
- 400
- 403
- 503
{- "accountsCount": 0,
- "recurrenceCategoriesCount": 0,
- "recurrenceContractsCount": 0,
- "recurrenceTransactionsCount": 0,
- "totalRecurrenceIncome": 0.1,
- "monthlyRecurrenceIncome": 0.1,
- "totalRecurrenceExpense": 0.1,
- "monthlyRecurrenceExpense": 0.1,
- "accounts": [
- {
- "account": {
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "denominationId": 0,
- "swiftCode": "string",
- "bank": "string",
- "number": "string",
- "formatted": "string",
- "iBan": "string",
- "beginBalanceDate": "2019-08-24T14:15:22Z",
- "beginBalance": 0.1,
- "endBalanceDate": "2019-08-24T14:15:22Z",
- "endBalance": 0.1
}, - "totalRecurrenceIncome": 0.1,
- "monthlyRecurrenceIncome": 0.1,
- "totalRecurrenceExpense": 0.1,
- "monthlyRecurrenceExpense": 0.1,
- "recurrenceCategoriesCount": 0,
- "recurrenceContractsCount": 0,
- "recurrenceTransactionsCount": 0,
- "recurrences": [
- {
- "categoryId": 0,
- "categoryName": "string",
- "contractsCount": 0,
- "transactionsCount": 0,
- "totalAmount": 0.1,
- "monthlyAmount": 0.1,
- "contracts": [
- {
- "beneficiary": {
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "denominationId": 0
}, - "recurrenceProperties": {
- "quality": 0.1,
- "periodUnit": "0 = None",
- "period": 0
}, - "totalAmount": 0.1,
- "monthlyAmount": 0.1,
- "firstTransactionDate": "2019-08-24T14:15:22Z",
- "lastTransactionDate": "2019-08-24T14:15:22Z",
- "transactionsCount": 0,
- "transactions": [
- {
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "description": "string",
- "originalDescription": "string",
- "externalTransactionId": "string"
}
]
}
]
}
], - "anomaliesTransactionsCount": 0,
- "anomalies": [
- {
- "categoryId": 0,
- "categoryName": "string",
- "contractsCount": 0,
- "transactionsCount": 0,
- "totalAmount": 0.1,
- "monthlyAmount": 0.1,
- "contracts": [
- {
- "beneficiary": {
- "country": "string",
- "name": "string",
- "originalName": "string",
- "identifier": "string",
- "denominationId": 0
}, - "recurrenceProperties": {
- "quality": 0.1,
- "periodUnit": "0 = None",
- "period": 0
}, - "totalAmount": 0.1,
- "monthlyAmount": 0.1,
- "firstTransactionDate": "2019-08-24T14:15:22Z",
- "lastTransactionDate": "2019-08-24T14:15:22Z",
- "transactionsCount": 0,
- "transactions": [
- {
- "bookDate": "2019-08-24T14:15:22Z",
- "interestDate": "2019-08-24T14:15:22Z",
- "transactionDate": "2019-08-24T14:15:22Z",
- "amount": 0.1,
- "description": "string",
- "originalDescription": "string",
- "externalTransactionId": "string"
}
]
}
]
}
]
}
]
}
/api/linx/banks
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "country": "string",
- "bic": "string",
- "name": "string",
- "formats": "string",
- "downloadUrl": "string",
- "iconUrl": "string",
- "infoUrl": "string",
- "isActive": true,
- "isVisible": true,
- "sortOrder": 0,
- "syncKey": "string"
}
]
/api/linx/categories
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- { }
]
}, - "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}
]
/api/linx/groups
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "isInternal": true,
- "color": 0,
- "syncKey": "string",
- "categories": [
- {
- "id": 0,
- "name": "string",
- "type": "0 = Invalid",
- "costType": "7534 = None",
- "isInternal": true,
- "isStrict": true,
- "color": 0,
- "taxPost": "string",
- "syncKey": "string",
- "groupId": 0,
- "nibuds": [
- 0
], - "group": { },
- "posten": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "years": [
- 0
]
}
]
}
]
}
]
/api/linx/paymentcodes
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "type": "0 = AC",
- "code": "string",
- "numeric": 0,
- "name": "string"
}
]
/api/linx/costtypes
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "name": "string",
- "syncKey": "string"
}
]
/api/linx/countries
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
[- {
- "id": 0,
- "code": "string",
- "name": "string",
- "nativeName": "string",
- "number": 0,
- "languages": "string",
- "tld": "string",
- "capital": "string",
- "region": "string",
- "subRegion": "string",
- "latitude": 0.1,
- "longitude": 0.1,
- "syncKey": "string",
- "lcid": 0,
- "isVisible": true,
- "masks": [
- {
- "id": 0,
- "type": "0 = None",
- "value": "string"
}
], - "currencies": [
- {
- "id": 0,
- "valuta": "string"
}
], - "isoCode": "string"
}
]
/api/linx/nibudmodel
header Parameters
ApiKey required | string <uuid> Value format: |
X-Request-ID required | string <uuid> Value format: |
ClientId | string Identifier for the client or application making the API request, used for tracking or personalized responses. |
Responses
Response samples
- 200
- 403
- 503
{- "geslacht": [
- {
- "name": "string",
- "value": "0 = Man"
}
], - "bouwjaar": [
- {
- "name": "string",
- "value": "0 = BouwjaarVoor1946"
}
], - "eigenRisico": [
- {
- "name": "string",
- "value": "0 = Categorie1"
}
], - "energielabel": [
- {
- "name": "string",
- "value": "0 = Onbekend"
}
], - "schooltype": [
- {
- "name": "string",
- "value": "0 = Geen"
}
], - "soortWoning": [
- {
- "name": "string",
- "value": "0 = Huurwoning"
}
], - "typeWoning": [
- {
- "name": "string",
- "value": "0 = VrijstaandGroot"
}
], - "statusAuto": [
- {
- "name": "string",
- "value": "0 = Nieuw"
}
], - "woonsituatie": [
- {
- "name": "string",
- "value": "0 = Thuiswonend"
}
], - "gemeentes": [
- {
- "id": 0,
- "naam": "string"
}
], - "typeAuto": [
- {
- "name": "string",
- "value": "0 = Geen"
}
], - "leeftijd": [
- {
- "name": "string",
- "value": "0 = Nul_tot_en_met_vijf"
}
], - "kilometers": [
- {
- "name": "string",
- "value": "0 = Less_Then_10000"
}
], - "wozWaardes": [
- {
- "name": "string",
- "value": "0 = Less_Then_150000"
}
]
}