{ "info": { "name": "Verifex Shield API", "description": "Fraud and AML transaction monitoring. Native API under /v1 (Bearer API key) and the SanctionScanner-compatible API under /api (Basic: API key id + the same secret).\n\n1. Set `api_key` (and `api_key_id` for the compat folders).\n2. Shield is enabled per account: without it every request answers 404.\n3. Tune a rule: Native — rules → simulate, then GET the simulation until `Completed`, then PATCH the rule with the same change and `simulation_id`.\n\nGenerated from the API's own route table; do not edit by hand.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://api.verifex.dev" }, { "key": "api_key", "value": "" }, { "key": "api_key_id", "value": "" }, { "key": "ruleset_key", "value": "" }, { "key": "rule_id", "value": "" }, { "key": "simulation_id", "value": "" }, { "key": "case_id", "value": "" }, { "key": "decision_id", "value": "" }, { "key": "transaction_id", "value": "" }, { "key": "customer_number", "value": "CUST-1001" } ], "item": [ { "name": "Compat — Account", "item": [ { "name": "POST /api/Account/AddAccountBalance", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Account/AddAccountBalance", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "AddAccountBalance" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Account/AddNewAccount", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Account/AddNewAccount", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "AddNewAccount" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/Account/Case/Blacklist/{accountNumber}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/Account/Case/Blacklist/:accountNumber", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "Case", "Blacklist", ":accountNumber" ], "variable": [ { "key": "accountNumber", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Account/Case/Blacklist/{accountNumber}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Account/Case/Blacklist/:accountNumber", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "Case", "Blacklist", ":accountNumber" ], "variable": [ { "key": "accountNumber", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/Account/Case/Whitelist/{accountNumber}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/Account/Case/Whitelist/:accountNumber", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "Case", "Whitelist", ":accountNumber" ], "variable": [ { "key": "accountNumber", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Account/Case/Whitelist/{accountNumber}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Account/Case/Whitelist/:accountNumber", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "Case", "Whitelist", ":accountNumber" ], "variable": [ { "key": "accountNumber", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Account/GetAccount", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Account/GetAccount", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "GetAccount" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Account/UpdateAccount", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Account/UpdateAccount", "host": [ "{{base_url}}" ], "path": [ "api", "Account", "UpdateAccount" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Capsule", "item": [ { "name": "GET /api/Capsule/{capsuleId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Capsule/:capsuleId", "host": [ "{{base_url}}" ], "path": [ "api", "Capsule", ":capsuleId" ], "variable": [ { "key": "capsuleId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Customer", "item": [ { "name": "POST /api/v2/Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/Customer", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"{{customer_number}}\",\n \"customerTypeId\": 1,\n \"customerName\": \"Aysel Mammadova\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /api/v2/Customer/{customerNumber}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Customer/{customerNumber}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/Customer/{customerNumber}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Customer/{customerNumber}/Activate", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber/Activate", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber", "Activate" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Customer/{customerNumber}/Deactivate", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber/Deactivate", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber", "Deactivate" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Customer/{customerNumber}/ScoreBreakdown", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/:customerNumber/ScoreBreakdown", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", ":customerNumber", "ScoreBreakdown" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/Customer/Case/Blacklist/{customerNumber}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/Case/Blacklist/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Case", "Blacklist", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Customer/Case/Blacklist/{customerNumber}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/Case/Blacklist/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Case", "Blacklist", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/Customer/Case/Whitelist/{customerNumber}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/Case/Whitelist/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Case", "Whitelist", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Customer/Case/Whitelist/{customerNumber}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Customer/Case/Whitelist/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Case", "Whitelist", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Customer/Risk/Add/{customerNumber}", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/Customer/Risk/Add/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Risk", "Add", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"score\": 10,\n \"description\": \"Adverse media mention\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /api/v2/Customer/Risk/Deduct/{customerNumber}", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/Customer/Risk/Deduct/:customerNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Customer", "Risk", "Deduct", ":customerNumber" ], "variable": [ { "key": "customerNumber", "value": "{{customer_number}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"score\": 5,\n \"description\": \"Documents re-verified\"\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Feedback", "item": [ { "name": "POST /api/Feedback", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/Feedback", "host": [ "{{base_url}}" ], "path": [ "api", "Feedback" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"{{transaction_id}}\",\n \"outcome\": \"legit\"\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / Customer", "item": [ { "name": "GET /api/v2/General/Customer/RiskThreshold", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Customer/RiskThreshold", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Customer", "RiskThreshold" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/General/Customer/RiskThreshold", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Customer/RiskThreshold", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Customer", "RiskThreshold" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / Tags", "item": [ { "name": "GET /api/v2/General/Tags", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Tags", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Tags" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/General/Tags", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Tags", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Tags" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / Team", "item": [ { "name": "GET /api/v2/General/Team", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Team", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Team" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/General/Team", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Team", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Team" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / Transaction", "item": [ { "name": "GET /api/General/Transaction/Currency", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Currency", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Currency" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/CurrencyRiskLevel", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/CurrencyRiskLevel", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "CurrencyRiskLevel" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/CurrencyRiskLevel/Batch/{batchId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/CurrencyRiskLevel/Batch/:batchId", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "CurrencyRiskLevel", "Batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/CurrencyRiskLevel/BatchTemplate", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/CurrencyRiskLevel/BatchTemplate", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "CurrencyRiskLevel", "BatchTemplate" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/CurrencyRiskLevel/BatchUpload", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/CurrencyRiskLevel/BatchUpload", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "CurrencyRiskLevel", "BatchUpload" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Mcc/Batch/{batchId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Mcc/Batch/:batchId", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Mcc", "Batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/Mcc/BatchUpload", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Mcc/BatchUpload", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Mcc", "BatchUpload" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/MccCode", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/MccCode", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "MccCode" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Metadata", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Metadata" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/RiskThreshold", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/RiskThreshold", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "RiskThreshold" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/RiskThreshold", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/General/Transaction/RiskThreshold", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "RiskThreshold" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"veryLow\": 1,\n \"low\": 41,\n \"medium\": 71,\n \"high\": 86,\n \"critical\": 150\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/General/Transaction/Rule", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/Rule", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/General/Transaction/Rule/{guid}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Rule/{guid}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/General/Transaction/Rule/{guid}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Rule/{guid}/History", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid/History", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid", "History" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/Rule/{guid}/Simulate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid/Simulate", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid", "Simulate" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"threshold\": 800000\n },\n \"days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const j = pm.response.json();", "if (j.result && j.result.simulationId) pm.collectionVariables.set('simulation_id', j.result.simulationId);" ] } } ] }, { "name": "GET /api/General/Transaction/Rule/{guid}/Simulations", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/:guid/Simulations", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", ":guid", "Simulations" ], "variable": [ { "key": "guid", "value": "{{rule_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Rule/Features", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/Features", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", "Features" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Rule/Simulation/{simulationId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Rule/Simulation/:simulationId", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Rule", "Simulation", ":simulationId" ], "variable": [ { "key": "simulationId", "value": "{{simulation_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/General/Transaction/Ruleset", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Ruleset", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Ruleset" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/General/Transaction/Ruleset", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Ruleset", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Ruleset" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/General/Transaction/Ruleset/{ruleSetGuid}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/General/Transaction/Ruleset/:ruleSetGuid", "host": [ "{{base_url}}" ], "path": [ "api", "General", "Transaction", "Ruleset", ":ruleSetGuid" ], "variable": [ { "key": "ruleSetGuid", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / User", "item": [ { "name": "GET /api/v2/General/User", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/User", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "User" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/General/User", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/User", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "User" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/General/User/{guid}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/User/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "User", ":guid" ], "variable": [ { "key": "guid", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — General / Webhook", "item": [ { "name": "GET /api/v2/General/Webhook", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Webhook", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Webhook" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/General/Webhook", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Webhook", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Webhook" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/General/Webhook/{guid}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Webhook/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Webhook", ":guid" ], "variable": [ { "key": "guid", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/General/Webhook/{guid}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Webhook/:guid", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Webhook", ":guid" ], "variable": [ { "key": "guid", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/General/Webhook/TriggerHistory", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/General/Webhook/TriggerHistory", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "General", "Webhook", "TriggerHistory" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Report", "item": [ { "name": "GET /api/v2/Report/Behaviour/{scenarioId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Report/Behaviour/:scenarioId", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Report", "Behaviour", ":scenarioId" ], "variable": [ { "key": "scenarioId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Report/Statistics", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Report/Statistics", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Report", "Statistics" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Scan", "item": [ { "name": "GET /api/v2/Scan/{scanId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/:scanId", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", ":scanId" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/AdverseMedia", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/AdverseMedia", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "AdverseMedia" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/AdverseMedia/{scanId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/AdverseMedia/:scanId", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "AdverseMedia", ":scanId" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/ByDocument", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/ByDocument", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "ByDocument" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/ByName", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/ByName", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "ByName" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/ByName", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/ByName", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "ByName" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/ByReferenceNumber", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/ByReferenceNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "ByReferenceNumber" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/Scan/Case/{scanId}/Assign/{userId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Assign/:userId", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Assign", ":userId" ], "variable": [ { "key": "scanId", "value": "" }, { "key": "userId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/Scan/Case/{scanId}/Close", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Close", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Close" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/Case/{scanId}/History", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/History", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "History" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/Scan/Case/{scanId}/MatchStatus/{matchStatus}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/MatchStatus/:matchStatus", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "MatchStatus", ":matchStatus" ], "variable": [ { "key": "scanId", "value": "" }, { "key": "matchStatus", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/Case/{scanId}/MemoNote", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/MemoNote", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "MemoNote" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/Case/{scanId}/MemoNote", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/MemoNote", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "MemoNote" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/Scan/Case/{scanId}/MemoNote/{memoId}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/MemoNote/:memoId", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "MemoNote", ":memoId" ], "variable": [ { "key": "scanId", "value": "" }, { "key": "memoId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/Case/{scanId}/Open", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Open", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Open" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/Scan/Case/{scanId}/ReferenceNumber", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/ReferenceNumber", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "ReferenceNumber" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/v2/Scan/Case/{scanId}/RiskLevel/{riskLevel}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/RiskLevel/:riskLevel", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "RiskLevel", ":riskLevel" ], "variable": [ { "key": "scanId", "value": "" }, { "key": "riskLevel", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/v2/Scan/Case/{scanId}/Tag", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Tag", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Tag" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/v2/Scan/Case/{scanId}/Tag", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Tag", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Tag" ], "variable": [ { "key": "scanId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "DELETE /api/v2/Scan/Case/{scanId}/Tag/{tagGuid}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/api/v2/Scan/Case/:scanId/Tag/:tagGuid", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "Scan", "Case", ":scanId", "Tag", ":tagGuid" ], "variable": [ { "key": "scanId", "value": "" }, { "key": "tagGuid", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Session", "item": [ { "name": "POST /api/Session/ExecuteSession", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Session/ExecuteSession", "host": [ "{{base_url}}" ], "path": [ "api", "Session", "ExecuteSession" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Compat — Transaction", "item": [ { "name": "GET /api/Transaction/Batch/{batchId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/Batch/:batchId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "Batch", ":batchId" ], "variable": [ { "key": "batchId", "value": "" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/BatchUpload", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/BatchUpload", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "BatchUpload" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/Case/Assign", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/Case/Assign", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "Case", "Assign" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/ChangeTransaction/{transactionId}", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/Transaction/ChangeTransaction/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "ChangeTransaction", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"transactionID\": \"{{transaction_id}}\",\n \"transactionDate\": \"{{$isoTimestamp}}\",\n \"amount\": \"150.00\",\n \"amountCurrencyCode\": 944,\n \"direction\": 2,\n \"source\": 1,\n \"channel\": 1,\n \"triggeredRuleSetKey\": \"{{ruleset_key}}\",\n \"originatorNumber\": \"{{customer_number}}\",\n \"originator\": \"Aysel Mammadova\",\n \"originatorAccountCurrencyCode\": 944,\n \"beneficiary\": \"Kamran Aliyev\",\n \"beneficiaryAccountNumber\": \"ACC-1002\",\n \"beneficiaryAccountCurrencyCode\": 944\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /api/Transaction/CloseCase/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/CloseCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "CloseCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/CloseCase/{transactionId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/CloseCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "CloseCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/CloseCase/{transactionId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/CloseCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "CloseCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/ConvertToCase/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/ConvertToCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "ConvertToCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/ConvertToCase/{transactionId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/ConvertToCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "ConvertToCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/ConvertToCase/{transactionId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/ConvertToCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "ConvertToCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/Detail/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/Detail/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "Detail", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/ExecuteTransaction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/Transaction/ExecuteTransaction", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "ExecuteTransaction" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md.", "body": { "mode": "raw", "raw": "{\n \"transactionID\": \"TXN-{{$guid}}\",\n \"transactionDate\": \"{{$isoTimestamp}}\",\n \"amount\": \"125.50\",\n \"amountCurrencyCode\": 944,\n \"direction\": 2,\n \"source\": 1,\n \"channel\": 1,\n \"triggeredRuleSetKey\": \"{{ruleset_key}}\",\n \"originatorNumber\": \"{{customer_number}}\",\n \"originator\": \"Aysel Mammadova\",\n \"originatorAccountCurrencyCode\": 944,\n \"beneficiary\": \"Kamran Aliyev\",\n \"beneficiaryAccountNumber\": \"ACC-1002\",\n \"beneficiaryAccountCurrencyCode\": 944\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const j = pm.response.json();", "if (j.result && j.result.transactionId) pm.collectionVariables.set('transaction_id', j.result.transactionId);" ] } } ] }, { "name": "GET /api/Transaction/Replay/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/Replay/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "Replay", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/Resend/{transactionId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/Resend/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "Resend", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/TransactionConvertCase/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionConvertCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionConvertCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/TransactionConvertCase/{transactionId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionConvertCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionConvertCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/TransactionConvertCase/{transactionId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionConvertCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionConvertCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/TransactionExists", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionExists", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionExists" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/TransactionRemoveCase/{transactionId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionRemoveCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionRemoveCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/TransactionRemoveCase/{transactionId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionRemoveCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionRemoveCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/TransactionRemoveCase/{transactionId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/TransactionRemoveCase/:transactionId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "TransactionRemoveCase", ":transactionId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/UpdateMatchStatus/{transactionId}/{matchStatusId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateMatchStatus/:transactionId/:matchStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateMatchStatus", ":transactionId", ":matchStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "matchStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/UpdateMatchStatus/{transactionId}/{matchStatusId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateMatchStatus/:transactionId/:matchStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateMatchStatus", ":transactionId", ":matchStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "matchStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/UpdateMatchStatus/{transactionId}/{matchStatusId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateMatchStatus/:transactionId/:matchStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateMatchStatus", ":transactionId", ":matchStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "matchStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "GET /api/Transaction/UpdateStatus/{transactionId}/{transactionStatusId}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateStatus/:transactionId/:transactionStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateStatus", ":transactionId", ":transactionStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "transactionStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/UpdateStatus/{transactionId}/{transactionStatusId}", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateStatus/:transactionId/:transactionStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateStatus", ":transactionId", ":transactionStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "transactionStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "PUT /api/Transaction/UpdateStatus/{transactionId}/{transactionStatusId}", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateStatus/:transactionId/:transactionStatusId", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateStatus", ":transactionId", ":transactionStatusId" ], "variable": [ { "key": "transactionId", "value": "{{transaction_id}}" }, { "key": "transactionStatusId", "value": "2" } ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/UpdateTransactionAssignUser", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateTransactionAssignUser", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateTransactionAssignUser" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/UpdateTransactionAssingUser", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateTransactionAssingUser", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateTransactionAssingUser" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/UpdateTransactionTag", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/UpdateTransactionTag", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "UpdateTransactionTag" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } }, { "name": "POST /api/Transaction/v2/Case/Tag", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/api/Transaction/v2/Case/Tag", "host": [ "{{base_url}}" ], "path": [ "api", "Transaction", "v2", "Case", "Tag" ] }, "description": "SanctionScanner-compatible endpoint (SS response envelope). Contract: docs/api/internal-api/shield-compat-v1.md." } } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{api_key_id}}", "type": "string" }, { "key": "password", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — alarm-thresholds", "item": [ { "name": "GET /v1/risk/alarm-thresholds", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/alarm-thresholds", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "alarm-thresholds" ] }, "description": "Alarm thresholds: the totalScore at or above which a decision's triggered alarm is VeryLow … Critical" } }, { "name": "PUT /v1/risk/alarm-thresholds", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/alarm-thresholds", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "alarm-thresholds" ] }, "description": "Set alarm thresholds { veryLow, low, medium, high, critical } (non-decreasing). Takes effect on the next decision.", "body": { "mode": "raw", "raw": "{\n \"veryLow\": 1,\n \"low\": 41,\n \"medium\": 71,\n \"high\": 86,\n \"critical\": 150\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — blacklist", "item": [ { "name": "GET /v1/risk/blacklist", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/blacklist", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "blacklist" ] }, "description": "List active (non-removed) blacklist entries for this tenant" } }, { "name": "POST /v1/risk/blacklist", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/blacklist", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "blacklist" ] }, "description": "Add a blacklist entry (analyst action, reason required)", "body": { "mode": "raw", "raw": "{\n \"key_type\": \"customer\",\n \"value\": \"{{customer_number}}\",\n \"reason\": \"Confirmed fraud\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v1/risk/blacklist/{id}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/risk/blacklist/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "blacklist", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Remove a blacklist entry (soft delete, audit-logged)" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — cases", "item": [ { "name": "GET /v1/risk/cases", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/cases", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "cases" ] }, "description": "List Shield cases for this tenant" } }, { "name": "GET /v1/risk/cases/{id}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/cases/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "cases", ":id" ], "variable": [ { "key": "id", "value": "{{case_id}}" } ] }, "description": "Retrieve a Shield case with its decision" } }, { "name": "PATCH /v1/risk/cases/{id}", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/cases/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "cases", ":id" ], "variable": [ { "key": "id", "value": "{{case_id}}" } ] }, "description": "Update a Shield case: status, verdict, match status, assignee, team, tags, note, reopen", "body": { "mode": "raw", "raw": "{\n \"status\": \"investigating\",\n \"note\": \"Called the customer; waiting for documents.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /v1/risk/cases/{id}/decision", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/cases/:id/decision", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "cases", ":id", "decision" ], "variable": [ { "key": "id", "value": "{{case_id}}" } ] }, "description": "Record an analyst decision on a Shield case" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — currency-risk-levels", "item": [ { "name": "GET /v1/risk/currency-risk-levels", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/currency-risk-levels", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "currency-risk-levels" ] }, "description": "The account's currency risk levels" } }, { "name": "PUT /v1/risk/currency-risk-levels", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/currency-risk-levels", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "currency-risk-levels" ] }, "description": "Set currency risk levels: { items: [{ currencyCode (AZN or 944), riskLevel: Low|Medium|High }] }. An empty level is ignored.", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"currencyCode\": \"USD\",\n \"riskLevel\": \"Medium\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v1/risk/currency-risk-levels/{code}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/risk/currency-risk-levels/:code", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "currency-risk-levels", ":code" ], "variable": [ { "key": "code", "value": "" } ] }, "description": "Remove a currency's risk level" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — customer-risk-thresholds", "item": [ { "name": "GET /v1/risk/customer-risk-thresholds", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/customer-risk-thresholds", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "customer-risk-thresholds" ] }, "description": "Customer risk-level thresholds (score at or above: 1 VeryLow … 5 Critical)" } }, { "name": "PUT /v1/risk/customer-risk-thresholds", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/customer-risk-thresholds", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "customer-risk-thresholds" ] }, "description": "Set customer risk-level thresholds", "body": { "mode": "raw", "raw": "{\n \"veryLow\": 1,\n \"low\": 20,\n \"medium\": 40,\n \"high\": 60,\n \"critical\": 80\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — customers", "item": [ { "name": "GET /v1/risk/customers/{customer}/baseline", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/customers/:customer/baseline", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "customers", ":customer", "baseline" ], "variable": [ { "key": "customer", "value": "{{customer_number}}" } ] }, "description": "A customer's behavioural baseline (what 'normal' is for TXN_11/12/14)" } }, { "name": "GET /v1/risk/customers/{customer}/risk", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/customers/:customer/risk", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "customers", ":customer", "risk" ], "variable": [ { "key": "customer", "value": "{{customer_number}}" } ] }, "description": "A registered customer's risk score, level and every adjustment behind it" } }, { "name": "POST /v1/risk/customers/{customer}/risk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/customers/:customer/risk", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "customers", ":customer", "risk" ], "variable": [ { "key": "customer", "value": "{{customer_number}}" } ] }, "description": "Raise or lower a registered customer's risk score: { delta (non-zero integer), reason }", "body": { "mode": "raw", "raw": "{\n \"delta\": 10,\n \"reason\": \"Adverse media mention\"\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — decisions", "item": [ { "name": "GET /v1/risk/decisions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/decisions", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "decisions" ] }, "description": "List Shield decisions (server-side filters, keyset pagination, counts over the full range)" } }, { "name": "GET /v1/risk/decisions/{id}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/decisions/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "decisions", ":id" ], "variable": [ { "key": "id", "value": "{{decision_id}}" } ] }, "description": "Retrieve a Shield decision (with evidence capsule)" } }, { "name": "GET /v1/risk/decisions/{id}/replay", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/decisions/:id/replay", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "decisions", ":id", "replay" ], "variable": [ { "key": "id", "value": "{{decision_id}}" } ] }, "description": "Replay a Shield decision from its capsule and the rule versions it recorded" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — events", "item": [ { "name": "GET /v1/risk/events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/events", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "events" ] }, "description": "List Shield events for this tenant, with their latest decision" } }, { "name": "POST /v1/risk/events", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/events", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "events" ] }, "description": "Ingest an event and receive a Shield decision" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — feedback", "item": [ { "name": "POST /v1/risk/feedback", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/feedback", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "feedback" ] }, "description": "Report the real-world outcome of a past decision" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — mcc-codes", "item": [ { "name": "GET /v1/risk/mcc-codes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/mcc-codes", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "mcc-codes" ] }, "description": "The account's MCC table (risk level 1 Low, 2 Medium, 3 High)" } }, { "name": "PUT /v1/risk/mcc-codes", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/mcc-codes", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "mcc-codes" ] }, "description": "Add or update MCC codes: { items: [{ mccCode, name, description?, riskLevel: Low|Medium|High, dailySectorAverage? }] }. Invalid rows are skipped and reported.", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"mccCode\": 7995,\n \"name\": \"Betting and casino gambling\",\n \"riskLevel\": \"High\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v1/risk/mcc-codes/{code}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/risk/mcc-codes/:code", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "mcc-codes", ":code" ], "variable": [ { "key": "code", "value": "" } ] }, "description": "Remove an MCC code from the table" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — operators", "item": [ { "name": "GET /v1/risk/operators", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/operators", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "operators" ] }, "description": "Case assignees (the tenant's review team directory)" } }, { "name": "POST /v1/risk/operators", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/operators", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "operators" ] }, "description": "Add a case assignee" } }, { "name": "DELETE /v1/risk/operators/{id}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/risk/operators/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "operators", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Deactivate a case assignee" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — reports", "item": [ { "name": "GET /v1/risk/reports/behaviour", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/reports/behaviour", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "reports", "behaviour" ] }, "description": "AML behaviour report S1–S4 for a month (json, csv or xlsx)" } }, { "name": "GET /v1/risk/reports/monthly", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/reports/monthly", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "reports", "monthly" ] }, "description": "Monthly Shield summary: decisions by outcome, alarms, cases, verdicts and AML firings" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — rules", "item": [ { "name": "GET /v1/risk/rules", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/rules", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules" ] }, "description": "List the tenant's Shield rules with their definitions" } }, { "name": "GET /v1/risk/rules/{id}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/rules/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules", ":id" ], "variable": [ { "key": "id", "value": "{{rule_id}}" } ] }, "description": "Retrieve one Shield rule (by rule GUID)" } }, { "name": "PATCH /v1/risk/rules/{id}", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/rules/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules", ":id" ], "variable": [ { "key": "id", "value": "{{rule_id}}" } ] }, "description": "Tune a Shield rule (params, score, mode, condition). Requires rationale and approvedBy; takes effect on the next decision.", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"threshold\": 800000\n },\n \"simulationId\": \"{{simulation_id}}\",\n \"rationale\": \"Raise the high-value threshold after a 30-day simulation\",\n \"approvedBy\": \"Head of Compliance\",\n \"expectedVersion\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /v1/risk/rules/{id}/simulate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/rules/:id/simulate", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules", ":id", "simulate" ], "variable": [ { "key": "id", "value": "{{rule_id}}" } ] }, "description": "Simulate a proposed rule change over the last N days (default 30) of decisions. Queued; poll GET /v1/risk/simulations/:id. Deploy the same change with PATCH /v1/risk/rules/:id and simulationId.", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"threshold\": 800000\n },\n \"days\": 30\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const j = pm.response.json();", "if (j.simulationId) pm.collectionVariables.set('simulation_id', j.simulationId);" ] } } ] }, { "name": "GET /v1/risk/rules/{id}/simulations", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/rules/:id/simulations", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules", ":id", "simulations" ], "variable": [ { "key": "id", "value": "{{rule_id}}" } ] }, "description": "A rule's recent simulations (newest first)" } }, { "name": "GET /v1/risk/rules/{id}/versions", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/rules/:id/versions", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "rules", ":id", "versions" ], "variable": [ { "key": "id", "value": "{{rule_id}}" } ] }, "description": "A Shield rule's Parameter Register (every version, who changed and approved it, why)" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — schema", "item": [ { "name": "GET /v1/risk/schema/events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/schema/events", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "schema", "events" ] }, "description": "Runtime schema discovery: accepted transaction fields, rule features, operators" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — settings", "item": [ { "name": "GET /v1/risk/settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "settings" ] }, "description": "Shield settings: AML time zone and case SLA hours" } }, { "name": "PUT /v1/risk/settings", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/settings", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "settings" ] }, "description": "Update Shield settings. A time-zone change affects months of events received from now on; past months keep the zone they were counted in.", "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Asia/Baku\"\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — simulations", "item": [ { "name": "GET /v1/risk/simulations/{id}", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/simulations/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "simulations", ":id" ], "variable": [ { "key": "id", "value": "{{simulation_id}}" } ] }, "description": "One simulation: status and, once completed, the comparison" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — tags", "item": [ { "name": "GET /v1/risk/tags", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/tags", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "tags" ] }, "description": "Case tags" } }, { "name": "POST /v1/risk/tags", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/tags", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "tags" ] }, "description": "Add a case tag" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — teams", "item": [ { "name": "GET /v1/risk/teams", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "teams" ] }, "description": "Review teams" } }, { "name": "POST /v1/risk/teams", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/v1/risk/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "teams" ] }, "description": "Add a review team" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — webhook-events", "item": [ { "name": "GET /v1/risk/webhook-events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/webhook-events", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "webhook-events" ] }, "description": "The webhook events Shield emits, with what each means" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — webhooks", "item": [ { "name": "GET /v1/webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks" ] }, "description": "List all webhooks" } }, { "name": "POST /v1/webhooks", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks" ] }, "description": "Register a new webhook", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/verifex/shield\",\n \"events\": [\n \"transaction.alert_updated\",\n \"risk.case.opened\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /v1/webhooks/deliveries", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/webhooks/deliveries", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks", "deliveries" ] }, "description": "List recent webhook delivery attempts" } }, { "name": "DELETE /v1/webhooks/{id}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Delete a webhook" } }, { "name": "PATCH /v1/webhooks/{id}", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Change a webhook's events or pause/resume it", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"transaction.alert_updated\",\n \"case.closed\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } }, { "name": "Native — whitelist", "item": [ { "name": "GET /v1/risk/whitelist", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/v1/risk/whitelist", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "whitelist" ] }, "description": "List active whitelist entries" } }, { "name": "POST /v1/risk/whitelist", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/risk/whitelist", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "whitelist" ] }, "description": "Add a whitelist entry (lowers a behaviour-driven outcome one step; never sanctions or a blacklist hit)", "body": { "mode": "raw", "raw": "{\n \"key_type\": \"customer\",\n \"value\": \"{{customer_number}}\",\n \"reason\": \"Payroll account, reviewed\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v1/risk/whitelist/{id}", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/v1/risk/whitelist/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "risk", "whitelist", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Remove a whitelist entry (soft delete, audit-logged)" } } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] } } ] }