---
title: "Get an insights report."
method: GET
path: "/v1/insights/{requestId}"
tags: ["Insights"]
---

# Get an insights report.

`GET /v1/insights/{requestId}`

## Path parameters

- `requestId` string, uuid, required

## Response `200`

Success

- InsightsResponse
  - `id` string, uuid, required
  - `requestStatus` 'PENDING' | 'PROCESSING' | 'PROCESSED' | 'REJECTED', required
  - `rejectReason` string, nullable
  - `report` InsightsResponseDetails
    - `categorisation` Categorisation
      - `accounts` Account[], nullable
        - `accountNumber` string, nullable
        - `bank` string, nullable
        - `country` string, nullable
        - `currencies` Currency[], nullable
          - `code` string, nullable
          - `creditTurnover` number, double, nullable
          - `debitTurnover` number, double, nullable
          - `endBalance` number, double, nullable
          - `startBalance` number, double, nullable
          - `transactions` Transaction[], nullable
            - `amount` number, double, nullable
            - `categoryId` integer
            - `title` string, nullable
            - `date` string, nullable
            - `info` string, nullable
            - `transactionId` string, nullable
            - `partner` string, nullable
        - `holders` AccountHolder[], nullable
          - `name` string, nullable
        - `iban` string, nullable
        - `isJointOwnership` boolean, nullable
        - `isSharedOwnership` boolean, nullable
        - `periodEnd` string, nullable
        - `periodStart` string, nullable
      - `categoryTreeVersion` string, nullable
    - `creditScores` object, nullable
    - `features` object, nullable
    - `insightsDetails` InsightsDetails
      - `currency` InsightsCurrency
        - `displayCurrency` string, nullable
        - `appliedCurrencyConversions` InsightsCurrencyDetails[], nullable
          - `currency` string, nullable
          - `rate` number, double, nullable
    - `insightsIncome` Income
      - `averageDaysBetweenIncomePayments` integer, nullable
      - `averageMonthlyDiscretionaryIncome` number, double, nullable
      - `averageMonthlyIncome` number, double, nullable
      - `calendarMonths` integer, nullable
      - `calendarMonthsWithIncome` integer, nullable
      - `daysSinceLastIncomePayment` integer, nullable
      - `debtToIncomeRatio` number, double, nullable
      - `definitions` Definition
        - `expenses` DefinitionDetails[], nullable
          - `categoryId` string, nullable
          - `title` string, nullable
        - `income` DefinitionDetails[], nullable
          - `categoryId` string, nullable
          - `title` string, nullable
      - `incomeByCategory` object, nullable
      - `lastIncompleteMonth` MonthlyIncome
        - `expectedRemainingIncome` number, double, nullable
        - `month` string, nullable
        - `receivedIncome` number, double, nullable
        - `remainingMonthlyDiscretionaryIncome` number, double, nullable
      - `monthlyRegularity` number, double, nullable
      - `monthlyStability` number, double, nullable
      - `monthlyTrend` number, double, nullable
    - `insightsLoans` Loan
      - `averageMonthlyOutgoingLoanPayment` number, double, nullable
      - `calendarMonths` integer, nullable
      - `calendarMonthsWithIncomingLoans` integer, nullable
      - `calendarMonthsWithOutgoingLoans` integer, nullable
      - `daysSinceLastIncomingLoan` integer, nullable
      - `loansByCategory` LoanDetails[], nullable
        - `averageMonthlyOutgoingLoanPayment` number, double, nullable
        - `categoryId` CategoryId
          - `expense` string, nullable
          - `income` string, nullable
        - `categoryTitle` string, nullable
        - `daysSinceLastIncomingLoan` integer, nullable
        - `monthlyIncomingLoanTrend` number, double, nullable
        - `monthlyOutgoingLoanTrend` number, double, nullable
        - `numberOfIncomingLoanSources` integer, nullable
        - `numberOfOutgoingLoanSources` integer, nullable
        - `ratioOfOutgoingLoanCategoryToLoans` number, double, nullable
      - `monthlyIncomingLoanTrend` number, double, nullable
      - `monthlyOutgoingLoanTrend` number, double, nullable
      - `ratioOfIncomingLoansToAllIncome` number, double, nullable
      - `ratioOfOutgoingLoansToAllExpenses` number, double, nullable
    - `insightsRisk` Risk
      - `alimonyPayments` PaymentDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
      - `bailiffs` PaymentDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
      - `balance` BalanceDetails
        - `calendarMonthEndBalance` number, double, nullable
        - `calendarMonthStartBalance` number, double, nullable
        - `netCashFlow` number, double, nullable
        - `statementEndBalance` number, double, nullable
        - `statementStartBalance` number, double, nullable
      - `cash` CashDetails
        - `averageCountOfCashDepositAMonth` number, double, nullable
        - `averageCountOfCashWithdrawalAMonth` number, double, nullable
        - `averageSumOfCashDepositAMonth` number, double, nullable
        - `averageSumOfCashWithdrawalAMonth` number, double, nullable
        - `cashDepositMonthlyTrend` number, double, nullable
        - `cashDepositToIncome` number, double, nullable
        - `cashWithdrawalMonthlyTrend` number, double, nullable
        - `cashWithdrawalToExpenses` number, double, nullable
        - `cashWithdrawalToIncome` number, double, nullable
        - `stableMonthlyCashDeposits` boolean, nullable
      - `debtCollection` PaymentDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
      - `dishonours` PaymentDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
      - `gambling` GamblingDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
        - `daysSinceLastTransaction` integer, nullable
        - `gamblingToAllExpenses` number, double, nullable
        - `monthlyRegularityOfGambling` number, double, nullable
        - `ratioOfCasino` number, double, nullable
        - `ratioOfLottery` number, double, nullable
        - `ratioOfSportsBetting` number, double, nullable
      - `loanFines` PaymentDetails
        - `averageCountAMonth` number, double, nullable
        - `averageSumAMonth` number, double, nullable
    - `kyc` KycDetails[], nullable
      - `address` string, nullable
      - `bank` string, nullable
      - `dateOfBirth` string, nullable
      - `emailAddress` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `fullName` string, nullable
      - `iban` string, nullable
      - `personIdentification` PersonIdentification[], nullable
        - `_type` string, nullable
        - `id` string, nullable
      - `phoneNumber` string, nullable
    - `observations` object, nullable
    - `marketing` Marketing
      - `segments` Segments
        - `hasChildren` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `hasCar` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `hasHouse` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `hasPets` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `hasLifeInsurance` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `isDigital` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInClothing` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInSports` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInTraveling` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInBeauty` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInCulture` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
        - `interestedInGambling` Segment
          - `triggered` boolean, nullable
          - `details` string, nullable
    - `simpleScore` integer, nullable
    - `metadata` Metadata
      - `statementDetails` StatementDetails
        - `countOfAnalysedAccounts` integer, nullable
        - `countOfUploadedAccounts` integer, nullable
        - `dropJointAccounts` boolean, nullable
        - `dropSharedAccounts` boolean, nullable
      - `insightsDetails` InsightsDetails
        - `currency` InsightsCurrency
          - `displayCurrency` string, nullable
          - `appliedCurrencyConversions` InsightsCurrencyDetails[], nullable
            - `currency` string, nullable
            - `rate` number, double, nullable

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Server Error
- `503` — Server Error

---

[API](https://skmtc.net/finshark/apis/finshark-api.md) · [All operations](https://skmtc.net/finshark/apis/finshark-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finshark/finshark-api/versions/7fc3b4f800ae/schema)