Skip to main content

Data structure

The Analysis object is a structured representation of the financial profile that was produced. E1 populates the sections shown in the first table below, each of which is described in more detail in the tables thereafter.

Property
Type
Description
generalInfo
GeneralInfo or null
Period, balances and totals across all analysed accounts.
companyInfo
CompanyInfo or null
Chamber of Commerce details. Only populated when kvk_number metadata is supplied.
topCounterparties
The five largest inflow and outflow counterparties.
clientProfile
array of ProfileEntry
Category groupings that characterise the customer. The set of groupings differs per profile.
flaggedTransactions
array of ProfileEntry
Transactions grouped by the flags the engine assigned.
lowConfidenceTransactions
array of ProfileEntry
Transactions grouped into confidence bands, for transactions the model was less certain about.
otherHighlightedTransactions
array of ProfileEntry
Transactions singled out by heuristics rather than by category or flag.
creditQualityMetrics
array of DriverEntry
Reserved for future use. E1 currently always returns an empty array.
info

Every grouped section — clientProfile, flaggedTransactions, lowConfidenceTransactions and otherHighlightedTransactions — uses the same ProfileEntry shape. Entries are always present even when they contain no transactions, so a grouping with transactionCount 0 means the grouping was evaluated and nothing matched.

GeneralInfo

Property
Type
Description
startDate
Date
Date of the earliest transaction in the analysis.
endDate
Date
Date of the latest transaction in the analysis.
startBalance
Decimal
Combined balance across the analysed accounts at the start of the period.
endBalance
Decimal
Combined balance across the analysed accounts at the end of the period.
accounts
The accounts included in the analysis.
totalInflow
Decimal
Sum of all positive transaction amounts.
totalOutflow
Decimal
Sum of all negative transaction amounts, expressed as a positive number.

AccountSummary

Property
Type
Description
iban
String or null
IBAN of the account.
accountName
String or null
Account holder name as supplied by the provider.
accountId
Guid
EnableNow identifier of the account.

CompanyInfo

Only populated when kvk_number is supplied as metadata. Every field other than kvkNumber is nullable, since availability depends on what the Chamber of Commerce lookup returns.

Property
Type
Description
kvkNumber
String
8 digit Chamber of Commerce number that was supplied.
name
String or null
Registered company name.
address
String or null
Registered address.
industryCode
String or null
Industry classification code.
industryDescription
String or null
Human readable description of the industry classification.
legalForm
String or null
Legal form of the company.
numberOfEmployees
Integer or null
Registered number of employees.
startDate
DateTime or null
Date the company started trading.
registrationDate
DateTime or null
Date the company was registered.

TopCounterparties

Both inflow and outflow are objects keyed by rank as a string — "0" through "4" — where "0" is the largest. Each value is a ProfileEntry whose name is the counterparty name, or Unknown when the counterparty could not be determined.

Ranking is by total amount, not transaction count: inflow ranks counterparties by the sum of positive amounts, outflow by the sum of negative amounts. At most five entries appear in each; fewer are returned when the analysis contains fewer distinct counterparties.

Property
Type
Description
inflow
object of ProfileEntry
Up to five counterparties that money was received from.
outflow
object of ProfileEntry
Up to five counterparties that money was paid to.

ProfileEntry

Property
Type
Description
name
String
Name of the grouping, such as a client profile bucket, a flag label or a counterparty name.
transactionCount
Integer
Number of transactions in this grouping.
totalInflow
Decimal
Sum of the positive amounts in this grouping.
totalOutflow
Decimal
Sum of the negative amounts in this grouping, expressed as a positive number.
categories
array of String
Distinct E1 categories seen in this grouping.
transactionIds
array of Guid
Identifiers of the transactions in this grouping, so they can be traced back to items.

DriverEntry

Returned only in creditQualityMetrics, which E1 currently always leaves empty. The shape is documented here for completeness.

Property
Type
Description
driver
String
Name of the metric.
value
Integer or null
Value of the metric.
percentile
Double or null
Percentile the value falls into.

Transaction level output

The analysis job response does not embed the per transaction categorization. It carries the aggregated analysis payload only; each grouping exposes transactionIds so the underlying transactions can be looked up.

To retrieve the category, confidence score and flags for an individual transaction, use the transactions endpoints and read the e1 object on each transaction. That structure is documented on the E1 categorization data structure page.