> ## 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 AML: Sanções e PEP

> A Didit analisa utilizadores em 1,300+ listas globais de sanções e PEP em tempo real. $0.20 por chamada, 2 pontuações de risco, sem contratos.

A Triagem AML da Didit verifica uma pessoa em tempo real face a 1,300+ fontes globais de sanções, PEP e listas de vigilância, bem como notícias adversas, e devolve cada correspondência potencial com duas pontuações: uma pontuação de correspondência para a probabilidade de a correspondência ser a mesma pessoa e uma pontuação de risco para o nível de risco da entidade listada.

Prompt de integração da Triagem AML
        Copiar o prompt para a área de transferência



      
      

\<pre>

\````# Goal
Integrate Didit AML Screening (PEP, sanctions, warnings, adverse media) into your app. Pick ONE mode.

\# Mode A — Session-based
Run AML as a step inside a verification session. Decisions, ongoing monitoring, and audit history are bound to the session and surfaced in the Business Console.

1\. Add the AML feature to the workflow (Business Console or POST /v3/workflows/). Configure thresholds: aml_match_score_threshold, aml_score_approve_threshold, aml_score_review_threshold, and the weights aml_name_weight + aml_dob_weight + aml_country_weight (must sum to 100).
2\. Create a session — POST /v3/session/ with { workflow_id, vendor_data, callback }. See /sessions-api/create-session.
3\. Fetch the decision — GET /v3/session/{sessionId}/decision/ or subscribe to session.status.updated.

Decision surface: `aml_screenings[]` array on the decision payload.

\# Mode B — Standalone API (server-to-server)
Use when you want a one-shot AML check decoupled from a hosted KYC flow.

POST https://verification.didit.me/v3/aml/
x-api-key: YOUR_API_KEY
Content-Type: application/json

curl example:
\```bash
curl -X POST 'https://verification.didit.me/v3/aml/' \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"full_name": "Javier Ejemplo Modelo",
"entity_type": "person",
"date_of_birth": "1974-01-01",
"nationality": "ES",
"include_adverse_media": true,
"vendor_data": "user-1234"
}'
\```
Returns: { request_id, aml: { status, screening_id, hits: [...], warnings: [...] } }.

\# Important policy rules
\- aml_name_weight + aml_dob_weight + aml_country_weight must equal exactly 100 — request rejected with HTTP 400 otherwise.
\- include_adverse_media=true increases latency to ~25s; use a client timeout of at least 45s.
\- include_ongoing_monitoring=true keeps the entity under daily re-screening at **$0.07 per year per screened entity** (billing alert) and requires save_api_request=true (HTTP 400 otherwise). Disable from the Business Console.

\# Status enum (per aml_screenings[].status / aml.status)
"Not Started" | "In Progress" | "Approved" | "In Review" | "Declined" | "Abandoned" | "Kyc Expired"

\# Warnings (LogWarningChoices.AML)
warnings[] risk codes include:
POSSIBLE_MATCH_FOUND, MATCH_FOUND, HIGH_RISK_COUNTRY, ADVERSE_MEDIA_HIT, SANCTIONED_ENTITY, PEP_MATCH, ONGOING_MONITORING_ENABLED.
Full catalogue: /core-technology/aml-screening/warnings-aml-screening.

\# Failure modes to handle
\- HTTP 400 — weights don't sum to 100; ongoing_monitoring without save_api_request.
\- HTTP 403 — out of credits.
\- status="Declined" — at least one hit's risk_score ≥ aml_score_review_threshold and crossed the decline boundary.
\- status="In Review" — risk_score between approve and review thresholds; route to manual queue.
\- Adverse-media timeout — the upstream provider was slow; the result returns without adverse-media hits (still actionable).

\# See also
\- Canonical schema: /reference/data-models#aml-screening
\- Per-feature report: /core-technology/aml-screening/report-aml-screening
\- Risk catalogue: /core-technology/aml-screening/warnings-aml-screening
\- Ongoing monitoring: /core-technology/aml-screening/continuous-monitoring-aml-screening
\- Full integration playbook: /integration/integration-prompt````

\</pre>



      
      

Colar em

A aula da Academy sobre a leitura de um resultado de verificação aborda a triagem AML aos 8:40: sanções, PEP e notícias adversas numa sessão real.[Triagem AML: sanções, PEP e notícias adversas — Didit Academy](https://www.youtube.com/embed/7htTWCWsl60?start=520\&rel=0\&playsinline=1)![Tabela de fontes de listas de vigilância da triagem AML da Didit, incluindo sanções da OFAC, UE e ONU e listas de PEP](https://mintcdn.com/didit-0f962782/z6T2GHM4Zh-iSj-K/images/aml-list-table.jpeg?fit=max\&auto=format\&n=z6T2GHM4Zh-iSj-K\&q=85\&s=b254abf5bb564018e15588ef7c56f92e)## Conceitos-chave: pontuação de correspondência vs pontuação de riscoA Didit utiliza um **sistema de duas pontuações** para a triagem AML:### Pontuação de correspondência (confiança na identidade)- **Pergunta:** Esta correspondência é a mesma pessoa que estamos a verificar?
- **Fatores:** Semelhança do nome, data de nascimento, país/nacionalidade, número do documento
- **Objetivo:** Classifica a correspondência como **Falso positivo** ou **Não revisto** (correspondência possível)
- **Limiar:** Limiar da pontuação de correspondência (predefinição: 93)### Pontuação de risco (nível de risco da entidade)- **Pergunta:** Quão arriscada é esta entidade se for uma correspondência real?
- **Fatores:** Risco do país, categoria (PEP/Sanções/etc.), registos criminais
- **Objetivo:** Determina o **estado final de AML** (Aprovada/Em análise/Recusada)
- **Limiares:** Limiar de aprovação (predefinição: 80) e Limiar de análise (predefinição: 100)```
┌─────────────────────────────────────────────────────────────────────────────┐
│                           AML SCREENING FLOW                                │
├─────────────────────────────────────────────────────────────────────────────┤
│                                                                             │
│  STEP 1: Screen against watchlists                                          │
│     └── Returns potential matches (match score ≥ 75% included)              │
│                                                                             │
│  STEP 2: For each match, calculate MATCH SCORE                              │
│     └── Match Score = (Name × W1) + (DOB × W2) + (Country × W3)             │
│                                                                             │
│  STEP 3: Classify match by match score                                      │
│     ├── Match Score < 93 → FALSE POSITIVE (excluded from risk)              │
│     └── Match Score ≥ 93 → UNREVIEWED (included in risk)                    │
│                                                                             │
│  STEP 4: For unreviewed matches, calculate RISK SCORE                       │
│     └── Risk Score = (Country × 30%) + (Category × 50%) + (Criminal × 20%)  │
│                                                                             │
│  STEP 5: Determine AML STATUS (highest risk score among non-FP matches)     │
│     ├── Risk Score < 86 → APPROVED                                          │
│     ├── 86 ≤ Risk Score ≤ 100 → IN REVIEW                                   │
│     └── Risk Score > 100 → DECLINED                                         │
│                                                                             │
└─────────────────────────────────────────────────────────────────────────────┘
```## Estados de revisão da correspondênciaA cada correspondência de AML é atribuído um estado de revisão com base na sua pontuação de correspondência:| Estado | Descrição | Quando é atribuído |
| - | - | - |
| **Falso positivo** | É provável que não seja a mesma pessoa | Pontuação de correspondência \< limiar (atribuído automaticamente) |
| **Não revisto** | É possível que se trate de uma correspondência, pelo que requer revisão | Pontuação de correspondência ≥ limiar (atribuído automaticamente) |
| **Correspondência confirmada** | Foi verificado que a correspondência é a mesma pessoa | Definido manualmente pelo responsável pela conformidade |
| **Inconclusivo** | Não foi possível determinar se a correspondência é a mesma pessoa | Definido manualmente pelo responsável pela conformidade |> [!NOTE]
>
> ### **Dica:** Pode alterar o estado de revisão de uma correspondência na Consola ao visualizar a visão geral de AML ou ao clicar numa correspondência específica para ver os seus detalhes.## Principais funcionalidades### 1. Extração abrangente de dados- **Extração precisa**: Extraia dados de informações fornecidas pelo utilizador ou de documentos de identidade através de tecnologia OCR avançada.
- **Lógica difusa**: Tenha em conta variações de nomes e erros ortográficos para garantir uma recolha de dados abrangente.### 2. Cobertura alargada de listas de vigilânciaFaça a triagem com base em múltiplas categorias, incluindo:- **Listas de sanções**: De organismos governamentais e internacionais.
- **Pessoas politicamente expostas (PEPs)**: Indivíduos com cargos públicos de destaque.
- **Registos criminais**: Incluindo bases de dados criminais globais e locais.
- **Menções em notícias adversas**: Artigos de notícias e relatórios sobre crimes financeiros e outros riscos.
- **Listas de vigilância personalizadas**: Configuráveis com base nos requisitos específicos do cliente.### 3. Algoritmos de correspondência avançados- **Correspondência difusa**: Detete ligeiras variações em nomes ou dados para garantir uma correspondência precisa.
- **Múltiplos pontos de dados**: Utilize o nome, a data de nascimento, a nacionalidade e outros identificadores para uma triagem minuciosa.
- **Lógica de chave mestra (Golden Key)**: Correspondência do número de documento que pode sobrepor-se às pontuações para uma identificação definitiva.### 4. Avaliação de risco com duas pontuaçõesCada correspondência recebe DUAS pontuações:| Pontuação | Finalidade | Classificação |
| - | - | - |
| **Pontuação de correspondência** (0-100) | Trata-se da mesma pessoa? | Falso positivo vs Não revista |
| **Pontuação de risco** (0-100) | Qual o nível de risco desta entidade? | Determina o estado final de AML |**Estado de revisão da correspondência (com base na pontuação de correspondência):**- **Falso positivo**: Pontuação de correspondência abaixo do limiar - provavelmente NÃO é a mesma pessoa
- **Não revista**: Pontuação de correspondência igual ou superior ao limiar - requer revisão**Estado final de AML (com base na pontuação de risco mais elevada entre correspondências que não sejam falsas positivas):**- **Aprovada**: Todas as correspondências não revistas têm pontuações de risco baixas
- **Em análise**: Pelo menos uma correspondência não revista tem pontuação de risco média-alta
- **Recusada**: Pelo menos uma correspondência não revista tem pontuação de risco muito alta### 5. Triagem detalhada de notícias adversasFaça a triagem com base numa vasta gama de categorias de notícias adversas, incluindo:- **Crimes financeiros**: Branqueamento de capitais, peculato e muito mais.
- **Crimes violentos**: Agressão, homicídio e infrações relacionadas.
- **Terrorismo**: Envolvimento em ou apoio a atividades terroristas.
- **Narcóticos**: Tráfico de droga e crimes conexos.
- **Fraude**: Vários tipos de fraude e práticas enganosas.
- **Violações regulamentares**: Infrações a requisitos de conformidade regulamentar.### 6. Parâmetros de triagem personalizáveis- **Sensibilidade ajustável**: Configure a sensibilidade da triagem com base no apetite ao risco da sua organização.
- **Listas de vigilância personalizáveis**: Selecione quais as listas de vigilância e categorias a incluir no processo de triagem para cumprir requisitos específicos.### Limiares configuráveisPode personalizar os níveis de segurança configurando diferentes limiares:**Configuração da pontuação de correspondência:**| Definição | Predefinição | Descrição |
| - | - | - |
| Limiar da pontuação de correspondência | 93 | As correspondências abaixo deste valor são falsos positivos; as que estão no limiar ou acima são não revistas |
| Peso do nome | 60 | Peso do nome na pontuação de correspondência |
| Peso da data de nascimento | 25 | Peso da data de nascimento na pontuação de correspondência |
| Peso do país | 15 | Peso do país na pontuação de correspondência |**Limiares da pontuação de risco (estado final):**| Definição | Predefinição | Descrição |
| - | - | - |
| Limiar de aprovação | 80 | Pontuações de risco inferiores = Aprovada |
| Limiar de análise | 100 | Pontuações de risco superiores = Recusada; intermédias = Em análise |![Limiares da pontuação de risco AML da Didit para os estados Aprovada, Em análise e Recusada](https://mintcdn.com/didit-0f962782/z6T2GHM4Zh-iSj-K/images/aml-risk-score.png?fit=max\&auto=format\&n=z6T2GHM4Zh-iSj-K\&q=85\&s=297acc5d98dcd0f038597c4f2d953f46)> [!NOTE]
>
> Estes limiares podem ser ajustados com base na sua tolerância ao risco e nos seus requisitos de segurança.## Como funcionaO nosso processo de Triagem AML identifica eficientemente potenciais riscos, minimizando em simultâneo os atrasos para utilizadores legítimos.**1. Extração de dados**O sistema extrai informações relevantes a partir de dados fornecidos pelo utilizador ou de documentos de identidade carregados.| Entrada | Método |
| - | - |
| **Documentos de identidade** | Tecnologia OCR avançada para uma extração precisa de dados |
| **Dados fornecidos pelo utilizador** | Introdução direta (nome, data de nascimento, nacionalidade, número do documento) |
| **Lógica difusa** | Tem em conta variações e erros ortográficos nos nomes |**2. Triagem em listas de vigilância**Os dados extraídos são cruzados com **1,300+ listas de vigilância globais** e bases de dados em tempo real:- **Listas de sanções** — Organismos governamentais e internacionais (OFAC, UE, ONU, etc.)
- **Pessoas politicamente expostas (PEPs)** — Indivíduos com funções públicas de destaque
- **Registos criminais** — Bases de dados criminais globais e locais
- **Notícias adversas** — Artigos noticiosos e relatórios sobre crimes financeiros
- **Listas de vigilância personalizadas** — Configuráveis com base nos seus requisitos**3. Cálculo da pontuação de correspondência**Para cada correspondência potencial, o sistema calcula uma **pontuação de confiança de identidade** — a probabilidade de se tratar da mesma pessoa.| Fator | Peso predefinido | Descrição |
| - | :-: | - |
| **Semelhança do nome** | 60% | Correspondência aproximada que tem em conta variações |
| **Data de nascimento** | 25% | Comparação exata ou parcial da data de nascimento |
| **País/Nacionalidade** | 15% | Comparação do país de origem |- Pontuação de correspondência **abaixo do limiar** (predefinição: 93) → a correspondência é classificada como **falso positivo**
- Pontuação de correspondência **igual ou acima do limiar** → a correspondência é classificada como **não revista** (possível correspondência)
- **Chave Dourada**: A correspondência do número do documento pode substituir a pontuação e defini-la como 100% para uma identificação definitiva**4. Cálculo da pontuação de risco**Para correspondências que não sejam falsos positivos, o sistema calcula o **nível de risco** da entidade:| Fator | Peso | Descrição |
| - | :-: | - |
| **Categoria** | 50% | Nível de PEP, tipo de sanções, gravidade criminal |
| **Risco do país** | 30% | Classificação de risco dos países associados |
| **Registos criminais** | 20% | Presença e gravidade de antecedentes criminais |**5. Determinação do estado final**Com base na **pontuação de risco mais elevada** entre todas as correspondências que não sejam falsos positivos:| Pontuação de risco | Estado | Ação |
| :-: | - | - |
| Abaixo do limiar de aprovação | **Aprovada** | Autorizado automaticamente, sem risco credível |
| Entre limiares | **Em análise** | Sinalizado para revisão manual de conformidade |
| Acima do limiar de revisão | **Recusada** | Risco elevado, rejeição automática |Se **todas** as correspondências forem falsos positivos, o resultado é **Aprovada** (nenhuma correspondência credível encontrada).**6. Geração do resultado**É gerado um relatório detalhado com total transparência:- A **pontuação de correspondência** e a **pontuação de risco** de cada correspondência com detalhamento
- Classificação da correspondência (Falso positivo vs. Não revista vs. Confirmada)
- Base de dados de origem e detalhes da categoria para cada resultado
- Resultados entregues via **resposta da API**, **webhook** ou **Business Console**
- Tomada de decisão automática com base nos seus limiares de pontuação de risco configurados## Referência de dados de correspondências AMLCada correspondência AML retornada na resposta da API contém informações detalhadas sobre a entidade correspondente. Abaixo encontram-se os principais campos e os seus valores possíveis.### Categorias de conjuntos de dadosO campo `datasets` em cada correspondência indica em que categorias de bases de dados de conformidade a entidade foi encontrada. Valores possíveis:| Valor | Descrição |
| - | - |
| `PEP` | Pessoa politicamente exposta (geral) |
| `PEP Level 1` | Chefes de estado, políticos de topo, juízes de tribunais supremos |
| `PEP Level 2` | Membros do parlamento, embaixadores, líderes militares |
| `PEP Level 3` | Funcionários da administração local, funcionários públicos de nível intermédio |
| `PEP Level 4` | RCA (Familiares e Pessoas Próximas) de indivíduos PEP |
| `Sanctions` | Listas de sanções internacionais e nacionais (OFAC, UE, ONU, etc.) |
| `Adverse Media` | Notícias adversas e relatórios relacionados com crimes financeiros |
| `Warnings and Regulatory Enforcement` | Avisos regulamentares, ações de execução coerciva e alertas de conformidade |
| `Fitness and Probity` | Registos de idoneidade e probidade mantidos por reguladores financeiros |
| `SIP` | Listas de pessoas de interesse especial |
| `SIE` | Listas de entidades de interesse especial |
| `Insolvency` | Registos de insolvência e falência |### Correspondências de sançõesO array `sanction_matches` contém detalhes sobre cada lista de sanções em que a entidade foi encontrada. Campos principais:| Campo | Tipo | Descrição |
| - | - | - |
| `list_name` | `string[]` | Nome(s) da(s) lista(s) de sanções |
| `matched_name` | `string` | Nome tal como aparece na lista de sanções |
| `description` | `string` | Descrição do registo de sanção |
| `reason` | `string` | Motivo em texto livre pelo qual a entidade foi sancionada. Não se trata de um enum — os valores provêm diretamente da autoridade sancionadora e descrevem os fundamentos específicos da inclusão na lista (por exemplo, "Executive Order 13224 (Terrorism)", "Support for actions undermining Ukraine's sovereignty"). |
| `legal_basis` | `string[]` | Base jurídica da sanção |
| `sanction_program` | `string[]` | Programa(s) de sanções em que a entidade está listada |
| `sanctioning_authority` | `string[]` | Autoridade que impôs a sanção |
| `listed_on` | `string[]` | Data(s) em que a entidade foi listada |
| `source_url` | `string` | URL para a fonte |### Correspondências de avisosO array `warning_matches` contém detalhes sobre correspondências provenientes de listas de avisos, medidas regulamentares e listas afins. O campo `additional_data` pode incluir um array `data.case_details` com informações estruturadas sobre o caso.#### Tipos de casos de avisoO campo `case_type` em `additional_data.data.case_details[]` descreve a natureza do caso de aviso. Valores conhecidos:| Valor | Descrição |
| - | - |
| `Accusation` | Acusação ou imputação formal |
| `Arrest` | Registo de detenção |
| `Bribery` | Caso relacionado com suborno |
| `Criminal` | Caso criminal geral |
| `Fraud` | Caso relacionado com fraude |
| `Illegal Fundraising` | Atividade de angariação ilegal de fundos |
| `Non-conviction Terror` | Inclusão em lista relacionada com terrorismo sem condenação |
| `Proclaimed Offender` | Infrator oficialmente declarado |
| `Regulatory Enforcement` | Ação de aplicação da regulamentação |
| `Terrorism` | Caso relacionado com terrorismo |
| `Terrorism-related` | Relacionado com atividades terroristas |
| `Terrorism-related listing` | Incluído numa lista por ligação ao terrorismo |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.