Quick Start Guide

Get started with SanctionsWise API in under 5 minutes. This guide walks you through your first sanctions screening request.

---

Prerequisites

• API key from AWS Marketplace or app.orchestraprime.ai
• HTTP client (curl, Postman, or your language's HTTP library)

---

Step 1: Verify API Access

Test that your API key is working:

curl "https://api.orchestraprime.ai/sanctionswise/health" \
  -H "x-api-key: YOUR_API_KEY"

Expected Response:

{
  "status": "healthy",
  "environment": "production",
  "version": "1.0.0",
  "matching_algorithms": ["exact", "fuzzy", "phonetic", "semantic", "identifier"],
  "endpoints": {
    "/screen/entity": {"methods": ["POST"], "description": "Screen single entity"},
    "/screen/batch": {"methods": ["POST"], "description": "Screen batch (up to 100)"}
  },
  "timestamp": "2025-12-10T19:00:00Z"
}

---

Step 2: Screen Your First Entity

Screen an individual against OFAC sanctions lists:

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/entity" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith",
    "entity_type": "individual",
    "threshold": 0.85
  }'

Clear Response (No Match):

{
  "screening_id": "SCR-20251210190000-12345678",
  "status": "clear",
  "query": {
    "name": "John Smith",
    "entity_type": "individual",
    "threshold": 0.85,
    "lists_screened": ["ofac_sdn"]
  },
  "matches": [],
  "match_count": 0,
  "timestamp": "2025-12-10T19:00:00.000000Z",
  "processing_time_ms": 45,
  "data_freshness": {
    "last_update": "2025-12-10T17:26:38Z"
  }
}

---

Step 3: Screen a Known Sanctioned Entity

Test with a known OFAC SDN entry to verify matching:

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/entity" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vladimir Putin",
    "entity_type": "individual",
    "threshold": 0.60
  }'

Match Response:

{
  "screening_id": "SCR-20251210185252-2FFDC8AE",
  "status": "potential_match",
  "query": {
    "name": "Vladimir Putin",
    "entity_type": "individual",
    "threshold": 0.60,
    "lists_screened": ["ofac_sdn"]
  },
  "matches": [
    {
      "entity_id": "sw_ofac_sdn_35096",
      "matched_name": "VLADIMIR VLADIMIROVICH PUTIN",
      "confidence_score": 0.7714,
      "match_type": "fuzzy+semantic",
      "entity_details": {
        "primary_name": "VLADIMIR VLADIMIROVICH PUTIN",
        "entity_type": "individual",
        "nationality": "Russia",
        "programs": ["RUSSIA-EO14024", "UKRAINE-EO13660"],
        "listing_date": "2022-02-25"
      },
      "source_evidence": {
        "source_authority": "US Treasury OFAC",
        "source_list_id": "ofac_sdn",
        "source_entry_uid": "sw_ofac_sdn_35096",
        "last_updated": "2025-12-10T17:26:38Z"
      }
    }
  ],
  "match_count": 10,
  "timestamp": "2025-12-10T18:52:52.527387Z",
  "processing_time_ms": 378,
  "data_freshness": {
    "last_update": "2025-12-10T17:26:38Z"
  }
}

---

Step 4: Screen with Identifiers

Enhance matching accuracy by including document numbers:

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/entity" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "entity_type": "individual",
    "threshold": 0.80,
    "identifiers": {
      "passport": "AB1234567",
      "date_of_birth": "1965-03-15"
    }
  }'

When identifiers match, the confidence score receives a +15% boost and the match type becomes identifier_confirmed.

---

Step 5: Screen Organizations

Screen companies and organizations:

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/entity" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bank of Russia",
    "entity_type": "organization",
    "threshold": 0.70
  }'

---

Step 6: Batch Screening

Screen multiple entities in a single request (up to 100):

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/batch" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entities": [
      {"name": "Vladimir Putin", "entity_type": "individual"},
      {"name": "Bank of Russia", "entity_type": "organization"},
      {"name": "Sergey Lavrov", "entity_type": "individual"},
      {"name": "John Smith", "entity_type": "individual"},
      {"name": "Acme Corporation", "entity_type": "organization"}
    ],
    "options": {
      "threshold": 0.60,
      "lists": ["ofac_sdn"],
      "max_results_per_entity": 3
    }
  }'

Batch Response:

{
  "batch_id": "BATCH-20251210183031-DEBF51ED",
  "status": "completed",
  "results": [
    {
      "index": 0,
      "query": {"name": "Vladimir Putin", "entity_type": "individual"},
      "status": "potential_match",
      "match_count": 3,
      "matches": [...]
    },
    {
      "index": 3,
      "query": {"name": "John Smith", "entity_type": "individual"},
      "status": "clear",
      "match_count": 0,
      "matches": []
    }
  ],
  "summary": {
    "total": 5,
    "clear": 2,
    "matches": 0,
    "potential_matches": 3
  },
  "processing_time_ms": 49,
  "entities_per_second": 102.04
}

---

Understanding Response Status

Status	Meaning	Recommended Action
clear	No matches above threshold	Proceed with transaction
match	High-confidence match (≥95%)	Block and escalate
potential_match	Matches found requiring review	Manual review required

---

Setting Confidence Thresholds

The threshold parameter controls match sensitivity:

Threshold	Use Case	Expected False Positives
0.95+	Automated pass-through	Very low
0.85	Standard screening	Low
0.70	Enhanced due diligence	Moderate
0.60	Investigation mode	Higher

Recommendation

Start with 0.85 for most use cases.

---

Next Steps

1. API Reference - Complete endpoint documentation
2. Matching Algorithms - How our 5-layer matching works
3. Evidence Chain - Source traceability for compliance
4. Best Practices - Optimize your screening workflow

---

Support

• Email: support@orchestraprime.ai
• Documentation: docs-sanctionswise.orchestraprime.ai
• API Key Management: app.orchestraprime.ai

---

SanctionsWise API is a product of OrchestraPrime LLC