---
title: "Get artifact"
method: GET
path: "/artifacts/{artifact-id}"
tags: ["Artifacts"]
---

# Get artifact

`GET /artifacts/{artifact-id}`

Get the artifact by the given ID and artifact type.

## Path parameters

- `artifact-id` string, uuid, required

## Query parameters

- `artifact_type` 'risk-report' | 'income-report' | 'accounts' | 'transactions' | 'user-insights', required

## Response `200`

Artifact details

- object
  - `id` string, UUID, required — Internal artifact ID
  - `created_at` EndedAt, required — unresolved $ref
  - `type` 'risk-report' | 'income-report' | 'accounts' | 'transactions' | 'user-insights', required
  - `raw_result` union, required
    - object — Risk report aggregation.
      - `timespan` object, required — The interval of time when transactions are recorded
        - `start` string, date — The time from the transactions are recorded
        - `end` string, date — The time until the transactions are recorded
      - `accounts` object[], required — Provides account-specific risk reports. The first entry in the list will be the main account, which is identified as the account associated with the primary income source, if such an account exists.
        - `id` integer, required — ID of the account
        - `iban` Iban, required — unresolved $ref
        - `name` string, required — Name of the account.
        - `currency` Currency, required — unresolved $ref
        - `running_balance` object, required — Running balance
          - `average_30_days` number, float — Average balance over 30 days
          - `average_90_days` number, float — Average balance over 90 days
          - `average_180_days` number, float — Average balance over 180 days
          - `days_in_overdraft` integer — Number of days the balance was negative
        - `type` Items, required — unresolved $ref
        - `is_main_account` boolean, required — Indicates whether the account is a primary income source (primary income was detected on this account)
        - `owners` string[], required — List of names of all the account holders.
        - `last_transaction_on` Schema, required — unresolved $ref
        - `provided_name` string, required — Name provided by the user to be checked against the account-holder names.
      - `income` object, required — Income report
        - `overall` Income, required — unresolved $ref
        - `regular` Income, required — unresolved $ref
        - `variable` Income, required — unresolved $ref
        - `risk_indicators` object, required — This section includes aggregated data on potentially risky income transactions, categorized into sub-categories such as Chargeback, Gambling, Lottery, and Refund.
          - `overall` Income, required — unresolved $ref
          - `chargeback` Income, required — unresolved $ref
          - `gambling` Income, required — unresolved $ref
          - `lottery` Income, required — unresolved $ref
          - `refund` Income, required — unresolved $ref
      - `expenses` object, required — Expenses report
        - `overall` 0, required — unresolved $ref
        - `regular` 0, required — unresolved $ref
        - `variable` 0, required — unresolved $ref
        - `risk_indicators` object, required — This section includes aggregated data on potentially risky expenses, categorized into sub-categories such as ATM, Gambling, Debt collection, and Loan.
          - `overall` 0, required — unresolved $ref
          - `atm` 0, required — unresolved $ref
          - `debt_collection` 0, required — unresolved $ref
          - `gambling` 0, required — unresolved $ref
          - `loan` 0, required — unresolved $ref
    - object — Income report aggregation
      - `timespan` Timespan — unresolved $ref
      - `income` object — The income streams and their summaries
        - `summary` object, required
          - `count` integer, required — Number of transactions in this income / expense stream
          - `total` number, float, required — Total amount of money in transactions
          - `min` number, float, required — Lowest amount between transactions
          - `max` number, float, required — Highest amount between transactions
          - `average` number, float, required — Average amount between transactions
          - `ratio` number, float, required — Ratio
        - `primary` Items, required — unresolved $ref
      - `regular_expenses` 0 — unresolved $ref
      - `variable_expenses` 0 — unresolved $ref
      - `disposable_income` Summary — unresolved $ref
      - `discretionary_income` Summary — unresolved $ref
    - object — User insights report. It collects several flags as part of the relevant information about the user.
      - `is_renting` boolean, required — Indicates if the user is renting
      - `is_real_estate_financing` boolean, required — Indicates if the user is real estate financing
      - `owns_vehicle` boolean, required — Whether the user owns a vehicle or not
      - `has_children` boolean, required — Whether the user has children or not
      - `has_depot_account` boolean, required — Whether the user has a depot account or not
      - `connected_primary_account` boolean, required — Whether the user has a primary account connected
      - `uses_mobility_service` string, required — The mobility service used
      - `uses_credit_card_provider` string, required — The credit card provider used
      - `average_salary` Amount, required — unresolved $ref
      - `average_rent` Amount, required — unresolved $ref
      - `cash_withdrawals` integer, required — Total amount from cash withdrawals
      - `insurances` object[], required
        - `kind` 'ACCIDENT' | 'CAR' | 'DEATH' | 'HEALTH' | 'HOUSEHOLD' | 'LEGAL_PROTECTION' | 'LIABILITY' | 'LIFE' | 'MOBILE_PHONE' | 'NURSING_CARE' | 'OCCUPATIONAL_DISABILITY' | 'PENSION' | 'PROPERTY' | 'SAVINGS' | 'TRAVEL' | 'UNKNOWN' — Insurance kind
        - `provider` string — Insurance provider
    - Schema[] — unresolved $ref
    - Schema[] — unresolved $ref
  - `meta` object, required — A dictionary which contains metadata of the artifact. It usually contains the user ID which triggered the flow that generated the artifact.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `404` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)