Skip to main content

Introduction

The Z2 Engine is designed to produce financial insights based on a set of transactions within a retail or corporate profile. It provides an additional layer of information on top of the categorization data which can be used to better understand the financial profile of your customers.

info

Please note that an Analysis request will necessarily trigger a Categorization execution as well. The categorization process is the foundation for performing all required analysis steps and calculations, which will result in a comprehensive financial overview.

Available Z2 profiles​

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

Engine Key
Profile Key
Metadata
z2
retail
Optional
z2
corporate
Required

Metadata​

You can add metadata to add extra information to the analysis engine to properly process the transactions given.

Below, you will find a brief explanation of the fields that can be provided as metadata when creating an analysis job:

Key
Type
Required
Description
kvk_number
String
Only in corporate profile
8 digit Chamber of Commerce number
internal_ibans
Array of string
No
A list of IBAN numbers that the analysis engine should treat and classify as internal transactions (e.g., transfers between own accounts).
// POST cfa/analysis-jobs
{
    "reference" : "Client A Analysis",
    "engine" : "z2",
    "profile" : "corporate",
    "input" : { 
      "consentIds" : [ "fb84a3ed-812f-42fb-a5d9-d92fde641dfd" ] 
    },
    "metadata" : { 
      "kvk_number" : "12345678",
      "internal_ibans": ["NL11ENAB1234567890", "NL99ENAB0987654321"]
    }
}