Cyber Graph Sanction Search API Documentation

Introduction

The Cyber Graph Sanction Search API is an endpoint to check domains in real-time against Threat.Digital’s related website sanction graph data file. Results returned from this endpoint are domains that match sanctioned entities or are linked through shared website identifiers.


Authentication


Option 1: Via URL parameter

To authenticate your request through a URL parameter please pass your API key in the below endpoint:

https://app.threat.digital/sanction-api-v1/search?key={YOUR API KEY}

Option 2: Via request header

To authenticate your request please pass your API key in the x-api-key header:

x-api-key: {YOUR API KEY}

Specifying the user agent

Each request to the API must be accompanied by a user agent request header. Typically this should be the name of the app consuming the service. A missing user agent will result in an HTTP 401 response.


Required parameters

Parameter Description 
domain
 Domain name to be searched. Endpoint can accept a domain name, url, or email address. Subdomains are parsed from query 
key
 API access key provided by Threat.Digital

Response fields

The response will return all matches to sanctioned parties ranked in descending order.

	
    {
      "domain" :  "vtb.com",
      "matches":[
        {
            "sanctioned_name":  "VTB BANK PUBLIC JOINT STOCK COMPANY",
            "sanctioned_domain":  "vtb.com",
            "ofac_id":  "17013",
            "list_name":  "Non-SDN Menu-Based Sanctions List (NS-MBS List) - Treasury Department",
            "remarks":  "For more information on directives, please visit the following link: http://www.treasury.gov/resource-center/sanctions/Programs/Pages/ukraine.aspx#directives.",
            "source":  "https://home.treasury.gov/policy-issues/financial-sanctions/consolidated-sanctions-list-non-sdn-lists/non-sdn-menu-based-sanctions-list-ns-mbs-list",
            "confidence":  100
        }
      ]
    }
Field Description 
domain
 Parsed domain name from query 
sanctioned_name
 Matching sanctioned party company name from sanction list 
sanctioned_domain
 Matching sanctioned party domain name from sanction list 
ofac_id
 Identifier from sanction list 
list_name
 Name of sanction list 
remarks
 Additional details from sanction list 
source
 Sanction list URL 
confidence
 Confidence that returned domain is linked to sanctioned entity (0-100)

HTTP Response Codes

Code Description
200 Success - The request was processed successfully
401 Unauthorized - Invalid API key was provided
403 Rate Limit Exceeded - User exceeding the number of permitted requests
500 Internal Server Error - Something went wrong on our side

Embeddable Graph

Using the below URL format it is possible to embed an interactive graph of the sanctioned party connections directly into your application to prodive additional details for your users.

Embeddable link:
https://threat.digital/embed/sanction-graph?domain={DOMAIN NAME}&key={KEY}
iFrame code example:
<iframe width="100%" height="600" frameBorder="0" src="https://threat.digital/embed/sanction-graph?domain={DOMAIN NAME}&key={KEY}"></iframe>
Graph example:
Embeddable Sanction Graph