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

# Paginate all analyses

`GET /analyses`

## Request

- Base URL: `https://aml-api.elliptic.co/v2`
- URL: `https://aml-api.elliptic.co/v2/analyses`
- 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

- `expand` string[]
- `tx_time_before` string, date-time
- `tx_time_after` string, date-time
- `has_triggered_rule` boolean
- `min_risk_score` number, float
- `max_risk_score` number, float
- `min_risk_score_change` number, float
- `max_risk_score_change` number, float
- `min_value` integer
- `max_value` integer
- `min_value_usd` number, float
- `max_value_usd` number, float
- `analysed_at_before` string, date-time
- `analysed_at_after` string, date-time
- `customer_reference` string
- `customer_reference_contains` string
- `workflow_status` Schema (unresolved $ref)
- `hash` string
- `hash_contains` string
- `address_hash` string
- `address_hash_contains` string
- `id` string[]
- `coverage` string[]
- `analysed_by` string, UUIDv4
- `customer_id` string, UUIDv4
- `assigned_team_user_id` string[]
- `process_status` string[]
- `risk_rules` string[]
- `type` 'deposit' | 'withdrawal'
- `user_supplied_base58` boolean
- `asset` string[]
- `screening_source` string[]
- `sort` 'created_at' | '-created_at' | 'customer_reference' | '-customer_reference' | 'type' | '-type' | 'tx_hash' | '-tx_hash' | 'address_hash' | '-address_hash' | 'analysed_at' | '-analysed_at' | 'tx_time' | '-tx_time' | 'risk_score' | '-risk_score' | 'value' | '-value' | 'value_usd' | '-value_usd' | 'user_supplied_base58' | '-user_supplied_base58' | 'asset' | '-asset' | 'workflow_status' | '-workflow_status' | 'predictive' | '-predictive'
- `page` integer
- `per_page` number
- `subject_type` 'transaction' | 'address'
- `predictive` boolean
- `limit` number

## Response `200`

Successful transaction analysis response

- object: Paginated array of analyses response
  - `page` number, required
  - `per_page` number, required
  - `total_pages` number, required
  - `total_items` number, required
  - `items` object[], required
    - `id` string, UUIDv4, required
    - `type` 'source_of_funds' | 'destination_of_funds', required: The type of analysis. The source_of_funds type is used to get details of the entities that have contributed funds to the transaction's source address, and calculate a risk score based on this exposure. This is referred to as "Deposit" in Navigator. The destination_of_funds type is used to get details of the entities that have received funds from the transaction's destination address, and calculate a risk score based on this exposure. This is referred to as "Withdrawal" in Navigator.
    - `subject` AnalysisSubject, required
      - `asset` string, required: the asset involved in the event.
      - `blockchain` string: The blockchain the asset/address belongs to (optional)
      - `type` string, required: the type of subject. Currently, only 'transaction' is supported
      - `hash` string, required: the transaction hash
      - `output_type` 'address' | 'indices': which output type you are using to specify the output(s) you wish to analyse (BTC/LTC/BCH only)
      - `output_address` string: the address hash when using output_type address
      - `output_indices` number[]: the indices of outputs to be analysed when using output_type indices
      - `log_index` number: the log index of an ERC20 transacation
    - `analysed_by` string, UUIDv4, required: UUIDv4 identifier of the actor who requested the analysis
    - `analysed_at` string, date-time, required: the timestamp of when this analysis was completed
    - `team_id` string, UUIDv4: UUIDv4 identifier of the team the user belongs to
    - `workflow_status` WorkflowStatus, required (unresolved $ref)
    - `assigned_team_user_id` string, UUIDv4: id of the team user assigned to this analysis
    - `risk_score` number, float, nullable: The risk score calculated as an aggregation from all the rules. If null is returned, no risk rules have been triggered. If 0 is returned, risk rules were triggered and the calculated score was 0.
    - `asset_list` string[]: a new field that will be returned for Holistic Screenings only. This field contains the asset(s) involved in the transaction using the unique combination of transaction hash and output address.
    - `predictive` boolean: True if the transaction was analyzed too close to the tip of the blockchain, so the full picture of associated addresses might be incomplete.
    - `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
      - `address` object
        - `has_sent` boolean
        - `has_received` boolean
      - `transaction` object
        - `time` string
        - `inputs` InputOutput[]: details of each of the transaction's inputs. note: inputs is not returned for holistic screenings
          - `hash` string: blockchain identifier of the IO
          - `amount` object
            - `native` number: Transaction amount expresses in the native currency of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
            - `native_major` number: Transaction amount expressed in the native currency of the blockchain it has occurred rounded to its major decimal format
            - `usd` number: Transaction amount expressed in US dollars of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
          - `index` number: The index of this IO on the transaction
          - `labels` object[]: Label's given to the IO as per Elliptic Assertions
            - `name` string
            - `category` string
            - `is_primary_entity` boolean: Is this the primary label of the entity
        - `outputs` InputOutput[]: details of each of the transaction's outputs. note: outputs is not returned for holistic screenings
          - `hash` string: blockchain identifier of the IO
          - `amount` object
            - `native` number: Transaction amount expresses in the native currency of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
            - `native_major` number: Transaction amount expressed in the native currency of the blockchain it has occurred rounded to its major decimal format
            - `usd` number: Transaction amount expressed in US dollars of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
          - `index` number: The index of this IO on the transaction
          - `labels` object[]: Label's given to the IO as per Elliptic Assertions
            - `name` string
            - `category` string
            - `is_primary_entity` boolean: Is this the primary label of the entity
        - `value` object: Object representing the value of this transaction expresses in different currency units
          - `native` union: Transaction amount expresses in the native currency of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin. This value will not be present for holistic screenings
            - string
            - number
          - `native_major` union: Transaction amount expressed in the native currency of the blockchain it has occurred rounded to its major decimal format. This value will not be present for holistic screenings
            - string
            - number
          - `usd` number: Transaction amount expressed in US dollars of the blockchain it has occurred in the most precise unit possible, e.g. satoshis for bitcoin
      - `value` union: This value will not be present for holistic screenings
        - string
        - number
    - `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
    - `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.
    - `error` object, nullable: Property containing information about a failed screening, null unless process_status = 'error'
      - `message` string: error message
    - `evaluation_detail` EvaluationDetailForGetAll[], required: details of each risk rule evaluation
      - `rule_id` string, UUIDv4, required: the UUIDv4 of this risk rule
      - `rule_name` string: the name of the rule
      - `risk_score` number, float, required: The risk score calculated for this rule evaluation as part of the analysis
      - `mc_analysis_id` string, UUIDv4: id of the analysis
    - `contributions` Contribution[]: array of contributions for the analysis subject Will not be returned if process_status is running or error.
      - `entities` object[], required: Entities (labels) associated with this contribution
        - `name` string: Name of the entity
        - `category` string: Category of the entity
        - `category_id` string, uuid: UUID of category
        - `entity_id` string, uuid: UUID of entity
        - `actor_id` integer: Internal actor ID or numeric identifier that related to the identified entity
        - `is_primary_entity` boolean: Whether this is the primary entity in the group (one per list)
        - `is_vasp` boolean, nullable: True if VASP (Virtual Asset Service Provider), false if not, null if unknown
      - `contribution_percentage` number, float, required: Percentage of value contributed by this entity
      - `contribution_value` object, required: Value contributed by this entry
        - `usd` number, float
      - `counterparty_percentage` number, float: The percentage of the total contribution that is attributed to labelled entities that are one hop away from the screened_address.
      - `counterparty_value` object: Value from counterparties (1-hop entities)
        - `usd` number, float: The contribution between the screened_address and labelled entities that are one hop away, expressed in US dollars.
      - `indirect_percentage` number, float: The percentage of the total contribution that is attributed to labelled entities that are more than one hop away from the screened_address.
      - `indirect_value` object: USD value from indirect flow
        - `usd` number, float: The contribution between the screened_address and labelled entities that are more than one hop away, expressed in US dollars.
      - `is_screened_address` boolean: A boolean displaying whether the input address of a deposit or the output address of a withdrawal that is screened belongs to a labelled entity for transaction monitoring or the address that is screened belongs to a labelled entity for wallet screening
      - `min_number_of_hops` integer: Minimum number of hops between the subject and the labelled entity
    - `changes` object, nullable: 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.
    - `identifier` string: Internal field, no meaning outside of Elliptic
    - `record_scr` string: Internal field, no meaning outside of Elliptic
    - `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)