Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
New: French documentation now available! Switch to French
AML/CFT screening against sanctions, PEP databases, and adverse media
https://api.txcloud.io/v1/watchlist
https://sandbox.api.txcloud.io/v1/watchlist
curl https://api.txcloud.io/v1/watchlist/screen \
-H "Authorization: Bearer txc_live_your_api_key"
import TXCloud from '@txcloud/sdk';
const txcloud = new TXCloud('your_api_key');
const result = await txcloud.watchlist.screen({
entity: {
type: 'individual',
name: 'John Doe',
date_of_birth: '1980-01-15',
nationality: 'US'
},
lists: ['sanctions', 'pep', 'adverse_media'],
threshold: 0.85
});
console.log(result.status); // 'clear'
console.log(result.matches); // []
| Method | Endpoint | Description |
|---|---|---|
| POST | /watchlist/screen | Screen an entity |
| POST | /watchlist/screen/batch | Batch screening |
| GET | /watchlist/screen/{id} | Get screening result |
| POST | /watchlist/matches/{id}/resolve | Resolve a match |
| POST | /watchlist/monitor/subscribe | Subscribe to monitoring |
| GET | /watchlist/lists | List available watchlists |