> ## 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.
# API de triagem de carteira cripto: AML sob demanda
> A API da Didit analisa o risco AML de um endereço de carteira cripto sem criar transação: origem dos recursos, sanções e risco. A partir de $0.02.
Prompt da API de triagem de carteiras
Copiar o prompt para a área de transferência
\
\`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.`
\
Colar em
## OpenAPI
````yaml pt-br/openapi-25.json POST /v3/wallet-screening/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/wallet-screening/:
post:
tags:
- Transactions
summary: Fazer a triagem de um endereço de carteira
description: >-
Executa uma triagem AML sob demanda para uma única carteira/endereço
cripto sem criar uma transação. Identifica o provedor de análise de
blockchain configurado na sua aplicação, faz a triagem do endereço de
forma síncrona e retorna o resultado de risco normalizado. LIGHTNING
está disponível apenas com uma conexão BYOK da Elliptic ou da
Chainalysis adicionada pelo Marketplace. Nada é gravado na tabela de
transações. Um uso de monitoramento AML é cobrado por triagem
bem-sucedida (aplicações de sandbox não são cobradas).
operationId: screenWallet
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- wallet_address
properties:
wallet_address:
type: string
description: >-
O endereço cripto ou identificador de rede a ser analisado.
Deve corresponder à rede selecionada (por exemplo, um
endereço com prefixo `0x` e 40 caracteres hexadecimais para
redes EVM). Alias: `address`.
example: '0x94f1b9b64e2932f6a2db338f616844400cd58e8a'
blockchain:
type: string
description: >-
Identificador de rede opcional. Quando omitido, a rede é
identificada pelo formato do endereço: endereços `bc1`, `1`
e `3` são Bitcoin (BTC), endereços `T` são Tron (TRX) e
chaves públicas base58 são Solana (SOL). Um endereço `0x` é
válido em todas as redes EVM, então omitir `blockchain` para
ele retorna 422 com as redes candidatas em
`candidate_chains`. A triagem gerenciada oferece suporte a
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) e HBAR (Hedera). USDT
e USDC são aliases legados do Ethereum, não buscas em várias
redes. A cobertura de provedores conectados varia. LIGHTNING
exige um provedor conectado compatível. CELO (Celo), MODE
(Mode) e PLUME (Plume) são analisados por meio de uma conta
TRM Labs conectada; a triagem gerenciada retorna 400 para
eles. 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: >-
Opcional. Indica se o endereço está sendo analisado como
contraparte de entrada (depósito) ou de saída (saque).
Aceita `inbound`, `outbound`, `deposit` ou `withdrawal`.
Quando omitido, o padrão é uma análise neutra
pré-transferência. Esse valor é repassado ao provedor apenas
como contexto; ele não altera o `risk_score`, a `severity`
nem os detalhamentos
`source_of_funds`/`destination_of_funds` retornados, que são
sempre retornados ambos, independentemente de `direction`.
Portanto, alterar ou omitir `direction` não exige analisar o
endereço novamente.
enum:
- inbound
- outbound
- deposit
- withdrawal
example:
wallet_address: '0x94f1b9b64e2932f6a2db338f616844400cd58e8a'
blockchain: ETH
responses:
'200':
description: O resultado normalizado da triagem de carteiras.
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: >-
Erro de validação: endereço de carteira malformado, `wallet_address`
ausente, `blockchain` não suportada, `blockchain` omitida para um
endereço cujo formato não indica nenhuma rede, ou LIGHTNING sem uma
conexão BYOK do Marketplace com Elliptic ou Chainalysis.
'401':
description: '`x-api-key` ausente ou inválido.'
'409':
description: >-
Nenhum provedor de AML está configurado para a aplicação, ou o
provedor configurado ainda não oferece suporte à triagem de
carteiras. Configure primeiro o monitoramento de transações.
'422':
description: >-
`blockchain` omitido para um endereço `0x`, que todas as redes EVM
compartilham. Nada é analisado nem cobrado; reenvie com `blockchain`
definido como um dos valores de `candidate_chains`.
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: >-
O provedor de AML não conseguiu concluir a análise. Tente novamente
mais tarde.
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: >-
Provedor que realizou a triagem (por exemplo, `merklescience`,
`crystal`).
screening_type:
type: string
enum:
- WALLET_SCREENING
description: Sempre `WALLET_SCREENING` neste endpoint.
risk_score:
type: integer
description: >-
Pontuação de risco normalizada de 0 a 100. Quanto maior, maior a
exposição a entidades de risco. A Merkle Science classifica um
endereço de 0 a 5, o que corresponde a 0, 15, 35, 55, 75 ou 95.
severity:
type: string
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: >-
Faixa de risco derivada de `risk_score`: `0-9` UNKNOWN, `10-39` LOW,
`40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` é a faixa
mais baixa, não um estado separado de ausência de dados. Um
`risk_score` 0 (o caso comum de endereço limpo) significa que não há
avaliação adversa. Já uma pontuação diferente de zero na faixa de
1-9 é um sinal real, mas abaixo de LOW. Leia o `risk_score`, não
apenas a faixa. Nunca trate `UNKNOWN` como uma classificação
afirmativa de baixo risco ou de aprovação, e não o exiba como
aprovado.
status:
type: string
enum:
- SCREENED
- PENDING
- ERROR
description: Status do resultado da análise.
summary:
type: string
description: Resumo legível do resultado da triagem.
wallet_address:
type: string
description: O endereço analisado, devolvido na resposta.
transaction_hash:
type: string
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
blockchain:
type: string
description: A blockchain que foi analisada.
block_timestamp:
type: string
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
total_value_usd:
type: number
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
fee_usd:
type: number
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
sender_rows:
type: array
items:
type: object
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre vazio em um resultado de triagem de carteiras.
receiver_rows:
type: array
items:
type: object
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre vazio em um resultado de triagem de carteiras.
transaction_flows:
type: array
items:
type: object
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre vazio em um resultado de triagem de carteiras.
transaction_flows_status:
type: string
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
transaction_flows_error:
type: string
nullable: true
description: >-
Campo de triagem de transações, compartilhado com o formato do
resultado. Sempre `null` em um resultado de triagem de carteiras.
source_of_funds:
type: array
description: >-
De onde o endereço recebeu fundos, atribuídos por entidade. Cada
entrada é um detalhamento de exposição.
items:
type: object
properties:
category:
type: string
description: >-
Categoria de risco normalizada, por exemplo
`exchange_licensed`, `dex`, `defi`, `payment_processor`,
`mixer`, `darknet_market`, `sanctioned`, `stolen_funds`,
`high_risk_exchange`.
percentage:
type: number
description: Participação na exposição total da direção, de 0 a 100.
amount_usd:
type: number
nullable: true
description: Valor em USD atribuído a esta entidade.
entity_name:
type: string
nullable: true
description: >-
Nome da entidade atribuída, por exemplo uma exchange, um mixer
ou um grupo sancionado.
entity_type:
type: string
nullable: true
description: >-
Tipo da entidade no provedor (por exemplo, `Exchange`, `DeFi`,
`Sanctions`, `Theft`).
entity_subtype:
type: string
nullable: true
description: >-
Subtipo mais detalhado (por exemplo, `Mandatory KYC and AML`,
`OFAC`, `Yield Aggregator`).
hops:
type: integer
nullable: true
description: >-
Número de saltos até a entidade (1 para uma contraparte
direta), quando o provedor informa esse dado. Sempre `null`
para a Merkle Science, que informa apenas se a exposição é
direta ou indireta: use `exposure_type`.
description:
type: string
nullable: true
description: >-
`entity_type / entity_subtype`, conforme o provedor classifica
a entidade.
is_direct:
type: boolean
description: True quando `exposure_type` é `direct`.
exposure_direction:
type: string
enum:
- incoming
- outgoing
- connected
description: >-
Se os fundos vieram desta entidade (`incoming`) ou foram
enviados a ela (`outgoing`).
exposure_type:
type: string
enum:
- direct
- indirect
description: Exposição `direct` (1 salto) ou `indirect` (vários saltos).
provider_entity_id:
type: string
nullable: true
description: O identificador próprio do provedor para a entidade.
provider_entity_type_id:
type: string
nullable: true
description: O identificador próprio do provedor para `entity_type`.
provider_entity_subtype_id:
type: string
nullable: true
description: O identificador próprio do provedor para `entity_subtype`.
country:
type: string
nullable: true
description: >-
País principal da entidade no formato ISO 3166-1 alpha-2.
Vazio ou `null` quando o provedor não o conhece.
raw_amount:
type: number
nullable: true
description: >-
Valor na própria unidade do ativo, quando o provedor o
informa.
raw_currency:
type: string
nullable: true
description: Unidade de `raw_amount`, quando o provedor a informa.
destination_of_funds:
type: array
description: >-
Para onde o endereço enviou fundos, atribuídos por entidade. Mesmo
formato de item de `source_of_funds`, com `exposure_direction` =
`outgoing`.
items:
type: object
properties:
category:
type: string
description: >-
Categoria de risco normalizada, por exemplo
`exchange_licensed`, `dex`, `defi`, `payment_processor`,
`mixer`, `darknet_market`, `sanctioned`, `stolen_funds`,
`high_risk_exchange`.
percentage:
type: number
description: Participação na exposição total da direção, de 0 a 100.
amount_usd:
type: number
nullable: true
description: Valor em USD atribuído a esta entidade.
entity_name:
type: string
nullable: true
description: >-
Nome da entidade atribuída, por exemplo uma exchange, um mixer
ou um grupo sancionado.
entity_type:
type: string
nullable: true
description: >-
Tipo da entidade no provedor (por exemplo, `Exchange`, `DeFi`,
`Sanctions`, `Theft`).
entity_subtype:
type: string
nullable: true
description: >-
Subtipo mais detalhado (por exemplo, `Mandatory KYC and AML`,
`OFAC`, `Yield Aggregator`).
hops:
type: integer
nullable: true
description: >-
Número de saltos até a entidade (1 para uma contraparte
direta), quando o provedor informa esse dado. Sempre `null`
para a Merkle Science, que informa apenas se a exposição é
direta ou indireta: use `exposure_type`.
description:
type: string
nullable: true
description: >-
`entity_type / entity_subtype`, conforme o provedor classifica
a entidade.
is_direct:
type: boolean
description: True quando `exposure_type` é `direct`.
exposure_direction:
type: string
enum:
- incoming
- outgoing
- connected
description: >-
Se os fundos vieram desta entidade (`incoming`) ou foram
enviados a ela (`outgoing`).
exposure_type:
type: string
enum:
- direct
- indirect
description: Exposição `direct` (1 salto) ou `indirect` (vários saltos).
provider_entity_id:
type: string
nullable: true
description: O identificador próprio do provedor para a entidade.
provider_entity_type_id:
type: string
nullable: true
description: O identificador próprio do provedor para `entity_type`.
provider_entity_subtype_id:
type: string
nullable: true
description: O identificador próprio do provedor para `entity_subtype`.
country:
type: string
nullable: true
description: >-
País principal da entidade no formato ISO 3166-1 alpha-2.
Vazio ou `null` quando o provedor não o conhece.
raw_amount:
type: number
nullable: true
description: >-
Valor na própria unidade do ativo, quando o provedor o
informa.
raw_currency:
type: string
nullable: true
description: Unidade de `raw_amount`, quando o provedor a informa.
counterparty_connections:
type: array
description: >-
Entidades às quais o provedor atribui o endereço analisado. Para a
Merkle Science, elas vêm das tags de proprietário e de usuário do
próprio endereço, então a mesma entidade pode aparecer duas vezes, e
não trazem fluxos de fundos: `received_usd`, `sent_usd`,
`received_hops` e `sent_hops` são `null` e `percentage` é 0. Não
tome decisões com base em `risk_level` ou `is_direct` aqui: use
`sanctions_hit`, `dominant_risk_category` e
`risk_factors[].is_high_risk` para o veredito, e `exposure_type` em
`source_of_funds`/`destination_of_funds` para saber se a exposição é
direta.
items:
type: object
properties:
entity_name:
type: string
nullable: true
description: Nome da entidade atribuída.
entity_type:
type: string
nullable: true
description: Tipo da entidade no provedor.
entity_subtype:
type: string
nullable: true
description: Subtipo da entidade no provedor.
risk_level:
type: string
description: >-
Em minúsculas e dependente do provedor. Para a Merkle Science,
é o próprio grau de risco de 0 a 5 do endereço (`no_risk`,
`low`, `medium_low`, `medium`, `high`, `critical`), elevado
para `high` quando a categoria da entidade é de alto risco;
não é um grau separado da entidade.
categories:
type: array
items:
type: string
description: Categorias de risco normalizadas da entidade.
received_usd:
type: number
nullable: true
description: >-
Valor em USD recebido da entidade, quando o provedor o
informa.
sent_usd:
type: number
nullable: true
description: Valor em USD enviado à entidade, quando o provedor o informa.
received_hops:
type: integer
nullable: true
description: >-
Saltos até a entidade do lado receptor, quando o provedor os
informa.
sent_hops:
type: integer
nullable: true
description: >-
Saltos até a entidade do lado remetente, quando o provedor os
informa.
percentage:
type: number
description: >-
Participação na exposição do endereço, quando o provedor a
informa; caso contrário, 0.
is_direct:
type: boolean
description: >-
Sempre `true` para a Merkle Science, cujas conexões são
atribuições, e não contrapartes.
country:
type: string
nullable: true
description: País da entidade, quando conhecido.
provider_entity_id:
type: string
nullable: true
description: O identificador próprio do provedor para a entidade.
network_nodes:
type: array
items:
type: object
description: >-
Nós do grafo de exposição para a triagem de transações. Vazio em um
resultado de Triagem de carteiras.
network_edges:
type: array
items:
type: object
description: >-
Arestas do grafo de exposição para a triagem de transações. Vazio em
um resultado de Triagem de carteiras.
sanctions_hit:
type: boolean
description: True se o endereço tem exposição direta ou indireta a sanções.
pep_counterparty:
type: boolean
description: >-
Exposição como pessoa politicamente exposta. `null` quando não há
nenhuma constatação de PEP disponível, o que ocorre hoje em todos os
resultados, pois nenhum provedor a informa; `false` somente para um
resultado de triagem explicitamente negativo. Não interprete `null`
como uma verificação de PEP concluída.
nullable: true
dominant_risk_category:
type: string
nullable: true
description: >-
Categoria de alto risco com maior peso, ou `null` quando nenhuma
predomina (por exemplo, `sanctioned`, `mixer`, `stolen_funds`).
risk_factors:
type: array
description: >-
Explicação ordenada de `risk_score`: o que levou a este veredito. Os
provedores avaliam um endereço com o próprio modelo e retornam
apenas um veredito (a Merkle Science retorna um inteiro de 0 a 5),
então a pontuação sozinha não permite agir. A ordem é primeiro os de
alto risco, depois o valor que passou por cada fator, limitada aos
cinco mais fortes; `source_of_funds` e `destination_of_funds` sempre
trazem o detalhamento completo. Um `risk_score` alto sem nenhuma
entrada `is_high_risk` significa que o provedor não informou
correspondência com sanções nem com entidade atribuída e avaliou o
endereço apenas com o próprio modelo de exposição. O `summary`
informa isso explicitamente.
items:
type: object
properties:
source:
type: string
enum:
- attribution
- exposure
description: >-
`attribution` é o que o provedor diz que o próprio endereço é
(sua própria tag ou cluster); `exposure` é para onde seus
fundos de fato se moveram.
category:
type: string
description: >-
Categoria de risco normalizada, com o mesmo vocabulário do
detalhamento de exposição.
label:
type: string
description: >-
A descrição do próprio provedor para o fator (por exemplo,
`Gambling / Crypto only`), que é o que você também veria no
console do provedor.
entity_name:
type: string
nullable: true
description: >-
Entidade atribuída por trás do fator, por exemplo, um site de
apostas ou uma exchange.
direction:
type: string
enum:
- incoming
- outgoing
- connected
- unknown
- attribution
description: >-
Direção do fluxo de fundos, `attribution` quando o fator
determinante é a própria tag do endereço, ou `unknown` quando
o provedor não informou uma direção.
exposure_type:
type: string
enum:
- direct
- indirect
- unknown
- attribution
description: >-
`direct` (1 salto) ou `indirect` (vários saltos),
`attribution` para a tag do próprio endereço, ou `unknown`
quando o provedor não informou a quantos saltos de distância a
contraparte está. Trate `unknown` como não classificado, e não
como `direct`.
amount_usd:
type: number
format: float
nullable: true
description: Valor em USD atribuído a este fator.
percentage:
type: number
format: float
description: >-
Participação no volume TOTAL analisado do endereço, somando as
duas direções, ao contrário de `percentage` dentro de
`source_of_funds`/`destination_of_funds`, que é normalizado
por direção. Comparável e somável em toda a lista.
is_high_risk:
type: boolean
description: >-
Se a categoria é uma das que a Didit trata como de alto risco
(`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`,
`darknet_market`, `terrorist_financing`, `child_exploitation`,
`hacked_exchange`, `high_risk_exchange`, `seized_funds`).
description:
type: string
description: >-
Representação em uma linha do fator determinante, por exemplo
`9.01% indirect outgoing exposure to Gambling / Crypto only
(Example Gambling)`.
raw_response:
type: object
additionalProperties: true
description: >-
O payload próprio do provedor. O formato dele é específico de cada
provedor e pode mudar sem aviso: leia os campos normalizados em vez
de interpretá-lo.
report_signature:
type: string
description: >-
Assinatura HMAC-SHA256 opaca sobre exatamente este resultado,
restrita à sua aplicação. Não tem significado por si só: reenvie o
corpo completo da resposta, sem modificações e incluindo este campo,
para `POST /v3/wallet-screening/pdf/` para gerá-lo como PDF. O
endpoint de PDF rejeita a requisição com `400` se `report_signature`
estiver ausente ou se qualquer campo assinado (por exemplo,
`risk_score`, `severity`, `sanctions_hit`) tiver sido editado antes
do reenvio.
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: >-
Chave de API da sua aplicação, em Developers -> API keys no Business
Console. A chave principal tem acesso total. Uma chave nomeada pode ter
escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
uma data de validade. 401 significa que a chave está errada, revogada ou
expirada; 403 significa que nenhuma chave foi enviada, que a chave não
tem acesso a este recurso ou ação, ou que a requisição veio de um
endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
que a sessão está fora dos fluxos ou status da chave. Uma chave sem
acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
sem permissão de escrita em sessões recebe links e tokens de sessão como
null. Consulte https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.