Skip to main content
API docs by Redocly

Categorization API (v2)

Download OpenAPI specification:Download

URL: https://api.enablenow.nl

categorization-jobs

GET categorization-jobs

Authorizations:
bearer
query Parameters
ConsentId
string or null <guid>

The consent identifier

UserId
string or null <guid>

The user identifier

ExternalUserId
string or null

The external user identifier

AccountId
string or null <guid>

The account identifier

Page
integer or null <int32>

The page number of the results to fetch

PageSize
integer or null <int32>

The number of results per page (max 100) (defaults to 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

POST categorization-job

Authorizations:
bearer
Request Body schema: application/json
required
engine
string

The engine used for categorization

profile
string

The engine-profile used for categorization

countryCode
string or null

Optional ISO 3166-1 alpha-2 country code for the categorization runtime. Defaults to nl when omitted.

consentId
string or null <guid>

The consent identifier for which to retrieve the categorization jobs

userId
string or null <guid>

The user identifier for which to retrieve the categorization jobs

externalUserId
string or null

The external user identifier for which to retrieve the categorization jobs

accountIds
Array of strings or null <guid> [ items <guid > ]

The account ids used for categorization

object or null

Dynamic metadata used for categorization-jobs
Use the EnableNow documentation site to determine which metadata is required for each engine/ profile.

Responses

Request samples

Content type
application/json
{
  • "engine": "string",
  • "profile": "string",
  • "countryCode": "string",
  • "consentId": "string",
  • "userId": "string",
  • "externalUserId": "string",
  • "accountIds": [
    ],
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "data": "string"
}

GET categorization-job by id

Authorizations:
bearer
path Parameters
id
required
string <guid>

The categorization-job identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

categorization-feedback

Submit categorization feedback

Submits a corrected category and the full transaction snapshot for review.

Authorizations:
bearer
Request Body schema: application/json
required
engine
required
string non-empty
countryCode
required
string = 2 characters
profile
required
string [ 0 .. 64 ] characters
transactionId
string or null <guid>
accountId
string or null <guid>
amount
required
number <decimal>
currency
required
string [ 0 .. 3 ] characters
description
required
string or null [ 0 .. 4096 ] characters
counterpartDescription
required
string or null [ 0 .. 4096 ] characters
counterpartAccountNumber
required
string or null [ 0 .. 128 ] characters
providerKey
required
string [ 0 .. 128 ] characters
transactionType
string or null [ 0 .. 128 ] characters
transactionTypeName
string or null [ 0 .. 256 ] characters
reasonCode
string or null [ 0 .. 64 ] characters
purposeCode
string or null [ 0 .. 64 ] characters
originalCategory
string or null [ 0 .. 256 ] characters
originalFlags
Array of strings <= 3 items
targetCategory
required
string [ 0 .. 256 ] characters
targetFlags
Array of strings <= 3 items
remark
string or null [ 0 .. 2048 ] characters

Responses

Request samples

Content type
application/json
{
  • "engine": "string",
  • "countryCode": "st",
  • "profile": "string",
  • "transactionId": "string",
  • "accountId": "string",
  • "amount": 0,
  • "currency": "str",
  • "description": "string",
  • "counterpartDescription": "string",
  • "counterpartAccountNumber": "string",
  • "providerKey": "string",
  • "transactionType": "string",
  • "transactionTypeName": "string",
  • "reasonCode": "string",
  • "purposeCode": "string",
  • "originalCategory": "string",
  • "originalFlags": [
    ],
  • "targetCategory": "string",
  • "targetFlags": [
    ],
  • "remark": "string"
}