Skip to main content

Introduction

The Z2 Engine is designed to produce financial insights based on a set of transactions and 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 have in mind that a request of an Analysis will necessary trigger the execution of a Categorization as well. Such categorization process is the base to perform all the required analysis steps and calculations which in turn will result in a financial overview in the end.

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
none
z2
corporate
required

Metadata​

Some profiles require specific metadata to ensure that the analysis engine can properly process the transactions given.

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

Corporate profile metadata​

Key
Type
Required
Description
kvk_number
String
Yes
8 digit Chamber of Commerce number
// POST cfa/analysis-jobs
{
    "reference" : "Client A Analysis",
    "engine" : "z2",
    "profile" : "corporate",
    "input" : { 
      "consentIds" : [ "fb84a3ed-812f-42fb-a5d9-d92fde641dfd" ] 
    },
    "metadata" : { 
      "kvk_number" : "12345678"
    }
}