SANCTIONSKIT FOR DEVELOPERS
Sanctions screening API documentation
Send your first screening request, choose source coverage, and connect results to review. Find working examples, request and response fields, and error handling for each workflow.
Make your first sandbox screening.
Create a sandbox key and send an invented person or company. Read which fields matched, which sources were checked and which dataset version was used.
Make your first screening{
"subject": {
"name": "Alex Morgan",
"entityType": "person",
"birthDate": "1984"
},
"package": "sandbox@1"
}Screen one subject
Build the JSON request, choose coverage, and handle success or a validation error.
Explore the guideScreen a batch
Send rows in a request or upload a file. Check progress, then read each row’s result or error.
Explore the guideMonitor for changes
Create monitors, control their schedule, and process change notifications.
Explore the guideReceive webhooks
Set up a receiving endpoint, check message signatures and handle repeated deliveries safely.
Explore the guideRetrieve and export evidence
Read retained results, page through history, and download reports and case archives.
Explore the guideBuild with your AI agent
Connect MCP for documentation, current schemas, and synthetic sandbox tools.
Explore the guideBUILD WITH YOUR TOOLS
A shorter path to your first request.
Choose an API client, install an SDK, or start from an example project. Use your own sandbox key to try screening with synthetic data.
Postman
Fork the collection, import its sandbox environment, and add your sandbox API key.
Run in Postman (opens in a new tab)
Bruno
Open the collection in Bruno and keep your requests alongside your code.
Fetch in Bruno (opens in a new tab)
Node.js & TypeScript
Add the official SDK to your JavaScript or TypeScript backend.
npm install sanctionskitView SDK on npm (opens in a new tab)
OpenAPI
Use the API specification with your own tooling or generate a client.
Download OpenAPI
Bruno opens in the desktop app. Install it before fetching a collection.
Using n8n? Try the screening workflow with the SanctionsKit community node.
Questions about using the API documentation
Where should I start with the sanctions screening API?
Follow the quickstart to create a live key, choose an available source and send one request. It uses your free lifetime checks. The optional sandbox example uses made-up records. Inspect the result and any error, then choose a guide for single checks, batches or monitoring.
Should I read the guides or the API reference?
Use a guide to understand a workflow and its sequence of steps. Use the API reference to check exact headers, fields, responses and errors. Both matter: a valid request still needs the right source selection and a clear path for reviewing a potential match.
How should my integration handle a failed check?
Keep a potential match, a completed no-match result and an error as separate outcomes. An unavailable source or invalid request leaves the check incomplete. Follow the error guidance and retry rules before allowing your application to move to its next step.