Dokumentacja API Isarud
Weryfikacja sankcji i API analizy ryzyka.
Multi-Platform Access
Access your screening data and trade compliance tools from any device.
Uwierzytelnianie
Wszystkie żądania API wymagają tokena Bearer. Wygeneruj swój klucz API z Panelu (wymagany plan Business).
Authorization: Bearer YOUR_API_KEY
Adres URL
https://isarud.com/api/v1
All requests must use HTTPS. Responses are JSON.
Punkty końcowe
/v1/screen
Weryfikuj pojedynczą nazwę względem wszystkich list sankcji.
Request
{
"name": "Ali Khamenei",
"type": "individual"
}
Response
{
"success": true,
"data": {
"query": "Ali Khamenei",
"total_matches": 3,
"results": [
{
"name": "Ali Hosseini KHAMENEI",
"list": "OFAC SDN",
"score": 95,
"type": "individual",
"country": "IR"
}
]
}
}
name (required) — Entity name to screen. type (optional) — individual or entity.
/v1/screen/{id}
Retrieve details of a previous screening by ID.
/v1/screen/batch
Weryfikuj zbiorczo do 500 nazw. Tablica JSON lub CSV.
Request
{
"names": ["Name One", "Name Two", "Name Three"]
}
Response
{
"success": true,
"data": {
"total": 3,
"results": [
{"name": "Name One", "matches": 0},
{"name": "Name Two", "matches": 2},
{"name": "Name Three", "matches": 0}
]
}
}
/v1/briefs
Pobierz najnowsze briefy analizy ryzyka.
/v1/briefs/{id}
Retrieve a specific OSINT risk brief by ID.
/v1/lists
Pobierz metadane list sankcji i datę ostatniej aktualizacji.
Response
{
"success": true,
"data": [
{"code": "ofac_sdn", "name": "OFAC SDN", "count": 12450},
{"code": "eu", "name": "EU Consolidated", "count": 8200},
{"code": "un", "name": "UN Security Council", "count": 1850},
{"code": "uk_hmt", "name": "UK HMT", "count": 4100},
{"code": "ca_sema", "name": "Canada SEMA", "count": 2300},
{"code": "au_dfat", "name": "Australia DFAT", "count": 1100},
{"code": "world_bank", "name": "World Bank", "count": 950},
{"code": "ofac_cons", "name": "OFAC Consolidated", "count": 1602}
]
}
/v1/lists/{list}/updates
Get recent updates for a specific sanctions list (e.g. ofac_sdn, eu).
/v1/favorites
Zapisz nazwę do automatycznej ponownej weryfikacji.
/v1/favorites
Add an entity to your favorites watchlist.
/v1/favorites/{id}
Remove an entity from your favorites.
/v1/alerts
Retrieve your screening alerts and notifications.
/v1/webhooks
List your configured webhooks.
/v1/webhooks
Zarejestruj webhook dla powiadomień w czasie rzeczywistym.
Request
{
"url": "https://yoursite.com/webhook",
"events": ["screening.match", "list.updated"]
}
/v1/webhooks/{id}
Update a webhook configuration.
/v1/webhooks/{id}
Delete a webhook.
/v1/webhooks/{id}/test
Send a test event to your webhook endpoint.
Error Codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | Request successful |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | Invalid parameters or missing required fields |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | Insufficient plan or credits exhausted |
| 404 | Not Found | Resource not found |
| 422 | Unprocessable | Validation error |
| 429 | Too Many Requests | Rate limit exceeded |
Error responses include a JSON body: {"success": false, "message": "Error description"}
Limity szybkości
| Plan | Requests | Screenings |
|---|---|---|
| Free | 10 req/min | 10/month |
| Pro ($29/mo) | 100 req/min | 100/month |
| Business ($99/mo) | 1,000 req/min | Unlimited |
Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Sanctions Lists Coverage
32,500+ entities across 8 global sanctions lists:
OFAC SDN
OFAC Consolidated
EU Consolidated
UN Security Council
UK HMT
Canada SEMA
Australia DFAT
World Bank
Szybki start
cURL
curl -X POST https://isarud.com/api/v1/screen \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Ali Khamenei", "type": "individual"}'
Python
import requests
r = requests.post("https://isarud.com/api/v1/screen",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"name": "Ali Khamenei", "type": "individual"})
print(r.json())
Node.js
const res = await fetch("https://isarud.com/api/v1/screen", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({ name: "Ali Khamenei", type: "individual" })
});
console.log(await res.json());
PHP (Laravel)
$response = Http::withHeaders([
'Authorization' => 'Bearer YOUR_API_KEY',
])->post('https://isarud.com/api/v1/screen', [
'name' => 'Ali Khamenei',
'type' => 'individual',
]);
return $response->json();
WooCommerce & Shopify Integration
No API coding required — use our plugins for automatic order screening and marketplace sync.