API Documentation

Quick Start - cURL

# Screen an entity
curl -X POST https://api.signation.tech/v1/screen \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Vladimir Putin", "type": "person"}'

# Get screening result
curl https://api.signation.tech/v1/screen/REQUEST_ID \
  -H "X-API-Key: YOUR_API_KEY"

# List alerts
curl https://api.signation.tech/v1/alerts \
  -H "X-API-Key: YOUR_API_KEY"

Quick Start - TypeScript

const API_KEY = 'sk_your_api_key';
const API_URL = 'https://api.signation.tech';

// Screen an entity
const response = await fetch(`${API_URL}/v1/screen`, {
  method: 'POST',
  headers: {
    'X-API-Key': API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Vladimir Putin',
    type: 'person',
  }),
});

const { requestId } = await response.json();

// Poll for result
const result = await fetch(
  `${API_URL}/v1/screen/${requestId}`,
  { headers: { 'X-API-Key': API_KEY } }
).then(r => r.json());

console.log(result.results);