SanctionIQ API

Intro

What is SanctionIQ and how does the API fit?

Overview

High‑level behaviour of SanctionIQ.

• Clients submit personal (or company) details in a structured payload.
• SanctionIQ searches across sanctions lists, PEP databases, adverse media, regulatory sources, Interpol, and open web in near‑real‑time.
• We compile a report and deliver it via POST callback or Email, in your chosen format.
• Average completion time: 2–3 minutes per request (translation adds ~30–60s).

Request Lifecycle

How a request flows through the SanctionIQ platform.

1. Request submitted
   Client sends a POST request to the API with subject data and authentication details.
2. Validation
   The API validates:
   • API key and email match
   • Account plan and API access permissions
   • Available credits
3. Immediate response
   If valid, the API returns 200 OK immediately and the request is queued for processing.
4. Processing
   SanctionIQ performs multi-source screening and builds the report.
5. Delivery
   The result is delivered via:
   • POST callback to responseURL
   • Email to the registered address
6. Failure handling
   If processing or delivery fails, credits are automatically refunded.

Quickstart

Copy
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "country": "Gibraltar",
    "firstname": "John",
    "lastname": "Smith",
    "extra": "CEO of Company X",
    "strict": false,
    "APIKey": "ABC123456",
    "email": "client@example.com",
    "responseType": "POST",
    "responseURL": "https://yourapp.com/response/clientId=123456",
    "responseFormat": "JSON"
  }' \
  "SanctionIQ-Endpoint"

Copy
await fetch("SanctionIQ-Endpoint", {
  method: "POST",
  headers: {"Content-Type":"application/json"},
  body: JSON.stringify({
    country:"Gibraltar",
    firstname:"John",
    strict:false,
    lastname:"Smith",
    APIKey:"ABC123456",
    email:"client@example.com",
    responseType:"POST",
    responseURL:"https://yourapp.com/callback",
    responseFormat:"JSON"
  })
});

Copy
import requests
url = "SanctionIQ-Endpoint"
payload = {
  "country":"Gibraltar",
  "firstname":"John",
  "lastname":"Smith",
  "extra":"CEO of Company X",
  "strict": False,
  "APIKey":"ABC123456",
  "email":"client@example.com",
  "responseType":"POST",
  "responseURL":"https://yourapp.com/response/clientId=123456",
  "responseFormat":"JSON"
}
requests.post(url, json=payload).raise_for_status()

Endpoint

HTTPS POST · Content-Type: application/json

CopyAPI endpoints are available once API access is enabled in your account.

Alternative (no‑code): email report@sanctioniq.io — see Email mode.

Dev / Test Endpoint

Test integrations without consuming live credits.

Copy
https://api.sanctioniq.io/api/v1/dev/report

• Returns mock responses matching the live API structure
• Does not consume paid credits
• Monthly dev usage limits apply

Authentication

Include a valid APIKey and your registered email in the request body. These are validated together. If they don't match, you'll receive 401 Unauthorized.
Requests are also validated against your account plan, API access permissions, and available credits.

Copy{
  "APIKey": "abc12345-secure-key-9876",
  "email":  "client@example.com"
}

Request Payload Schema

Required and optional fields.

Required

Optional

Example Request

Copy{
  "country": "Gibraltar",
  "firstname": "John",
  "lastname": "Smith",
  "extra": "CEO of Company X",
  "strict": false,
  "APIKey": "ABC123456",
  "email": "client@example.com",
  "responseType": "POST",
  "responseURL": "https://yourapp.com/response/clientId=123456",
  "responseFormat": "JSON",
  "returnParams": "clienID=12345,accountID=768456"
}

Best practice: make your response parser tolerant to missing fields/arrays in the JSON report (null/empty checks).
The structure of the JSON object may vary slightly depending on the data found for each subject.
Certain fields (e.g., legalIssues, socialMedia, associates, or wealth) may be missing, empty, or contain fewer details if no relevant information was discovered.
This is expected behaviour to ensure concise responses and relevance of data.

Response Delivery

• POST — SanctionIQ performs a callback to responseURL with the report body, and includes returnParams header if provided.
• EMAIL — Sent to email. Body contains the results and a Word Document attachment.
• Typical processing time: 2-3 minutes.

If the client account is valid and has sufficient credits, SanctionIQ will immediately respond to the initial API request with a 200 OK status. If there are issues with authentication or credits, the API will respond with appropriate error codes as detailed in the error section.

After the initial response is sent, the platform will process the request. Once completed, SanctionIQ will send the final report via the selected delivery method:

• EMAIL: Sent to the specified email with Word Document attachment.
• POST: Platform performs a callback with the response data (and includes any returnParams if provided) to the given responseURL.

Error Handling

Credits & Billing

• 1 credit per successful report.
• No credits deducted for 401/403/503 outcomes.

Supported Languages

Pass the language field or use Email mode suffixes to receive translated reports.

Response Format Samples

Snippets from real examples (trimmed for brevity). For more up to dat examples, please check Portal examples once logged in.

Copy{
  "status": "success",
  "fullName": "John Smith",
  "riskProfileConclusion": {
    "riskAssessment": "High Risk",
    "riskScore": 8,
    "confidenceRating": 7
  },
  "sources": [ {"title":"Wikipedia – John Smith", "url":"https://…"} ]
}

Copy<section id="risk-profile">
  <h2>Risk Profile Conclusion</h2>
  <p><strong>Overall Risk Assessment:</strong>
     <span class="pill risk-high">High Risk</span></p>
  <p><strong>Risk Score (0–10):</strong> 8</p>
  <p><strong>Confidence Rating (0–10):</strong> 7</p>
</section>

CopyName: John Smith
Life Status: Alive
PEP: Yes (President of the Moon)
Sanctions: No listings found (OFAC/UN/UK/EU)
Risk: High (8/10) · Confidence: 7/10

Email mode

Send an email to report@sanctioniq.io. Use the subject to provide the name, country and optional flags.

CopyTo: report@sanctioniq.io
Subject: John Smith from Gibraltar, CEO of Awesome Company - LANGUAGE:CASTELLANO - STRICT:TRUE
Body: (leave empty or add your own return parameters)

The results will be emailed back (body + Word Document). The sender email must match the registered SanctionIQ email.

Anything added in the body will be returned in the response email as the variable ReturnParams - e.g. ReturnParams:userID=12345,requestjobID=867950

To use the language parameter, simply add it to the end of your subject as the above example or if both variables used, add it with a comma.

For example: John Smith from Gibraltar – LANGUAGE:CASTELLANO

Risk Score vs Confidence Rating

How we separate inherent risk from certainty of assessment.

Risk Score Scale (0–10)

What each score band typically means and how to act.

Changelog

Disclaimer

SanctionIQ searches public/open sources and curated datasets. While we aim for high accuracy, the service is provided “as‑is” — clients must independently verify results before making legal, financial or compliance decisions. SanctionIQ accepts no liability for actions taken based on automated outputs.

Contact

Support: support@sanctioniq.io · Registration & API access: support@sanctioniq.io