--- title: "Get an income check" method: GET path: "/v2/income-checks/{id}" tags: ["Risk.Income Check"] --- # Get an income check `GET /v2/income-checks/{id}` Gets an income check by id. ## Path parameters - `id` string, required ## Response `200` A successful response. - V2IncomeCheck - `accounts` V2Account[], required — Contains user accounts data. - `accountNumber` string — Account's unique identifier number. - `financialInstitutionName` string — The name of a bank or other financial service providers. - `holderNames` string[] — Names of account holders. Availability of this data depends on the chosen provider. - `iban` string — Account's IBAN identifier. - `id` string, required — Account's internal identifier. - `name` string, required — Account's display name. - `users` V2User[], required — Account users and their associated roles. Availability of this data depends on the chosen provider. - `name` string, required — Account user's name. - `role` string, required — Account user's role. - `appId` string — The identifier of the app that has been created by the client in console and linked to the income check product. - `createdTime` string, date-time — The creation time of the income check. - `engineVersion` string — The version of the engine that generated the income check. - `externalReference` string — An external reference given by the client when creating the income check. - `id` string, required — The internal identifier of the income check. - `identity` Incomechecksv2Identity - `name` string, required — The name of the user. - `ssn` string, required — User's social security number. - `income` V2Income - `primaryIncomeStreamId` string — The id of the primary income stream. - `streams` V2IncomeStream[], required — User's income streams. - `accountId` string — The account number connected to the income stream. - `currencyCode` string — The currency code according to ISO-4217 standard. - `id` string, required — Income stream's (helper) identifier used only in the response. - `occurrences` V2OccurrenceSummary - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `subType` 'SUB_TYPE_UNDETERMINED' | 'SALARY_SUB_TYPE_SALARY' | 'SALARY_SUB_TYPE_GIG' | 'SALARY_SUB_TYPE_BONUS' | 'SALARY_SUB_TYPE_OTHER_SALARY' | 'BENEFITS_SUB_TYPE_ALIMONY' | 'BENEFITS_SUB_TYPE_CHILD_SUPPORT' | 'BENEFITS_SUB_TYPE_UNEMPLOYMENT' | 'BENEFITS_SUB_TYPE_OTHER_BENEFIT' | 'PENSION_SUB_TYPE_PRIVATE' | 'PENSION_SUB_TYPE_STATE' | 'PENSION_SUB_TYPE_OTHER_PENSION' | 'CASH_DEPOSITS_SUB_TYPE_CASH' | 'CASH_DEPOSITS_SUB_TYPE_CHEQUE' | 'CASH_DEPOSITS_SUB_TYPE_OTHER_CASH_DEPOSITS' | 'OTHER_SUB_TYPE_INSURANCE' | 'OTHER_SUB_TYPE_RENTAL' | 'OTHER_SUB_TYPE_EDUCATIONAL_GRANT' | 'OTHER_SUB_TYPE_SECOND_HAND_SALES' | 'OTHER_SUB_TYPE_FINANCIAL' | 'OTHER_SUB_TYPE_EXTERNAL_TRANSFER' | 'OTHER_SUB_TYPE_OTHER' — - SUB_TYPE_UNDETERMINED: Income sub-type was undetermined. - SALARY_SUB_TYPE_SALARY: Income sub-type identified as a salary, regular salary from an employer. - SALARY_SUB_TYPE_GIG: Income sub-type identified as a gig, irregular salary from gig employment. Often smaller amounts. - SALARY_SUB_TYPE_BONUS: Income sub-type identified as a bonus, bonus payments that are often larger and less frequent. - SALARY_SUB_TYPE_OTHER_SALARY: Income sub-type identified as other, for example salary payments such as expense reimbursements. - BENEFITS_SUB_TYPE_ALIMONY: Income sub-type identified as alimony, financial support paid to previous spouse. - BENEFITS_SUB_TYPE_CHILD_SUPPORT: Income sub-type identified as a child support, different types of child benefits. - BENEFITS_SUB_TYPE_UNEMPLOYMENT: Income sub-type identified as unemployment, unable to work benefits. - BENEFITS_SUB_TYPE_OTHER_BENEFIT: Income sub-type identified as other, any other benefit not included in the previous sub-types. - PENSION_SUB_TYPE_PRIVATE: Income sub-type identified as a pension that is paid from the employer. - PENSION_SUB_TYPE_STATE: Income sub-type identified as a pension that is paid from the state. - PENSION_SUB_TYPE_OTHER_PENSION: Income sub-type identified as other, any other pension not included in the previous sub-types. - CASH_DEPOSITS_SUB_TYPE_CASH: Income sub-type identified as cash deposits. - CASH_DEPOSITS_SUB_TYPE_CHEQUE: Income sub-type identified as a cheque deposits. - CASH_DEPOSITS_SUB_TYPE_OTHER_CASH_DEPOSITS: Income sub-type identified as a other, any other cash deposits not included in the previous sub-types. - OTHER_SUB_TYPE_INSURANCE: Income sub-type identified as insurance. - OTHER_SUB_TYPE_RENTAL: Income sub-type identified as a rental income. - OTHER_SUB_TYPE_EDUCATIONAL_GRANT: Income sub-type identified as educational grants. - OTHER_SUB_TYPE_SECOND_HAND_SALES: Income sub-type identified as a second hand sale, external transfers related to 2nd hand sales. - OTHER_SUB_TYPE_FINANCIAL: Income sub-type identified as a financial, different types of dividends, savings or investment income that meet regulatory rules. - OTHER_SUB_TYPE_EXTERNAL_TRANSFER: Income sub-type identified as a external transfer, regular third party transfers and standing orders that are not 1st party transfers. - OTHER_SUB_TYPE_OTHER: Income sub-type identified as other, any other type of regular income that does not fall into the other categories. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastThreeMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastTwelveMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastThreeMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastTwelveMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `transactions` V2Transaction[], required — The list of transactions in the stream. - `accountId` string — Account's internal identifier. - `amount` TypeCurrencyDenominatedAmount, required — The amount with regard to currency and its value should be accurately represent the monetary amount. - `currencyCode` string — The currency code which follows ISO-4217 standard. - `value` TypeExactNumber — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `description` string, required — Transaction's description. - `id` string, required — Transaction's internal identifier. - `time` string, date-time, required — Transaction's timestamp. - `type` 'OTHER' | 'SALARY' | 'PENSION' | 'BENEFITS' | 'CASH_DEPOSITS', required — - OTHER: Income that does not fall into any specific type. - SALARY: Income identified as a salary. - PENSION: Income identified as a pension. - BENEFITS: Income identified as a benefit. - CASH_DEPOSITS: Income identified as a cash deposit. - `summary` V2IncomeSummary, required - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastThreeMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastTwelveMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastThreeMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `lastTwelveMonths` V2AmountSummary - `max` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `mean` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `median` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `min` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `total` TypeExactNumber, required — ExactNumber to use representation, which is used in `BigDecimal`. A value of `12.13` with `unscaledValue = 1213` and `scale = 2`. We can later use `doubleValue = Math.pow(10, -scale) * unscaledValue` to get exact number. - `scale` string, int64 — The scale of the numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `unscaledValue` string, int64 — The unscaled numeric value. `unscaledValue` is used with `scale` to accurately represent floating point values. The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0. - `summaryByTypes` V2SummaryByTypes - `benefits` V2TypeSummary - `accountIds` string[] — The internal account IDs of the user that an income stream was detected for. - `currencyCode` string — Currency code. - `occurrences` V2OccurrenceSummary, required - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `streamIds` string[] — The IDs of the identified income streams for this type. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `summaryBySubTypes` V2SummaryBySubTypes - `benefitsSubTypeAlimony` V2SubTypeSummary - … - `benefitsSubTypeChildSupport` V2SubTypeSummary - … - `benefitsSubTypeOtherBenefit` V2SubTypeSummary - … - `benefitsSubTypeUnemployment` V2SubTypeSummary - … - `cashDepositsSubTypeCash` V2SubTypeSummary - … - `cashDepositsSubTypeCheque` V2SubTypeSummary - … - `cashDepositsSubTypeOtherCashDeposits` V2SubTypeSummary - … - `otherSubTypeEducationalGrant` V2SubTypeSummary - … - `otherSubTypeExternalTransfer` V2SubTypeSummary - … - `otherSubTypeFinancial` V2SubTypeSummary - … - `otherSubTypeInsurance` V2SubTypeSummary - … - `otherSubTypeOther` V2SubTypeSummary - … - `otherSubTypeRental` V2SubTypeSummary - … - `otherSubTypeSecondHandSales` V2SubTypeSummary - … - `pensionSubTypeOtherPension` V2SubTypeSummary - … - `pensionSubTypePrivate` V2SubTypeSummary - … - `pensionSubTypeState` V2SubTypeSummary - … - `salarySubTypeBonus` V2SubTypeSummary - … - `salarySubTypeGig` V2SubTypeSummary - … - `salarySubTypeOtherSalary` V2SubTypeSummary - … - `salarySubTypeSalary` V2SubTypeSummary - … - `subTypeUndetermined` V2SubTypeSummary - … - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `cashDeposits` V2TypeSummary - `accountIds` string[] — The internal account IDs of the user that an income stream was detected for. - `currencyCode` string — Currency code. - `occurrences` V2OccurrenceSummary, required - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `streamIds` string[] — The IDs of the identified income streams for this type. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `summaryBySubTypes` V2SummaryBySubTypes - `benefitsSubTypeAlimony` V2SubTypeSummary - … - `benefitsSubTypeChildSupport` V2SubTypeSummary - … - `benefitsSubTypeOtherBenefit` V2SubTypeSummary - … - `benefitsSubTypeUnemployment` V2SubTypeSummary - … - `cashDepositsSubTypeCash` V2SubTypeSummary - … - `cashDepositsSubTypeCheque` V2SubTypeSummary - … - `cashDepositsSubTypeOtherCashDeposits` V2SubTypeSummary - … - `otherSubTypeEducationalGrant` V2SubTypeSummary - … - `otherSubTypeExternalTransfer` V2SubTypeSummary - … - `otherSubTypeFinancial` V2SubTypeSummary - … - `otherSubTypeInsurance` V2SubTypeSummary - … - `otherSubTypeOther` V2SubTypeSummary - … - `otherSubTypeRental` V2SubTypeSummary - … - `otherSubTypeSecondHandSales` V2SubTypeSummary - … - `pensionSubTypeOtherPension` V2SubTypeSummary - … - `pensionSubTypePrivate` V2SubTypeSummary - … - `pensionSubTypeState` V2SubTypeSummary - … - `salarySubTypeBonus` V2SubTypeSummary - … - `salarySubTypeGig` V2SubTypeSummary - … - `salarySubTypeOtherSalary` V2SubTypeSummary - … - `salarySubTypeSalary` V2SubTypeSummary - … - `subTypeUndetermined` V2SubTypeSummary - … - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `other` V2TypeSummary - `accountIds` string[] — The internal account IDs of the user that an income stream was detected for. - `currencyCode` string — Currency code. - `occurrences` V2OccurrenceSummary, required - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `streamIds` string[] — The IDs of the identified income streams for this type. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `summaryBySubTypes` V2SummaryBySubTypes - `benefitsSubTypeAlimony` V2SubTypeSummary - … - `benefitsSubTypeChildSupport` V2SubTypeSummary - … - `benefitsSubTypeOtherBenefit` V2SubTypeSummary - … - `benefitsSubTypeUnemployment` V2SubTypeSummary - … - `cashDepositsSubTypeCash` V2SubTypeSummary - … - `cashDepositsSubTypeCheque` V2SubTypeSummary - … - `cashDepositsSubTypeOtherCashDeposits` V2SubTypeSummary - … - `otherSubTypeEducationalGrant` V2SubTypeSummary - … - `otherSubTypeExternalTransfer` V2SubTypeSummary - … - `otherSubTypeFinancial` V2SubTypeSummary - … - `otherSubTypeInsurance` V2SubTypeSummary - … - `otherSubTypeOther` V2SubTypeSummary - … - `otherSubTypeRental` V2SubTypeSummary - … - `otherSubTypeSecondHandSales` V2SubTypeSummary - … - `pensionSubTypeOtherPension` V2SubTypeSummary - … - `pensionSubTypePrivate` V2SubTypeSummary - … - `pensionSubTypeState` V2SubTypeSummary - … - `salarySubTypeBonus` V2SubTypeSummary - … - `salarySubTypeGig` V2SubTypeSummary - … - `salarySubTypeOtherSalary` V2SubTypeSummary - … - `salarySubTypeSalary` V2SubTypeSummary - … - `subTypeUndetermined` V2SubTypeSummary - … - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `pension` V2TypeSummary - `accountIds` string[] — The internal account IDs of the user that an income stream was detected for. - `currencyCode` string — Currency code. - `occurrences` V2OccurrenceSummary, required - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `streamIds` string[] — The IDs of the identified income streams for this type. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `summaryBySubTypes` V2SummaryBySubTypes - `benefitsSubTypeAlimony` V2SubTypeSummary - … - `benefitsSubTypeChildSupport` V2SubTypeSummary - … - `benefitsSubTypeOtherBenefit` V2SubTypeSummary - … - `benefitsSubTypeUnemployment` V2SubTypeSummary - … - `cashDepositsSubTypeCash` V2SubTypeSummary - … - `cashDepositsSubTypeCheque` V2SubTypeSummary - … - `cashDepositsSubTypeOtherCashDeposits` V2SubTypeSummary - … - `otherSubTypeEducationalGrant` V2SubTypeSummary - … - `otherSubTypeExternalTransfer` V2SubTypeSummary - … - `otherSubTypeFinancial` V2SubTypeSummary - … - `otherSubTypeInsurance` V2SubTypeSummary - … - `otherSubTypeOther` V2SubTypeSummary - … - `otherSubTypeRental` V2SubTypeSummary - … - `otherSubTypeSecondHandSales` V2SubTypeSummary - … - `pensionSubTypeOtherPension` V2SubTypeSummary - … - `pensionSubTypePrivate` V2SubTypeSummary - … - `pensionSubTypeState` V2SubTypeSummary - … - `salarySubTypeBonus` V2SubTypeSummary - … - `salarySubTypeGig` V2SubTypeSummary - … - `salarySubTypeOtherSalary` V2SubTypeSummary - … - `salarySubTypeSalary` V2SubTypeSummary - … - `subTypeUndetermined` V2SubTypeSummary - … - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `salary` V2TypeSummary - `accountIds` string[] — The internal account IDs of the user that an income stream was detected for. - `currencyCode` string — Currency code. - `occurrences` V2OccurrenceSummary, required - `count` integer, required — The number of occurrences. - `first` string, required — The date of the first occurrence. - `last` string, required — The date of the last occurrence. - `streamIds` string[] — The IDs of the identified income streams for this type. - `summaryByMonths` V2SummaryByMonths - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `summaryBySubTypes` V2SummaryBySubTypes - `benefitsSubTypeAlimony` V2SubTypeSummary - … - `benefitsSubTypeChildSupport` V2SubTypeSummary - … - `benefitsSubTypeOtherBenefit` V2SubTypeSummary - … - `benefitsSubTypeUnemployment` V2SubTypeSummary - … - `cashDepositsSubTypeCash` V2SubTypeSummary - … - `cashDepositsSubTypeCheque` V2SubTypeSummary - … - `cashDepositsSubTypeOtherCashDeposits` V2SubTypeSummary - … - `otherSubTypeEducationalGrant` V2SubTypeSummary - … - `otherSubTypeExternalTransfer` V2SubTypeSummary - … - `otherSubTypeFinancial` V2SubTypeSummary - … - `otherSubTypeInsurance` V2SubTypeSummary - … - `otherSubTypeOther` V2SubTypeSummary - … - `otherSubTypeRental` V2SubTypeSummary - … - `otherSubTypeSecondHandSales` V2SubTypeSummary - … - `pensionSubTypeOtherPension` V2SubTypeSummary - … - `pensionSubTypePrivate` V2SubTypeSummary - … - `pensionSubTypeState` V2SubTypeSummary - … - `salarySubTypeBonus` V2SubTypeSummary - … - `salarySubTypeGig` V2SubTypeSummary - … - `salarySubTypeOtherSalary` V2SubTypeSummary - … - `salarySubTypeSalary` V2SubTypeSummary - … - `subTypeUndetermined` V2SubTypeSummary - … - `summaryByTransactions` V2SummaryByTransactions - `lastSixMonths` V2AmountSummary - … - `lastThreeMonths` V2AmountSummary - … - `lastTwelveMonths` V2AmountSummary - … - `userId` string — The internal identifier of the user linked to the request. ## Other responses - `400` — The request does not pass validation. This could for example be an invalid id. Check the error message or the documentation of each field for more information. - `401` — Wrong scopes associated with the access token. - `403` — The resource does not belong to subject associated with the access token. - `404` — An income check with the given id was not found. - `default` — An unexpected error response. --- [API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)