Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Risk.Risk Insights

Get a Risk Insights

Get a risk insights report of a user.

get/risk/v1/risk-insights/{id}

Path parameters

idstring required

The identifier of the risk insights report.

Response

A successful response.

createdTimestring date-time required

The creation time of the risk insights report triggered by the specific TinkLink session and the following creation of the report.

currencyCodestring required

The currency code which follows ISO-4217 standard.

dataAvailabilityV1DataAvailability[] required

A list of DataAvailability periods that correspond to the transaction history of the end user. The presence of a period in DataAvailability suggests complete data, implying a 0 value indicates no transactions and the 0 can be computed. Absence from this list suggests the 0 is due to insufficient data and a 0 would represent a calculation of “n.a.“.

externalReferencestring

An external reference given by the client when creating the risk insights report.

highBalancesobject required

Features detailing how many days during a given period the end-user has had a balance (see balances for more information) above a certain threshold (different per market) in terms of the total end-of-day balance summed across all accounts.

idstring required

The reference identifier of the Risk Insights report.

lowBalancesobject required

The number of days the end-user has transactions that results in a balance (see balances for more information) lower than a set amount (market dependent) in terms of the total end-of-day balance summed across all accounts.

userIdstring

The internal identifier of the user linked to the request.

Example response

{
  "createdTime": "2022-01-24T14:39:42.814204Z",
  "currencyCode": "SEK",
  "dataAvailability": [
    "ONE_WEEK",
    "ONE_MONTH"
  ],
  "externalReference": "ext-abc-123",
  "highBalances": {
    "daysBalanceAbove1000OneMonth": 30,
    "daysBalanceAbove1000OneWeek": 7,
    "daysBalanceAbove1000SixMonths": 180,
    "daysBalanceAbove1000ThreeMonths": 90,
    "daysBalanceAbove1000Total": 250,
    "daysBalanceAbove1000TwelveMonths": 250
  },
  "id": "60078e3872624db6b3fc57a9c10f75d7",
  "lowBalances": {
    "daysBalanceBelow0OneMonth": 0,
    "daysBalanceBelow0OneWeek": 0,
    "daysBalanceBelow0SixMonths": 0,
    "daysBalanceBelow0ThreeMonths": 0,
    "daysBalanceBelow0Total": 150,
    "daysBalanceBelow0TwelveMonths": 115,
    "daysBalanceBelow7OneMonth": 0,
    "daysBalanceBelow7OneWeek": 0,
    "daysBalanceBelow7SixMonths": 0,
    "daysBalanceBelow7ThreeMonths": 0,
    "daysBalanceBelow7Total": 150,
    "daysBalanceBelow7TwelveMonths": 115
  },
  "userId": "8de8c352022e4dda94137ad7fb75e3d2"
}