Skip to main content

API Playground

The API Playground lets you test SanctionsWise screening endpoints directly from your browser without writing any code. It's the fastest way to screen entities and verify your integration logic.

Accessing the Playground​

  1. Log in to your dashboard
  2. Select SanctionsWise from the product selector
  3. Click API Playground in the navigation menu

Playground Features​

FeatureDescription
Endpoint SelectionChoose from all screening endpoints
Request BuilderBuild requests with an intuitive form
Live ResponseSee real screening results instantly
cURL ExportCopy ready-to-use cURL commands
HistoryView your recent screenings

Making Your First Screening​

Step 1: Select an Endpoint​

Choose an endpoint from the dropdown menu:

  • Screen Entity (POST /v1/screen/entity) - Screen a single entity
  • Batch Screen (POST /v1/screen/batch) - Screen multiple entities
  • Get Entity (GET /v1/entities/{id}) - Get sanctioned entity details
  • List Sources (GET /v1/lists) - List available sanctions lists

Step 2: Configure Parameters​

Based on the selected endpoint, fill in the required parameters:

For Screen Entity:

ParameterRequiredDescription
nameYesEntity name to screen
entity_typeYesindividual, organization, or vessel
thresholdNoMatch threshold (default: 0.85)
countryNoFilter by country

Step 3: Send Request​

Click Send Request to execute the screening.

Step 4: Review Response​

The response panel shows:

  • Status Code: HTTP status (200, 400, 401, etc.)
  • Response Time: How long the screening took
  • Match Status: clear, match, or potential_match
  • Matches: List of matched sanctioned entities

Example: Screening an Individual​

Let's screen an individual name against sanctions lists:

1. Select Endpoint​

Choose POST /v1/screen/entity

2. Enter Parameters​

{
  "name": "Viktor Bout",
  "entity_type": "individual",
  "threshold": 0.85
}

3. Send and View Results​

Click Send Request. You'll see results like:

{
  "screening_id": "scr_abc123",
  "status": "match",
  "matches": [
    {
      "entity_id": "ofac-sdn-12345",
      "name": "BOUT, Viktor Anatoliyevich",
      "score": 0.98,
      "list_id": "ofac_sdn",
      "list_name": "OFAC SDN List",
      "entity_type": "individual",
      "programs": ["SDGT"],
      "aliases": [
        "Viktor BOUT",
        "Victor BOUT"
      ]
    }
  ],
  "lists_checked": ["ofac_sdn", "ofac_consolidated", "bis_entity"],
  "timestamp": "2026-01-23T10:30:00Z"
}

Example: Screening an Organization​

Screen a company name:

Parameters​

{
  "name": "Huawei Technologies",
  "entity_type": "organization",
  "threshold": 0.80
}

Response​

{
  "screening_id": "scr_xyz789",
  "status": "match",
  "matches": [
    {
      "entity_id": "bis-ent-5678",
      "name": "Huawei Technologies Co., Ltd.",
      "score": 0.95,
      "list_id": "bis_entity",
      "list_name": "BIS Entity List",
      "entity_type": "organization",
      "country": "China"
    }
  ],
  "lists_checked": ["ofac_sdn", "ofac_consolidated", "bis_entity"],
  "timestamp": "2026-01-23T10:35:00Z"
}

Understanding Match Scores​

Score RangeInterpretation
0.95 - 1.00Exact or near-exact match
0.85 - 0.94High confidence match
0.70 - 0.84Potential match (review recommended)
Below 0.70Low confidence (typically filtered out)

Threshold Settings​

Adjust the threshold based on your risk tolerance:

ThresholdUse Case
0.95High volume, low false positives
0.85Balanced (recommended default)
0.70Comprehensive screening
0.60Maximum coverage (more false positives)

Copying cURL Commands​

To use the same request outside the Playground:

  1. Configure your request
  2. Click Copy as cURL
  3. Paste into your terminal

Example cURL command:

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

Understanding Error Responses​

400 Bad Request​

{
  "error": "Bad Request",
  "message": "Missing required parameter: name",
  "code": "MISSING_PARAMETER"
}

Solution: Check that all required parameters are provided.

401 Unauthorized​

{
  "error": "Unauthorized",
  "message": "Invalid API key",
  "code": "INVALID_API_KEY"
}

Solution: Verify your API key is correct.

429 Too Many Requests​

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded",
  "code": "RATE_LIMIT_EXCEEDED"
}

Solution: Wait and retry, or upgrade your tier for higher limits.

Tips for Using the Playground​

  1. Test Name Variations: Try different spellings and transliterations
  2. Adjust Thresholds: Lower thresholds catch more variations but increase false positives
  3. Use Entity Type: Setting the correct entity type improves accuracy
  4. Check Response Time: Monitor latency to optimize your integration
  5. Export for Code: Use the cURL export to build your integration

Available Endpoints​

EndpointMethodDescription
/v1/screen/entityPOSTScreen a single entity
/v1/screen/batchPOSTScreen multiple entities (up to 100)
/v1/entities/{id}GETGet details of a sanctioned entity
/v1/listsGETList available sanctions lists
/v1/lists/{id}/changesGETGet recent changes to a list

For detailed endpoint documentation, see the API Reference.

Playground vs Production​

The Playground uses your real API key and counts against your quota. However:

  • Requests are made from your browser
  • API key is automatically included
  • Rate limits apply as normal

Next Steps​