Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.txcloud.thetekcircle.io/llms.txt

Use this file to discover all available pages before exploring further.

The Watchlist API provides comprehensive AML/CFT screening against global sanctions lists, PEP databases, and adverse media sources.

​
Key Features

Sanctions Screening

Screen against OFAC, UN, EU, and 200+ global lists

PEP Database

Identify Politically Exposed Persons

Adverse Media

Monitor negative news and media coverage

Ongoing Monitoring

Continuous monitoring with real-time alerts

​
Base URL

https://api.txcloud.io/v1/watchlist
For testing, use the sandbox environment: 
https://sandbox.api.txcloud.io/v1/watchlist

​
Authentication

All requests require a Bearer token: 
curl https://api.txcloud.io/v1/watchlist/screen \
  -H "Authorization: Bearer txc_live_your_api_key"

​
Quick Start

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); // []

​
Endpoints

MethodEndpointDescription
POST/watchlist/screenScreen an entity
POST/watchlist/screen/batchBatch screening
GET/watchlist/screen/{id}Get screening result
POST/watchlist/matches/{id}/resolveResolve a match
POST/watchlist/monitor/subscribeSubscribe to monitoring
GET/watchlist/listsList available watchlists