---
title: "Performs a preview analysis of the wallet"
method: POST
path: "/v1/domains/{domainId}/compliance/analysis/preview"
tags: ["Compliance"]
---

# Performs a preview analysis of the wallet

`POST /v1/domains/{domainId}/compliance/analysis/preview`

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/compliance/analysis/preview`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/compliance/analysis/preview/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `domainId` string, uuid, required

## Request body

- union
  - object
    - `provider` 'ELLIPTIC', required
    - `walletAddress` string, required
  - object
    - `provider` 'CHAINALYSIS', required
    - `walletAddress` string, required
    - `transactionAmount` number, required
    - `ledger` string, required
    - `tickerId` string, required

## Response `200`

OK

- union
  - object
    - `provider` 'CHAINALYSIS', required
    - `walletAddress` string, required
    - `transactionAmount` number
    - `ledger` string, required
    - `transactionType` 'INCOMING' | 'OUTGOING', required
    - `screenedAt` string, date-time
    - `errorDetails` string
    - `warningDetails` string
    - `riskLevel` 'UNKNOWN' | 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NO_RISK_DETECTED'
    - `screeningDetail` ComplianceScreeningDetailChainalysis
      - `alerts` ComplianceChainalysisAlert[]
        - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NO_RISK_DETECTED', required
        - `exposureType` 'DIRECT', required
        - `externalLink` string, required
        - `category` string
      - `directCounterparty` string
  - object
    - `provider` 'ELLIPTIC', required
    - `walletAddress` string, required
    - `transactionAmount` number
    - `ledger` string, required
    - `transactionType` 'INCOMING' | 'OUTGOING', required
    - `screenedAt` string, date-time
    - `errorDetails` string
    - `warningDetails` string
    - `riskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'UNKNOWN'
    - `screeningDetail` ComplianceScreeningDetailElliptic
      - `walletCategory` string
      - `referenceLink` string, required
      - `referenceId` string, required
      - `riskScoreValue` string, required

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `405`: Method Not Allowed

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)
