> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# Wallet-Screening-API: Krypto-AML auf Abruf
> Prüfen Sie eine Wallet-Adresse mit Didit auf AML-Risiko, ohne Transaktion. Mittelherkunft, Sanktionen, Risiko-Score. Ab $0.02 pro Aufruf.
Wallet-Screening-API-Prompt
Prompt in die Zwischenablage kopieren
\
\`Screen a single crypto wallet address for AML risk through the Didit Management API, without creating a transaction.
Endpoint:
POST https://verification.didit.me/v3/wallet-screening/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Run on-demand AML screening on one crypto address and return a normalised risk result (risk_score, severity, sanctions_hit, source/destination of funds, counterparty connections). Nothing is written to the transactions table.
When to call:
\- Before onboarding a customer's deposit/withdrawal wallet, to pre-check exposure.
\- Any time you need a standalone risk read on an address and do NOT have (or do not want to record) a transaction.
\- For transaction-coupled monitoring instead, use POST /v3/transactions/ with currency_kind = "crypto".
Prerequisites:
\- Transaction monitoring must be configured for the application with a managed provider or an existing provider key. Otherwise the call returns 409.
Request body (application/json):
\{
"wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a", // required; alias: address
"blockchain": "ETH", // required; one of BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC, BNB, BASE, OP, ARB, AVAX, ADA, XLM, HBAR, USDT, USDC, or a common network name such as POLYGON or BSC; alias: currency
"direction": "inbound" // optional; inbound | outbound | deposit | withdrawal
}
Example call:
curl -X POST "https://verification.didit.me/v3/wallet-screening/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"wallet_address":"0x94f1b9b64e2932f6a2db338f616844400cd58e8a","blockchain":"ETH"}'
What to read from the response:
\- risk_score (0-100, higher = riskier) and severity (UNKNOWN | LOW | MEDIUM | HIGH | CRITICAL).
\- sanctions_hit (boolean) and dominant_risk_category.
\- source_of_funds / destination_of_funds / counterparty_connections for the exposure breakdown.
Billing:
\- One AML monitoring usage is billed per successful screening. Sandbox applications are not billed.
Failure modes:
\- 400 - malformed wallet address, missing wallet_address, or unsupported blockchain.
\- 401 - missing or malformed x-api-key.
\- 409 - no AML provider configured for the application; configure transaction monitoring first.
\- 502 - provider could not complete the screening; retry later.
For automatic, transaction-coupled crypto screening, see /transaction-monitoring/aml-screening.`
\
Einfügen in
## OpenAPI
````yaml de/openapi-25.json POST /v3/wallet-screening/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/wallet-screening/:
post:
tags:
- Transactions
summary: Eine Adresse überprüfen
description: >-
Führt ein On-Demand-AML-Screening für eine einzelne
Krypto-Wallet/Adresse durch, ohne eine Transaktion zu erstellen.
Ermittelt den für Ihre Anwendung konfigurierten
Blockchain-Analyseanbieter, prüft die Adresse synchron und gibt das
normalisierte Risikoergebnis zurück. LIGHTNING ist nur mit einer über
den Marketplace hinzugefügten BYOK-Verbindung von Elliptic oder
Chainalysis verfügbar. Es wird nichts in die Transaktionstabelle
geschrieben. Eine Nutzung des AML-Monitorings wird pro erfolgreichem
Screening abgerechnet (Sandbox-Anwendungen werden nicht abgerechnet).
operationId: screenWallet
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- wallet_address
properties:
wallet_address:
type: string
description: "Die zu prüfende Krypto-Adresse oder die Netzwerk-ID. Muss zum ausgewählten Netzwerk passen (z.\_B. eine 40-stellige Hex-Adresse mit `0x`-Präfix für EVM-Chains). Alias: `address`."
example: '0x94f1b9b64e2932f6a2db338f616844400cd58e8a'
blockchain:
type: string
description: >-
Optionaler Netzwerkbezeichner. Wenn er weggelassen wird,
wird das Netzwerk anhand des Adressformats ermittelt:
`bc1`-, `1`- und `3`-Adressen sind Bitcoin (BTC),
`T`-Adressen sind Tron (TRX) und Base58-öffentliche
Schlüssel sind Solana (SOL). Eine `0x`-Adresse ist in jedem
EVM-Netzwerk gültig, sodass das Weglassen von `blockchain`
dafür den Status 422 mit den infrage kommenden Netzwerken in
`candidate_chains` zurückgibt. Verwaltetes Screening
unterstützt BTC, ETH, LTC, XRP, BCH, DOGE, TRX, SOL, MATIC,
BNB, BASE (Base), OP (Optimism), ARB (Arbitrum One), AVAX
(Avalanche C-Chain), ADA (Cardano), XLM (Stellar) und HBAR
(Hedera). USDT und USDC sind Legacy-Ethereum-Aliase, keine
netzwerkübergreifenden Suchen. Die Abdeckung verbundener
Anbieter variiert. LIGHTNING erfordert einen unterstützten
verbundenen Anbieter. CELO (Celo), MODE (Mode) und PLUME
(Plume) werden über ein verbundenes TRM-Labs-Konto
überprüft; verwaltetes Screening antwortet für diese mit
400. Alias: `currency`.
enum:
- BTC
- LIGHTNING
- ETH
- LTC
- XRP
- BCH
- DOGE
- TRX
- SOL
- MATIC
- BNB
- USDT
- USDC
- BASE
- OP
- ARB
- AVAX
- ADA
- XLM
- HBAR
- CELO
- MODE
- PLUME
example: ETH
direction:
type: string
description: >-
Optional. Gibt an, ob die Adresse als eingehende
(Einzahlung) oder ausgehende (Auszahlung) Gegenpartei
gescreent wird. Akzeptiert `inbound`, `outbound`, `deposit`
oder `withdrawal`. Standardmäßig wird bei Auslassung ein
neutrales Pre-Transfer-Screening durchgeführt. Dies wird dem
Anbieter nur als Kontext übergeben; es ändert weder den
zurückgegebenen `risk_score`, die `severity` noch die
Aufschlüsselungen für
`source_of_funds`/`destination_of_funds`, die unabhängig von
`direction` immer beide zurückgegeben werden. Eine Änderung
oder Auslassung von `direction` erfordert daher kein
erneutes Screening einer Adresse.
enum:
- inbound
- outbound
- deposit
- withdrawal
example:
wallet_address: '0x94f1b9b64e2932f6a2db338f616844400cd58e8a'
blockchain: ETH
responses:
'200':
description: Das normalisierte Wallet-Screening-Ergebnis.
content:
application/json:
schema:
$ref: '#/components/schemas/WalletScreeningResult'
example:
provider: merklescience
screening_type: WALLET_SCREENING
risk_score: 95
severity: CRITICAL
status: SCREENED
summary: >-
Merkle Science risk: Critical (5/5). SANCTIONS HIT. Dominant
risk: sanctioned. Driven by: the address is attributed to
Sanctions / OFAC (Example Sanctions)
wallet_address: '0x94f1b9b64e2932f6a2db338f616844400cd58e8a'
transaction_hash: null
blockchain: ETH
block_timestamp: null
total_value_usd: null
fee_usd: null
sender_rows: []
receiver_rows: []
transaction_flows: []
transaction_flows_status: null
transaction_flows_error: null
source_of_funds:
- category: sanctioned
percentage: 100
amount_usd: 9813695
entity_name: Example Sanctions
entity_type: Sanctions
entity_subtype: OFAC
hops: null
description: Sanctions / OFAC
is_direct: true
exposure_direction: incoming
exposure_type: direct
provider_entity_id: '118885'
provider_entity_type_id: '30'
provider_entity_subtype_id: '125'
country: ''
raw_amount: null
raw_currency: null
destination_of_funds:
- category: defi
percentage: 84.824453
amount_usd: 7783414.38
entity_name: Example DeFi 7
entity_type: DeFi
entity_subtype: Bridges
hops: null
description: DeFi / Bridges
is_direct: false
exposure_direction: outgoing
exposure_type: indirect
provider_entity_id: '118459'
provider_entity_type_id: '33'
provider_entity_subtype_id: '143'
country: ''
raw_amount: null
raw_currency: null
- category: defi
percentage: 15.175547
amount_usd: 1392494.37
entity_name: Example DeFi 2
entity_type: DeFi
entity_subtype: Yield Aggregator
hops: null
description: DeFi / Yield Aggregator
is_direct: false
exposure_direction: outgoing
exposure_type: indirect
provider_entity_id: '90192'
provider_entity_type_id: '33'
provider_entity_subtype_id: '142'
country: ''
raw_amount: null
raw_currency: null
counterparty_connections:
- entity_name: Example Sanctions
entity_type: Sanctions
entity_subtype: OFAC
risk_level: critical
categories:
- sanctioned
received_usd: null
sent_usd: null
received_hops: null
sent_hops: null
percentage: 0
is_direct: true
country: null
provider_entity_id: null
- entity_name: Example Sanctions
entity_type: Sanctions
entity_subtype: OFAC
risk_level: critical
categories:
- sanctioned
received_usd: null
sent_usd: null
received_hops: null
sent_hops: null
percentage: 0
is_direct: true
country: null
provider_entity_id: null
network_nodes: []
network_edges: []
sanctions_hit: true
pep_counterparty: null
dominant_risk_category: sanctioned
risk_factors:
- source: attribution
category: sanctioned
label: Sanctions / OFAC
entity_name: Example Sanctions
direction: attribution
exposure_type: attribution
amount_usd: null
percentage: 0
is_high_risk: true
description: >-
the address is attributed to Sanctions / OFAC (Example
Sanctions)
- source: exposure
category: sanctioned
label: Sanctions / OFAC
entity_name: Example Sanctions
direction: incoming
exposure_type: direct
amount_usd: 9813695
percentage: 51.679304
is_high_risk: true
description: >-
51.6793% direct incoming exposure to Sanctions / OFAC
(Example Sanctions)
- source: exposure
category: defi
label: DeFi / Bridges
entity_name: Example DeFi 7
direction: outgoing
exposure_type: indirect
amount_usd: 7783414.38
percentage: 40.987766
is_high_risk: false
description: >-
40.9878% indirect outgoing exposure to DeFi / Bridges
(Example DeFi 7)
- source: exposure
category: defi
label: DeFi / Yield Aggregator
entity_name: Example DeFi 2
direction: outgoing
exposure_type: indirect
amount_usd: 1392494.37
percentage: 7.33293
is_high_risk: false
description: >-
7.33293% indirect outgoing exposure to DeFi / Yield
Aggregator (Example DeFi 2)
raw_response:
...: provider-specific details
report_signature:
'400':
description: >-
Validierungsfehler – fehlerhafte Adresse, fehlende `wallet_address`,
nicht unterstützte `blockchain`, weggelassene `blockchain` bei einer
Adresse, deren Format kein Netzwerk benennt, oder LIGHTNING ohne
eine Elliptic- oder Chainalysis-BYOK-Marketplace-Verbindung.
'401':
description: Fehlender oder ungültiger `x-api-key`.
'409':
description: >-
Für die Anwendung ist kein AML-Anbieter konfiguriert, oder der
konfigurierte Anbieter unterstützt Wallet-Screening noch nicht.
Konfigurieren Sie zuerst die Transaktionsüberwachung.
'422':
description: >-
`blockchain` für eine `0x`-Adresse weggelassen, die alle
EVM-Netzwerke teilen. Es wird nichts geprüft oder abgerechnet;
senden Sie die Anfrage erneut mit `blockchain` auf eine der
`candidate_chains` gesetzt.
content:
application/json:
schema:
type: object
properties:
blockchain:
type: array
items:
type: string
example:
- >-
A 0x address is valid on every EVM chain. Send
blockchain as one of: ETH, BNB, MATIC, BASE, ARB, OP,
CELO, MODE, PLUME.
candidate_chains:
type: array
items:
type: string
example:
- ETH
- BNB
- MATIC
- BASE
- ARB
- OP
- CELO
- MODE
- PLUME
'502':
description: >-
Der AML-Anbieter konnte das Screening nicht abschließen. Versuchen
Sie es später erneut.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
curl -X POST 'https://verification.didit.me/v3/wallet-screening/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"wallet_address": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
"blockchain": "ETH"
}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.wallet_screening.screen(
wallet_address="0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
blockchain="ETH",
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.walletScreening.screen({
wallet_address: "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
blockchain: "ETH",
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.WalletScreening.Screen(ctx, didit.WalletScreeningScreenParams{\n\tWalletAddress: \"0x94f1b9b64e2932f6a2db338f616844400cd58e8a\",\n\tBlockchain: didit.Some(didit.WalletScreeningScreenParamsBlockchain(\"ETH\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import me.didit.Didit;
import me.didit.types.WalletScreeningScreenParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.walletScreening().screen(WalletScreeningScreenParams.builder()
.walletAddress("0x94f1b9b64e2932f6a2db338f616844400cd58e8a")
.blockchain(WalletScreeningScreenParams.Blockchain.of("ETH"))
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
walletScreening->screen([
'wallet_address' => '0x94f1b9b64e2932f6a2db338f616844400cd58e8a',
'blockchain' => 'ETH',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.wallet_screening.screen(
wallet_address: "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
blockchain: "ETH"
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.WalletScreening.ScreenAsync(new
WalletScreeningScreenParams
{
WalletAddress = "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
Blockchain = new WalletScreeningScreenParamsBlockchain("ETH"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
WalletScreeningResult:
type: object
properties:
provider:
type: string
description: >-
Anbieter, der das Screening durchgeführt hat (z. B. `merklescience`,
`crystal`).
screening_type:
type: string
enum:
- WALLET_SCREENING
description: Für diesen Endpoint immer `WALLET_SCREENING`.
risk_score:
type: integer
description: >-
Normalisierter Risiko-Score von 0–100. Höher bedeutet eine größere
Exposition gegenüber riskanten Entitäten. Merkle Science bewertet
eine Adresse von 0–5, was 0, 15, 35, 55, 75 oder 95 entspricht.
severity:
type: string
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: >-
Aus `risk_score` abgeleitete Risikogruppe: `0-9` UNKNOWN, `10-39`
LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` ist
die niedrigste Spanne, kein separater Zustand ohne Daten:
`risk_score` 0 (der übliche Fall einer unauffälligen Adresse)
bedeutet keine negative Bewertung, während ein Wert ungleich null im
Bereich 1-9 ein reales, aber unter LOW liegendes Signal darstellt –
werten Sie den `risk_score` aus, nicht nur die Spanne. Behandeln Sie
`UNKNOWN` niemals als bestätigte Einstufung mit geringem Risiko oder
unbedenkliche Bewertung; zeigen Sie dies nicht als bestanden an.
status:
type: string
enum:
- SCREENED
- PENDING
- ERROR
description: Ergebnisstatus des Screenings.
summary:
type: string
description: Für Menschen lesbare Zusammenfassung des Screening-Ergebnisses.
wallet_address:
type: string
description: Die überprüfte Adresse, unverändert zurückgegeben.
transaction_hash:
type: string
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
blockchain:
type: string
description: Die Blockchain, die überprüft wurde.
block_timestamp:
type: string
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
total_value_usd:
type: number
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
fee_usd:
type: number
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
sender_rows:
type: array
items:
type: object
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer leer.
receiver_rows:
type: array
items:
type: object
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer leer.
transaction_flows:
type: array
items:
type: object
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer leer.
transaction_flows_status:
type: string
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
transaction_flows_error:
type: string
nullable: true
description: >-
Transaktions-Screening-Feld, gemeinsam mit der Ergebnisstruktur
genutzt. Bei einem Wallet-Screening-Ergebnis immer `null`.
source_of_funds:
type: array
description: >-
Von wo die Adresse Gelder empfangen hat, zugeordnet nach Entität.
Jeder Eintrag ist eine Exposure-Aufschlüsselung.
items:
type: object
properties:
category:
type: string
description: >-
Normalisierte Risikokategorie, z. B. `exchange_licensed`,
`dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`,
`sanctioned`, `stolen_funds`, `high_risk_exchange`.
percentage:
type: number
description: Anteil an der Gesamtexposition der Richtung, 0-100.
amount_usd:
type: number
nullable: true
description: Dieser Entität zugeschriebener USD-Wert.
entity_name:
type: string
nullable: true
description: >-
Name der zugeordneten Entität, beispielsweise einer
Krypto-Börse, eines Mixers oder einer sanktionierten Gruppe.
entity_type:
type: string
nullable: true
description: >-
Typ der Anbieter-Entität (z. B. `Exchange`, `DeFi`,
`Sanctions`, `Theft`).
entity_subtype:
type: string
nullable: true
description: >-
Detaillierterer Untertyp (z. B. `Mandatory KYC and AML`,
`OFAC`, `Yield Aggregator`).
hops:
type: integer
nullable: true
description: >-
Anzahl der Hops zur Entität (1 für eine direkte Gegenpartei),
sofern der Anbieter einen angibt. Immer `null` für Merkle
Science, das nur meldet, ob das Exposure direkt oder indirekt
ist: Verwenden Sie `exposure_type`.
description:
type: string
nullable: true
description: >-
`entity_type / entity_subtype`, wie der Anbieter die Entität
kennzeichnet.
is_direct:
type: boolean
description: True, wenn `exposure_type` gleich `direct` ist.
exposure_direction:
type: string
enum:
- incoming
- outgoing
- connected
description: >-
Gibt an, ob die Mittel von dieser Entität stammten
(`incoming`) oder an sie gingen (`outgoing`).
exposure_type:
type: string
enum:
- direct
- indirect
description: '`direct` (1 Hop) oder `indirect` (Multi-Hop) Exposition.'
provider_entity_id:
type: string
nullable: true
description: Die anbietereigene Kennung für die Entität.
provider_entity_type_id:
type: string
nullable: true
description: Die anbietereigene Kennung für `entity_type`.
provider_entity_subtype_id:
type: string
nullable: true
description: Die anbietereigene Kennung für `entity_subtype`.
country:
type: string
nullable: true
description: >-
Primäres ISO-3166-1-alpha-2-Land der Entität. Leer oder
`null`, wenn der Anbieter es nicht kennt.
raw_amount:
type: number
nullable: true
description: >-
Betrag in der eigenen Einheit des Vermögenswerts, sofern vom
Anbieter gemeldet.
raw_currency:
type: string
nullable: true
description: Einheit von `raw_amount`, sofern vom Anbieter gemeldet.
destination_of_funds:
type: array
description: >-
Wohin die Adresse Gelder gesendet hat, zugeordnet nach Entität.
Gleiche Elementstruktur wie `source_of_funds` mit
`exposure_direction` = `outgoing`.
items:
type: object
properties:
category:
type: string
description: >-
Normalisierte Risikokategorie, z. B. `exchange_licensed`,
`dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`,
`sanctioned`, `stolen_funds`, `high_risk_exchange`.
percentage:
type: number
description: Anteil an der Gesamtexposition der Richtung, 0-100.
amount_usd:
type: number
nullable: true
description: Dieser Entität zugeschriebener USD-Wert.
entity_name:
type: string
nullable: true
description: >-
Name der zugeordneten Entität, beispielsweise einer
Krypto-Börse, eines Mixers oder einer sanktionierten Gruppe.
entity_type:
type: string
nullable: true
description: >-
Typ der Anbieter-Entität (z. B. `Exchange`, `DeFi`,
`Sanctions`, `Theft`).
entity_subtype:
type: string
nullable: true
description: >-
Detaillierterer Untertyp (z. B. `Mandatory KYC and AML`,
`OFAC`, `Yield Aggregator`).
hops:
type: integer
nullable: true
description: >-
Anzahl der Hops zur Entität (1 für eine direkte Gegenpartei),
sofern der Anbieter einen angibt. Immer `null` für Merkle
Science, das nur meldet, ob das Exposure direkt oder indirekt
ist: Verwenden Sie `exposure_type`.
description:
type: string
nullable: true
description: >-
`entity_type / entity_subtype`, wie der Anbieter die Entität
kennzeichnet.
is_direct:
type: boolean
description: True, wenn `exposure_type` gleich `direct` ist.
exposure_direction:
type: string
enum:
- incoming
- outgoing
- connected
description: >-
Gibt an, ob die Mittel von dieser Entität stammten
(`incoming`) oder an sie gingen (`outgoing`).
exposure_type:
type: string
enum:
- direct
- indirect
description: '`direct` (1 Hop) oder `indirect` (Multi-Hop) Exposition.'
provider_entity_id:
type: string
nullable: true
description: Die anbietereigene Kennung für die Entität.
provider_entity_type_id:
type: string
nullable: true
description: Die anbietereigene Kennung für `entity_type`.
provider_entity_subtype_id:
type: string
nullable: true
description: Die anbietereigene Kennung für `entity_subtype`.
country:
type: string
nullable: true
description: >-
Primäres ISO-3166-1-alpha-2-Land der Entität. Leer oder
`null`, wenn der Anbieter es nicht kennt.
raw_amount:
type: number
nullable: true
description: >-
Betrag in der eigenen Einheit des Vermögenswerts, sofern vom
Anbieter gemeldet.
raw_currency:
type: string
nullable: true
description: Einheit von `raw_amount`, sofern vom Anbieter gemeldet.
counterparty_connections:
type: array
description: >-
Entitäten, denen der Anbieter die überprüfte Adresse zuordnet. Bei
Merkle Science stammen diese aus den eigenen Eigentümer- und
Benutzer-Tags der Adresse, sodass dieselbe Entität zweimal vorkommen
kann und diese keine Mittelflüsse aufweisen: `received_usd`,
`sent_usd`, `received_hops` und `sent_hops` sind `null` und
`percentage` ist 0. Steuern Sie hier nicht anhand von `risk_level`
oder `is_direct`: Verwenden Sie `sanctions_hit`,
`dominant_risk_category` und `risk_factors[].is_high_risk` für das
Urteil und `exposure_type` in
`source_of_funds`/`destination_of_funds` für die Direktheit.
items:
type: object
properties:
entity_name:
type: string
nullable: true
description: Name der zugeschriebenen Entität.
entity_type:
type: string
nullable: true
description: Typ der Anbieter-Entität.
entity_subtype:
type: string
nullable: true
description: Subtyp der Anbieter-Entität.
risk_level:
type: string
description: >-
In Kleinbuchstaben und anbieterabhängig. Bei Merkle Science
ist dies die eigene Risikostufe 0–5 der Adresse (`no_risk`,
`low`, `medium_low`, `medium`, `high`, `critical`), angehoben
auf `high`, wenn die Kategorie der Entität ein hohes Risiko
aufweist; es handelt sich nicht um eine separate Einstufung
der Entität.
categories:
type: array
items:
type: string
description: Normalisierte Risikokategorien der Entität.
received_usd:
type: number
nullable: true
description: Von der Entität empfangene USD, sofern vom Anbieter gemeldet.
sent_usd:
type: number
nullable: true
description: An die Entität gesendete USD, sofern vom Anbieter gemeldet.
received_hops:
type: integer
nullable: true
description: >-
Hops zur Entität auf der Empfängerseite, sofern vom Anbieter
gemeldet.
sent_hops:
type: integer
nullable: true
description: >-
Hops zur Entität auf der Senderseite, sofern vom Anbieter
gemeldet.
percentage:
type: number
description: >-
Anteil an der Exposition der Adresse, sofern vom Anbieter
gemeldet; andernfalls 0.
is_direct:
type: boolean
description: >-
Immer `true` für Merkle Science, deren Verbindungen eher
Attributionen als Gegenparteien sind.
country:
type: string
nullable: true
description: Land der Entität, sofern bekannt.
provider_entity_id:
type: string
nullable: true
description: Die anbietereigene Kennung für die Entität.
network_nodes:
type: array
items:
type: object
description: >-
Knoten des Exposure-Graphen für das Transaktions-Screening. Bei
einem Wallet-Screening-Ergebnis leer.
network_edges:
type: array
items:
type: object
description: >-
Kanten des Exposure-Graphen für das Transaktions-Screening. Bei
einem Wallet-Screening-Ergebnis leer.
sanctions_hit:
type: boolean
description: >-
True, wenn die Adresse direkt oder indirekt Sanktionen ausgesetzt
ist.
pep_counterparty:
type: boolean
description: >-
Exposition gegenüber einer politisch exponierten Person. `null`,
wenn kein PEP-Befund vorliegt, was derzeit jedes Ergebnis ist, da
kein Anbieter einen meldet; `false` nur bei einem explizit negativen
Screening-Ergebnis. Interpretieren Sie `null` nicht als
abgeschlossene PEP-Prüfung.
nullable: true
dominant_risk_category:
type: string
nullable: true
description: >-
Kategorie mit hohem Risiko mit der höchsten Gewichtung oder `null`,
wenn keine dominiert (z. B. `sanctioned`, `mixer`, `stolen_funds`).
risk_factors:
type: array
description: >-
Nach Rang geordnete Erklärung von `risk_score`: was dieses Urteil
herbeigeführt hat. Anbieter bewerten eine Adresse nach ihrem eigenen
Modell und geben lediglich ein Urteil zurück (Merkle Science gibt
eine Ganzzahl von 0-5 zurück), sodass der Score allein nicht
handlungsrelevant ist. Zuerst nach hohem Risiko, dann nach dem Wert
sortiert, der durch jeden Treiber bewegt wurde, begrenzt auf die
fünf stärksten; `source_of_funds` und `destination_of_funds`
enthalten immer die vollständige Aufschlüsselung. Ein hoher
`risk_score` ohne `is_high_risk`-Eintrag bedeutet, dass der Anbieter
keine Übereinstimmung mit Sanktionen oder zugeordneten Entitäten
gemeldet und die Adresse rein anhand seines eigenen Exposure-Modells
bewertet hat – `summary` gibt dies explizit an.
items:
type: object
properties:
source:
type: string
enum:
- attribution
- exposure
description: >-
`attribution` ist das, was der Anbieter als die Adresse selbst
angibt (ihr eigener Tag oder Cluster); `exposure` gibt an,
wohin ihre Gelder tatsächlich geflossen sind.
category:
type: string
description: >-
Normalisierte Risikokategorie, gleiches Vokabular wie bei der
Aufschlüsselung der Exposition.
label:
type: string
description: >-
Der anbietereigene Wortlaut für den Treiber (z. B. `Gambling /
Crypto only`), den Sie auch in der Konsole des Anbieters sehen
würden.
entity_name:
type: string
nullable: true
description: >-
Zugeschriebene Entität hinter dem Treiber, zum Beispiel eine
Glücksspiel-Website oder eine Börse.
direction:
type: string
enum:
- incoming
- outgoing
- connected
- unknown
- attribution
description: >-
Richtung des Geldflusses, `attribution`, wenn der Auslöser das
eigene Tag der Adresse ist, oder `unknown`, wenn der Anbieter
keine Richtung gemeldet hat.
exposure_type:
type: string
enum:
- direct
- indirect
- unknown
- attribution
description: >-
`direct` (1 Hop) oder `indirect` (Multi-Hop), `attribution`
für das eigene Tag der Adresse oder `unknown`, wenn der
Anbieter nicht angegeben hat, wie viele Hops die Gegenpartei
entfernt ist. Behandeln Sie `unknown` als nicht klassifiziert,
nicht als `direct`.
amount_usd:
type: number
format: float
nullable: true
description: Diesem Treiber zugeschriebener USD-Wert.
percentage:
type: number
format: float
description: >-
Anteil am GESAMTEN überprüften Volumen der Adresse, beide
Richtungen kombiniert – im Gegensatz zu `percentage` innerhalb
von `source_of_funds`/`destination_of_funds`, das pro Richtung
normalisiert wird. Über die gesamte Liste hinweg vergleichbar
und summierbar.
is_high_risk:
type: boolean
description: >-
Gibt an, ob die Kategorie von Didit als hohes Risiko
eingestuft wird (`sanctioned`, `mixer`, `stolen_funds`,
`ransomware`, `scam`, `darknet_market`, `terrorist_financing`,
`child_exploitation`, `hacked_exchange`, `high_risk_exchange`,
`seized_funds`).
description:
type: string
description: >-
Einzeilige Darstellung des Treibers, z. B. `9.01% indirect
outgoing exposure to Gambling / Crypto only (Example
Gambling)`.
raw_response:
type: object
additionalProperties: true
description: >-
Die anbietereigene Payload. Ihre Struktur ist anbieterspezifisch und
kann sich ohne Vorankündigung ändern: Lesen Sie die normalisierten
Felder aus, anstatt sie zu parsen.
report_signature:
type: string
description: >-
Opake HMAC-SHA256-Signatur über genau dieses Ergebnis, beschränkt
auf Ihre Anwendung. Für sich allein genommen nicht aussagekräftig –
senden Sie den vollständigen Antwort-Body unverändert und
einschließlich dieses Felds erneut an `POST
/v3/wallet-screening/pdf/`, um ihn als PDF zu rendern. Der
PDF-Endpoint weist die Anfrage mit `400` ab, wenn `report_signature`
fehlt oder wenn ein signiertes Feld (z. B. `risk_score`, `severity`,
`sanctions_hit`) vor dem erneuten Senden bearbeitet wurde.
required:
- provider
- screening_type
- risk_score
- severity
- status
- summary
- wallet_address
- blockchain
- sanctions_hit
- dominant_risk_category
- source_of_funds
- destination_of_funds
- counterparty_connections
- report_signature
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
null. Siehe https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.