Sanctions ScreeningSanctions Screening API

OnlineCredit Usage:1 per callRefreshed 23 hours ago
avg: 480ms|p50: 454ms|p75: 497ms|p90: 549ms|p99: 653ms

Overview

To use Sanctions Screening, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

URL
https://api.apiverve.com/v1/sanctionscreening

Example

How to call the Sanctions Screening API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/sanctionscreening?name=Banco%20Nacional%20de%20Cuba&threshold=0.85&limit=10&type=individual" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/sanctionscreening?name=Banco%20Nacional%20de%20Cuba&threshold=0.85&limit=10&type=individual', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/sanctionscreening?name=Banco%20Nacional%20de%20Cuba&threshold=0.85&limit=10&type=individual', headers=headers)

data = response.json()
print(data)
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/sanctionscreening?name=Banco%20Nacional%20de%20Cuba&threshold=0.85&limit=10&type=individual", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "query": "Banco Nacional de Cuba",
    "matched": true,
    "matchCount": 1,
    "verdict": "exact",
    "topScore": 1,
    "results": [
      {
        "uid": 306,
        "name": "BANCO NACIONAL DE CUBA",
        "type": "entity",
        "score": 1,
        "confidence": "exact",
        "matchedOn": "BANCO NACIONAL DE CUBA",
        "matchedVia": "primary",
        "isWeakAlias": false,
        "programs": [
          "CUBA"
        ],
        "title": null,
        "aka": [
          {
            "name": "BNC",
            "type": "aka",
            "strength": "weak"
          },
          {
            "name": "NATIONAL BANK OF CUBA",
            "type": "aka",
            "strength": "strong"
          }
        ],
        "dateOfBirth": [],
        "placeOfBirth": [],
        "nationalities": [],
        "citizenships": [],
        "addresses": [
          {
            "address1": "Zweierstrasse 35",
            "city": "Zurich",
            "postalCode": "CH-8022",
            "country": "Switzerland"
          },
          {
            "address1": "Avenida de Concha Espina 8",
            "city": "Madrid",
            "postalCode": "E-28036",
            "country": "Spain"
          },
          {
            "address1": "Dai-Ichi Bldg. 6th Floor, 10-2 Nihombashi, 2-chome, Chuo-ku",
            "city": "Tokyo",
            "postalCode": "103",
            "country": "Japan"
          },
          {
            "address1": "Federico Boyd Avenue & 51 Street",
            "city": "Panama City",
            "country": "Panama"
          }
        ],
        "ids": [],
        "remarks": null
      }
    ],
    "list": {
      "source": "OFAC SDN",
      "authority": "US Department of the Treasury, Office of Foreign Assets Control",
      "publishDate": "07/15/2026",
      "recordCount": 19217,
      "lastUpdated": "2026-07-16T05:00:12.431Z"
    }
  }
}

Authentication

The Sanctions Screening API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Sanctions Screening API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Sanctions Screening API:

Some Sanctions Screening parameters marked with Premium are available exclusively on paid plans.View pricing

Screen a Name Against the OFAC SDN List

ParameterTypeRequiredDescriptionDefaultExample
namestringrequired
The person or company name to screen (minimum 3 characters)
-Banco Nacional de Cuba
thresholdPremiumnumberoptional
Minimum match score to return, between 0.5 and 1. Lower catches more names but returns more false positives
0.850.85
limitPremiumnumberoptional
Maximum number of matches to return (1-50)
1010
typePremiumstringoptional
Restrict screening to one entry type
-individual

Response

The Sanctions Screening API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <query>Banco Nacional de Cuba</query>
    <matched>true</matched>
    <matchCount>1</matchCount>
    <verdict>exact</verdict>
    <topScore>1</topScore>
    <results>
      <result>
        <uid>306</uid>
        <name>BANCO NACIONAL DE CUBA</name>
        <type>entity</type>
        <score>1</score>
        <confidence>exact</confidence>
        <matchedOn>BANCO NACIONAL DE CUBA</matchedOn>
        <matchedVia>primary</matchedVia>
        <isWeakAlias>false</isWeakAlias>
        <programs>
          <program>CUBA</program>
        </programs>
        <title xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <aka>
          <item>
            <name>BNC</name>
            <type>aka</type>
            <strength>weak</strength>
          </item>
          <item>
            <name>NATIONAL BANK OF CUBA</name>
            <type>aka</type>
            <strength>strong</strength>
          </item>
        </aka>
        <dateOfBirth>
        </dateOfBirth>
        <placeOfBirth>
        </placeOfBirth>
        <nationalities>
        </nationalities>
        <citizenships>
        </citizenships>
        <addresses>
          <addresse>
            <address1>Zweierstrasse 35</address1>
            <city>Zurich</city>
            <postalCode>CH-8022</postalCode>
            <country>Switzerland</country>
          </addresse>
          <addresse>
            <address1>Avenida de Concha Espina 8</address1>
            <city>Madrid</city>
            <postalCode>E-28036</postalCode>
            <country>Spain</country>
          </addresse>
          <addresse>
            <address1>Dai-Ichi Bldg. 6th Floor, 10-2 Nihombashi, 2-chome, Chuo-ku</address1>
            <city>Tokyo</city>
            <postalCode>103</postalCode>
            <country>Japan</country>
          </addresse>
          <addresse>
            <address1>Federico Boyd Avenue &amp; 51 Street</address1>
            <city>Panama City</city>
            <country>Panama</country>
          </addresse>
        </addresses>
        <ids>
        </ids>
        <remarks xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      </result>
    </results>
    <list>
      <source>OFAC SDN</source>
      <authority>US Department of the Treasury, Office of Foreign Assets Control</authority>
      <publishDate>07/15/2026</publishDate>
      <recordCount>19217</recordCount>
      <lastUpdated>2026-07-16T05:00:12.431Z</lastUpdated>
    </list>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  query: Banco Nacional de Cuba
  matched: true
  matchCount: 1
  verdict: exact
  topScore: 1
  results:
    - uid: 306
      name: BANCO NACIONAL DE CUBA
      type: entity
      score: 1
      confidence: exact
      matchedOn: BANCO NACIONAL DE CUBA
      matchedVia: primary
      isWeakAlias: false
      programs:
        - CUBA
      title: null
      aka:
        - name: BNC
          type: aka
          strength: weak
        - name: NATIONAL BANK OF CUBA
          type: aka
          strength: strong
      dateOfBirth: []
      placeOfBirth: []
      nationalities: []
      citizenships: []
      addresses:
        - address1: Zweierstrasse 35
          city: Zurich
          postalCode: CH-8022
          country: Switzerland
        - address1: Avenida de Concha Espina 8
          city: Madrid
          postalCode: E-28036
          country: Spain
        - address1: Dai-Ichi Bldg. 6th Floor, 10-2 Nihombashi, 2-chome, Chuo-ku
          city: Tokyo
          postalCode: '103'
          country: Japan
        - address1: Federico Boyd Avenue & 51 Street
          city: Panama City
          country: Panama
      ids: []
      remarks: null
  list:
    source: OFAC SDN
    authority: US Department of the Treasury, Office of Foreign Assets Control
    publishDate: 07/15/2026
    recordCount: 19217
    lastUpdated: '2026-07-16T05:00:12.431Z'
CSV Response
200 OK
keyvalue
queryBanco Nacional de Cuba
matchedtrue
matchCount1
verdictexact
topScore1
results[{uid:306,name:BANCO NACIONAL DE CUBA,type:entity,score:1,confidence:exact,matchedOn:BANCO NACIONAL DE CUBA,matchedVia:primary,isWeakAlias:false,programs:[CUBA],title:null,aka:[{name:BNC,type:aka,strength:weak},{name:NATIONAL BANK OF CUBA,type:aka,strength:strong}],dateOfBirth:[],placeOfBirth:[],nationalities:[],citizenships:[],addresses:[{address1:Zweierstrasse 35,city:Zurich,postalCode:CH-8022,country:Switzerland},{address1:Avenida de Concha Espina 8,city:Madrid,postalCode:E-28036,country:Spain},{address1:Dai-Ichi Bldg. 6th Floor, 10-2 Nihombashi, 2-chome, Chuo-ku,city:Tokyo,postalCode:103,country:Japan},{address1:Federico Boyd Avenue & 51 Street,city:Panama City,country:Panama}],ids:[],remarks:null}]
list{source:OFAC SDN,authority:US Department of the Treasury, Office of Foreign Assets Control,publishDate:07/15/2026,recordCount:19217,lastUpdated:2026-07-16T05:00:12.431Z}

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
querystring"Banco Nacional de Cuba"
The name that was screened
matchedbooleantrue
Whether any entry on the list matched the query
matchCountnumber1
Number of matching entries returned
verdictstring"exact"
Highest confidence across all matches: exact, high, possible, or none
topScorenumber1
Match score of the strongest match, from 0 to 1
[ ] Array items:array[1]Array of objects
Matching SDN entries, strongest first
uidnumber306
-
namestring"BANCO NACIONAL DE CUBA"
-
typestring"entity"
-
scorenumber1
-
confidencestring"exact"
-
matchedOnstring"BANCO NACIONAL DE CUBA"
-
matchedViastring"primary"
-
isWeakAliasbooleanfalse
-
programsarray["CUBA"]
-
titleobjectnull
-
[ ] Array items:array[2]Array of objects
-
namestring"BNC"
-
typestring"aka"
-
strengthstring"weak"
-

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Sanctions Screening through GraphQL to combine it with other API calls in a single request. Query only the sanctions screening data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Sanctions Screening in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  sanctionscreening(
    input: {
      name: "Banco Nacional de Cuba"
      threshold: 0.85
      limit: 10
      type: "individual"
    }
  ) {
    query
    matched
    matchCount
    verdict
    topScore
    results
    list {
      source
      authority
      publishDate
      recordCount
      lastUpdated
    }
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Sanctions Screening API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Sanctions Screening requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Sanctions Screening API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Sanctions Screening

Official Sanctions Screening packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Sanctions Screening works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Frequently Asked Questions

How do I get an API key for Sanctions Screening?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Sanctions Screening and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Sanctions Screening cost?

Each successful Sanctions Screening API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful sanctions screening lookups.

Can I use Sanctions Screening in production?

The free plan is for testing and development only. For production use of Sanctions Screening, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Sanctions Screening from a browser?
Yes! The Sanctions Screening API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Sanctions Screening credit limit?

When you reach your monthly credit limit, Sanctions Screening API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?