ELelliptic
Wallet Analyses

Get an analysis by ID

Given an ID, return a single wallet analysis

get/wallet/{wallet_analysis_id}

Request

  • Base URL
    https://aml-api.elliptic.co/v2
  • URL
    https://aml-api.elliptic.co/v2/wallet/{wallet_analysis_id}
  • Auth
    • HTTP bearer
    • or API key in header x-access-key and API key in header x-access-sign and API key in header x-access-timestamp

Path parameters

wallet_analysis_idstring UUIDv4 required

id of the wallet analysis to retrieve

Query parameters

includeScreeningsboolean

toggle whether to include the screening history

previousScreenings'default' | '20' | '50' | '100' | 'all'

Number of previous screenings to include in the response, where the default is 10

Response

Successful wallet analysis response

idstring uuid required

Unique identifier of the wallet analysis

type'wallet_exposure' required

The type of analysis. Currently it is wallet_exposure

created_atstring date-time required

ISO datetime (UTC) when the analysis was first analysed

updated_atstring date-time required

ISO datetime (UTC) when the wallet analysis was last updated

analysed_atstring date-time required

ISO datetime (UTC) when this analysis was completed

asset_tier'full' | 'sanctions'

The asset tier

team_idstring uuid required

UUIDv4 identifier of the team the user belongs to

risk_scorenumber 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.

workflow_statusWorkflowStatus required(unresolved $ref)
workflow_status_id1 | 2 | 3 | 4

A number representation of the status of an analysis. "archived" is deprecated and you should use "closed" instead. - 1 = active - 2 = archived (deprecated) - 3 = escalated - 4 = closed

assigned_team_userAnalysedBy (unresolved $ref)
process_status'running' | 'complete' | 'error' required

The process status ('running','complete','error')

process_status_id1 | 2 | 3

The screening process status. - 1 = running - 2 = completed - 3 = error

screening_idstring uuid

The identifier of the specific screening in the analysis

screening_source'sync' | 'async' | 'system_rescreen' | 'automatic_rescreen' | 'continuous_monitoring'

Indicates whether the screening was done via the Synchronous endpoint, Asynchronous endpoint, system rescreen, automatic rescreen, or continuous monitoring.

Changes

No recorded changes to this operation across all 1 revision of this API.