---
title: "Paginate all analyses"
method: GET
path: "/wallet"
tags: ["Wallet Analyses"]
---

# Paginate all analyses

`GET /wallet`

## Request

- Base URL: `https://aml-api.elliptic.co/v2`
- URL: `https://aml-api.elliptic.co/v2/wallet`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-access-key` and API key in header `x-access-sign` and API key in header `x-access-timestamp`

Paginate through all analyses, with various sort/filter parameters.

## Query parameters

- `min_outflow_usd` number, float
- `max_outflow_usd` number, float
- `min_inflow_usd` number, float
- `max_inflow_usd` number, float
- `analysed_at_before` string, date-time
- `analysed_at_after` string, date-time
- `customer_reference_contains` string
- `address_hash_contains` string
- `customer_reference` string
- `workflow_status` string[]: Array of workflow status values for filtering analyses. "archived" is deprecated and you should use "closed" instead.
- `address_hash` string
- `entity_name_contains` string
- `entity_category_contains` string
- `min_risk_score` number, float
- `max_risk_score` number, float
- `min_risk_score_change` number, float
- `max_risk_score_change` number, float
- `coverage` string[]
- `process_status` string[]
- `asset` string[]
- `risk_rules` string[]
- `analysed_by` string, UUIDv4
- `customer_id` string, UUIDv4
- `assigned_team_user_id` string[]
- `screening_source` string[]
- `sort` 'entity_name' | '-entity_name' | 'entity_category' | '-entity_category' | 'outflow_usd' | '-outflow_usd' | 'inflow_usd' | '-inflow_usd' | 'asset' | '-asset' | 'customer_reference' | '-customer_reference' | 'analysed_at' | '-analysed_at' | 'risk_score' | '-risk_score' | 'workflow_status' | '-workflow_status'
- `page` integer
- `per_page` number
- `limit` number

## Response `200`

Successful wallet analysis response

- object: Paginated array of wallet analyses
  - `page` number, required
  - `per_page` number, required
  - `total_pages` number, required
  - `total_items` number, required
  - `items` object[], required: array of analyses
    - `id` string, UUIDv4, required
    - `type` 'wallet_exposure', required: The type of analysis. Currently it is wallet_exposure
    - `subject` object, required: Information describing the subject of the analysis
      - `asset` string, required: The asset involved in the event
      - `type` string, required: The type of subject. Currently, only 'address' is supported
      - `hash` string, required: The address hash when using type 'address'
      - `blockchain` string: The blockchain the asset/address belongs to (optional)
    - `customer` object, required
      - `id` string, UUIDv4: the UUIDv4 of the customer this analysis is associated with
      - `reference` string: the string reference that has been given to this customer
    - `blockchain_info` object, required: The relevant blockchain data related to the subject's hash
      - `cluster` object
        - `inflow_value` object: value of cluster's inflowing funds
          - `usd` number, nullable: Transaction amount expressed in US dollars of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
        - `outflow_value` object: value of cluster's outflowing funds
          - `usd` number, nullable
    - `created_at` string, date-time, required: ISO date time with time zone (UTC) of when the analysis was first analysed
    - `updated_at` string, date-time, required: ISO date time with time zone (UTC) of when the wallet analysis was last updated
    - `analysed_by` object: the actor who requested the analysis
      - `id` string, UUIDv4: the actor id
    - `analysed_at` string, date-time, required: ISO date time with time zone (UTC) of when this analysis was completed
    - `cluster_entities` WalletAssertedLabel[], required: An Elliptic-created, wallet asserted label to be attached to a cluster
      - `name` string, nullable, required: A real-world description of the labelled cluster, derived from the assertions associated to this label.
      - `category` string, nullable, required: A categorical description of the real-world entity controlling the labelled cluster
      - `category_id` string, uuid: UUID identifier of the category
      - `entity_id` string, uuid: UUIDv4 identifier of the entity
      - `actor_id` integer: Internal numeric ID of the actor
      - `is_primary_entity` boolean, required: A flag that shows if the entity is primary or not. Only one in the whole array of labels
      - `is_vasp` boolean, nullable: True if this entity is a Virtual Asset Service Provider, false if not, null if unknown
      - `is_after_sanction_date` boolean, nullable: True if the entity’s activity or transaction occurred after the date it was officially sanctioned, enabling accurate time-bound sanction screening
    - `asset_tier` 'full' | 'sanctions': The asset tier
    - `process_status` 'running' | 'complete' | 'error', required: the process status ('running','complete','error')
    - `process_status_id` 1 | 2 | 3: The screening process status. - A 1 number means the process status is running. - A 2 number means the process status is completed. - A 3 indicates the process status has an error.
    - `team_id` string, UUIDv4, required: UUIDv4 identifier of the team the user belongs to
    - `triggered_rules` object[], required
      - `rule_id` string, UUIDv4
      - `rule_name` string
      - `risk_score` number, float, nullable
    - `risk_score` number, float, nullable: the overall risk score we will show to the user
    - `error` object, nullable: Property containing information about a failed screening, null unless process_status = 'error'
      - `message` string: error message
    - `workflow_status` WorkflowStatus, required (unresolved $ref)
    - `workflow_status_id` WorkflowStatusId (unresolved $ref)
    - `assigned_team_user_id` string, UUIDv4: id of the team user assigned to this analysis
    - `changes` object: Changes compared to previous screening of analysis
      - `risk_score_change` number, float: Change in risk score compared to previous screening of analysis. - A positive number means the risk score has increased compared to the previous screening. - A negative number means the risk score has decreased compared to the previous screening. - A 0 indicates no change in risk score compared to the previous screening.
    - `screening_source` 'sync' | 'async' | 'system_rescreen' | 'automatic_rescreen' | 'continuous_monitoring': Indicates whether the screening was done via the Synchronous endpoint, Asynchronous endpoint, as part of the Automatic Rescreening feature or as a fallback system rescreening in case of error

## Other responses

- `400`: Bad Request
- `401`: Not authenticated
- `403`: Not authorized
- `404`: Resource item not found
- `500`: Server Error

---

[API](https://skmtc.dev/elliptic/apis/aml-api-v2.md) - [All operations](https://skmtc.dev/elliptic/apis/aml-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/elliptic/apis/aml-api-v2/revisions/e0bcbfe65e14?raw)