Skip to main content

Overview

The Watchlist API screens individuals and entities against global sanctions lists, PEP databases, and adverse media sources for AML/CFT compliance.

Quick Start

const result = await txcloud.watchlist.screen({
  type: 'individual',
  name: 'Mohammed El Amrani',
  date_of_birth: '1990-05-15',
  country: 'MA'
});

console.log('Status:', result.status);  // 'clear' or 'potential_match'
console.log('Matches:', result.matches.length);

Screening Response

{
  "id": "scr_a1b2c3d4",
  "status": "clear",
  "risk_level": "low",
  
  "entity": {
    "type": "individual",
    "name": "Mohammed El Amrani",
    "date_of_birth": "1990-05-15",
    "country": "MA"
  },
  
  "checks": {
    "sanctions": { "status": "clear", "matches": 0 },
    "pep": { "status": "clear", "matches": 0 },
    "adverse_media": { "status": "clear", "matches": 0 }
  },
  
  "matches": []
}

Handling Matches

if (result.status === 'potential_match') {
  for (const match of result.matches) {
    console.log(`Match: ${match.name}`);
    console.log(`List: ${match.list_name}`);
    console.log(`Score: ${match.similarity_score}`);
    
    // Review and resolve
    await txcloud.watchlist.matches.resolve(match.id, {
      resolution: 'false_positive',  // or 'true_positive', 'escalate'
      notes: 'Different person - verified by ID check'
    });
  }
}

Watchlists Covered

ListTypeCoverage
OFAC SDNSanctionsGlobal
UN ConsolidatedSanctionsGlobal
EU SanctionsSanctionsEU
HMT SanctionsSanctionsUK
PEP ListsPoliticalGlobal
Adverse MediaNegative NewsGlobal

Batch Screening

Screen multiple entities at once:
const batch = await txcloud.watchlist.screenBatch({
  entities: [
    { type: 'individual', name: 'Person 1' },
    { type: 'individual', name: 'Person 2' },
    { type: 'entity', name: 'Company ABC' }
  ]
});

console.log(`Screened: ${batch.total}`);
console.log(`Matches: ${batch.with_matches}`);

Ongoing Monitoring

Subscribe to continuous monitoring:
await txcloud.watchlist.monitor.subscribe({
  entity: {
    type: 'individual',
    name: 'Mohammed El Amrani'
  },
  lists: ['sanctions', 'pep', 'adverse_media'],
  webhook_url: 'https://yourapp.com/webhooks/watchlist'
});

Best Practices

Screen all customers during initial onboarding.
Set up monitoring for long-term customer relationships.
Always record resolution decisions with notes for audit trail.

Next Steps