Skip to main content

Introduction

The E1 Engine produces a financial profile from a set of transactions within a retail or corporate profile. It is the recommended analysis engine for new integrations and builds on the same AI driven categorization output that the E1 categorization engine produces.

info

An analysis request necessarily triggers a categorization execution as well. Categorization is the foundation for every analysis step and calculation, so each transaction is categorized first and the resulting categories, confidence scores and flags feed the analysis sections.

Available E1 profiles​

Use the data below in the API requests of analysis-v1 to start an analysis-job with a specific E1 profile.

Engine Key
Profile Key
Country Code
Metadata
e1
retail
nl
Optional
e1
corporate
nl
Optional
e1
retail
be
Optional
e1
corporate
be
Optional

Country code​

countryCode selects which country model the analysis runs against. It is accepted only when engine is e1; supplying it for any other engine returns a validation error.

  • Supported values are nl and be.
  • If countryCode is omitted, EnableNow defaults it to nl.
  • The category and flag taxonomies are identical for every supported country, so only the underlying model differs.

Metadata​

You can add metadata to provide extra information to the analysis engine. For E1, all metadata fields are optional in both profiles.

Key
Type
Required
Description
kvk_number
String
No
8 digit Chamber of Commerce number. Supply it for corporate customers, and for retail customers that operate as a ZZP or VOF. When it is omitted, the companyInfo section of the response is null.
internal_ibans
Array of string
No
A list of IBAN numbers that the analysis engine should treat and classify as internal transactions, such as transfers between own accounts.
navigator_assigned_users
Array of assigned user objects
No
An array containing a list of objects to allow specific access to this analysis from the Navigator.

Example​

// POST /analysis-jobs
{
    "reference" : "Client A Analysis",
    "engine" : "e1",
    "profile" : "retail",
    "countryCode" : "nl",
    "input" : {
      "consentIds" : [ "fb84a3ed-812f-42fb-a5d9-d92fde641dfd" ]
    },
    "metadata" : {
      "kvk_number" : "12345678",
      "internal_ibans": ["NL11ENAB1234567890", "NL99ENAB0987654321"]
    }
}

Notes​

  • e1 supports the retail and corporate profiles.
  • Auto-start always runs with countryCode nl. To analyse with be, create the job explicitly and set countryCode on the request.
  • The categories that appear throughout the analysis response come from the E1 taxonomy. See Analysis for how they are grouped, and the E1 categorization categories page for the full list.