NameScan API Reference v3.1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Welcome to the NameScan RESTful API. You can use our API to access NameScan functionalities.

The NameScan API is organised around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, such as HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors.

We have language bindings in cUrl, Ruby, and Python. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Old API References

This document is related to API 3.1. You can find old versions documents if you use previous versions.

NameScan API Reference v3

NameScan API Reference v2

Authentication

Authenticate your account when using the API by including your secret or test API key in the request. You can manage your API keys in your profile. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas.

NameScan API expects for the API key to be included in all API requests to the server in a header that looks like the following:

api-key: your-api-key

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

NameScan uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted, etc) and codes in the 5xx range indicate an error with NameScans servers.

Error Codes

Status	Description
200 - OK	The request succeeded and the requested information is in the response. This is the most common status code to receive.
201 - Created	The request resulted in a new resource being created before the response was sent.
204 - No Content	The request has been successfully processed and the response is intentionally blank.
400 - Bad Request	The request could not be understood by the server. Bad Request is sent when no other error is applicable, if the exact error is unknown or does not have its own error code.
401 - Unauthorized	The requested resource requires authentication.
403 - Forbidden	The server refuses to fulfill the request.
500 - Internal Server Error	A generic error has occurred on the server.

In addition to the error code, the response always contains a message that describes the details of the error that occurred.

The “400 - Bad Request” response also always contains a ModelState that describes detail of incorrect or invalid sent parameter.

Emerald Scans

New Person Emerald Scan

Code samples

# You can also use wget
curl -X POST https://api.namescan.io/v3.1/person-scans/emerald \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

POST https://api.namescan.io/v3.1/person-scans/emerald HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json
api-key: API_KEY

const inputBody = '{
  "name": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "dob": "DD/MM/YYYY or YYYY",
  "country": "string",
  "listType": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/person-scans/emerald',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.post('https://api.namescan.io/v3.1/person-scans/emerald', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.namescan.io/v3.1/person-scans/emerald',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/person-scans/emerald");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v3.1/person-scans/emerald

Performs new Emerald person scan

Allows you to scan persons on Emerald lists by entering their information into the fields provided.

Body parameter

{
  "name": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "dob": "DD/MM/YYYY or YYYY",
  "country": "string",
  "listType": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}

Parameters

Name	In	Type	Required	Description
body	body	PersonScanEmeraldParam	false	The person scan parameter includes several key components for finding information.

Detailed descriptions

body: The person scan parameter includes several key components for finding information.

When both firstname/lastname and name are entered and name is Latin/Roman, the name is ignored and only firstname/lastname are scanned. However, when the name is original script (Non-Latin/Roman), the result includes profiles matched with firstname/lastname or original script.

Match rate is a percentage value between 1% and 100%, indicating how closely the name being checked matches the matching watchlist profile's name. A higher match rate means a closer match. When using an original script name for scanning, the match rate is calculated based on the number of matched parts.

When the entered name is in its original script (e.g., Cyrillic, Arabic, Chinese), the match rate is determined by counting the number of matching components.

If optional fields, such as "dob," "country," or "gender," are filled in and don't match the information in the Emerald database, the matching accuracy will decrease by 40%, 50%, or 60%, respectively.

The includeAdvancedMedia parameter enables searching for adverse media news articles related to a matched scanned entity. Set it to true to receive articles in the advancedMedia property, which will incur an additional credit of 0.5. If set to false, no advancedMedia property will be returned, and no extra credit will be deducted. In case of Advanced Media failure, the response will not include the advancedMedia property, and no extra credit will be deducted. Note that this individual service may take up to 45 seconds to respond.
Advanced Media is not supported with the Test Key.

Example responses

201 Response

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "numberOfPepMatches": 0,
  "numberOfSipMatches": 0,
  "persons": [
    {
      "uid": "string",
      "updateAt": "string",
      "updateInfo": "string",
      "category": "string",
      "deceased": true,
      "deceasedDate": "string",
      "name": "string",
      "title": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "gender": "string",
      "originalScriptName": "string",
      "datesOfBirth": [
        {
          "date": "string",
          "note": "string"
        }
      ],
      "placesOfBirth": [
        {
          "city": "string",
          "region": "string",
          "location": "string",
          "country": "string",
          "text": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "referenceType": "string",
      "references": [
        {
          "name": "string"
        }
      ],
      "program": "string",
      "nationality": "string",
      "citizenship": "string",
      "addresses": [
        {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "region": "string",
          "postalCode": "string",
          "country": "string",
          "text": "string",
          "note": "string"
        }
      ],
      "places": [
        {
          "country": "string",
          "location": "string",
          "type": "string"
        }
      ],
      "otherNames": [
        {
          "name": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "type": "string"
        }
      ],
      "roles": [
        {
          "title": "string",
          "since": "string",
          "to": "string"
        }
      ],
      "occupations": [
        "string"
      ],
      "father": "string",
      "mother": "string",
      "spouse": "string",
      "children": [
        "string"
      ],
      "siblings": [
        "string"
      ],
      "identities": [
        {
          "number": "string",
          "country": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "politicalParties": [
        {
          "title": "string",
          "since": "string",
          "to": "string"
        }
      ],
      "contacts": [
        {
          "value": "string",
          "type": "string"
        }
      ],
      "images": [
        "string"
      ],
      "links": [
        {
          "url": "string",
          "type": "string"
        }
      ],
      "sources": [
        "string"
      ],
      "basis": "string",
      "summary": "string",
      "matchRate": 0
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Contains information of matched persons.	PersonScanEmeraldResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

Get Person Emerald Scan

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/person-scans/emerald/{scanId} \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/person-scans/emerald/{scanId} HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/person-scans/emerald/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/person-scans/emerald/{scanId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/person-scans/emerald/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/person-scans/emerald/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/person-scans/emerald/{scanId}

Retrieves Emerald person scan

Allows you to retrieve person scan on Emerald lists by entering its scanId.

Parameters

Name	In	Type	Required	Description
scanId	path	string	true	scanId, which includes the scan ID to retrieve. It is required.

Example responses

200 Response

{
  "scanParam": {
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "dob": "DD/MM/YYYY or YYYY",
    "country": "string",
    "listType": "string",
    "includedLists": "string",
    "excludedLists": "string",
    "matchRate": 50,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "numberOfPepMatches": 0,
    "numberOfSipMatches": 0,
    "persons": [
      {
        "uid": "string",
        "updateAt": "string",
        "updateInfo": "string",
        "category": "string",
        "deceased": true,
        "deceasedDate": "string",
        "name": "string",
        "title": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "gender": "string",
        "originalScriptName": "string",
        "datesOfBirth": [
          {
            "date": "string",
            "note": "string"
          }
        ],
        "placesOfBirth": [
          {
            "city": "string",
            "region": "string",
            "location": "string",
            "country": "string",
            "text": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "referenceType": "string",
        "references": [
          {
            "name": "string"
          }
        ],
        "program": "string",
        "nationality": "string",
        "citizenship": "string",
        "addresses": [
          {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "region": "string",
            "postalCode": "string",
            "country": "string",
            "text": "string",
            "note": "string"
          }
        ],
        "places": [
          {
            "country": "string",
            "location": "string",
            "type": "string"
          }
        ],
        "otherNames": [
          {
            "name": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "type": "string"
          }
        ],
        "roles": [
          {
            "title": "string",
            "since": "string",
            "to": "string"
          }
        ],
        "occupations": [
          "string"
        ],
        "father": "string",
        "mother": "string",
        "spouse": "string",
        "children": [
          "string"
        ],
        "siblings": [
          "string"
        ],
        "identities": [
          {
            "number": "string",
            "country": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "politicalParties": [
          {
            "title": "string",
            "since": "string",
            "to": "string"
          }
        ],
        "contacts": [
          {
            "value": "string",
            "type": "string"
          }
        ],
        "images": [
          "string"
        ],
        "links": [
          {
            "url": "string",
            "type": "string"
          }
        ],
        "sources": [
          "string"
        ],
        "basis": "string",
        "summary": "string",
        "matchRate": 0
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Contains information of Emerald person scan.	PersonScanEmeraldHistoryResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

New Organisation Emerald Scan

Code samples

# You can also use wget
curl -X POST https://api.namescan.io/v3.1/organisation-scans/emerald \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

POST https://api.namescan.io/v3.1/organisation-scans/emerald HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json
api-key: API_KEY

const inputBody = '{
  "name": "string",
  "country": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/organisation-scans/emerald',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.post('https://api.namescan.io/v3.1/organisation-scans/emerald', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.namescan.io/v3.1/organisation-scans/emerald',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/organisation-scans/emerald");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v3.1/organisation-scans/emerald

Performs new Emerald organisation scan

Allows you to scan organisations on Emerald lists by entering their information into the fields provided.

Body parameter

{
  "name": "string",
  "country": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}

Parameters

Name	In	Type	Required	Description
body	body	OrganisationScanEmeraldParam	false	The organisation scan parameter includes organisation information to be found.

Detailed descriptions

body: The organisation scan parameter includes organisation information to be found.

The matchRate percentage represents how closely the entered name matches the names on matching watchlist profiles, with 1% indicating no close match and 100% signifying a very close match.

If the optional field, 'country', is provided, but does not correspond with the Emerald database, the match rate will be reduced by 50%.

The includeAdvancedMedia parameter enables searching for adverse media news articles related to a matched scanned entity. Set it to true to receive articles in the advancedMedia property, which will incur an additional credit of 0.5. If set to false, no advancedMedia property will be returned, and no extra credit will be deducted. In case of Advanced Media failure, the response will not include the advancedMedia property, and no extra credit will be deducted. Note that this individual service may take up to 45 seconds to respond.
Advanced Media is not supported with the Test Key.

Example responses

201 Response

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "organisations": [
    {
      "uid": "string",
      "updateAt": "string",
      "updateInfo": "string",
      "category": "string",
      "name": "string",
      "originalScriptName": "string",
      "referenceType": "string",
      "references": [
        {
          "name": "string"
        }
      ],
      "program": "string",
      "addresses": [
        {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "region": "string",
          "postalCode": "string",
          "country": "string",
          "text": "string",
          "note": "string"
        }
      ],
      "otherNames": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "identities": [
        {
          "number": "string",
          "country": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "contacts": [
        {
          "value": "string",
          "type": "string"
        }
      ],
      "images": [
        "string"
      ],
      "links": [
        {
          "url": "string",
          "type": "string"
        }
      ],
      "sources": [
        "string"
      ],
      "basis": "string",
      "summary": "string",
      "matchRate": 0
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Contains information of matched organisations.	OrganisationScanEmeraldResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None
503	Service Unavailable	Service Unavailable	None

Get Organisation Emerald Scan

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId} \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId} HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/organisation-scans/emerald/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/organisation-scans/emerald/{scanId}

Retrieves Emerald organisation scan

Allows you to retrieve organisation scan on Emerald lists by entering its scanId.

Parameters

Name	In	Type	Required	Description
scanId	path	string	true	scanId, which includes the scan ID to retrieve. It is required.

Example responses

200 Response

{
  "scanParam": {
    "name": "string",
    "country": "string",
    "includedLists": "string",
    "excludedLists": "string",
    "matchRate": 50,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "organisations": [
      {
        "uid": "string",
        "updateAt": "string",
        "updateInfo": "string",
        "category": "string",
        "name": "string",
        "originalScriptName": "string",
        "referenceType": "string",
        "references": [
          {
            "name": "string"
          }
        ],
        "program": "string",
        "addresses": [
          {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "region": "string",
            "postalCode": "string",
            "country": "string",
            "text": "string",
            "note": "string"
          }
        ],
        "otherNames": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "identities": [
          {
            "number": "string",
            "country": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "contacts": [
          {
            "value": "string",
            "type": "string"
          }
        ],
        "images": [
          "string"
        ],
        "links": [
          {
            "url": "string",
            "type": "string"
          }
        ],
        "sources": [
          "string"
        ],
        "basis": "string",
        "summary": "string",
        "matchRate": 0
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Contains information of Emerald organisation scan.	OrganisationScanEmeraldHistoryResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

Get Sanction Lists Information

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/lists/emerald/sanctions \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/lists/emerald/sanctions HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/lists/emerald/sanctions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/lists/emerald/sanctions', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/lists/emerald/sanctions',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/lists/emerald/sanctions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/lists/emerald/sanctions

Retrieves Emerald sanctions lists information

Allows you to retrieve information of Emerald sanctions lists.

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "enabled": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Contains ID, name and status of sanctions lists.	Inline
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None
503	Service Unavailable	Service Unavailable	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SanctionListInfo]	false	none	none
» id	string¦null	false	none	none
» name	string¦null	false	none	none
» enabled	boolean	false	none	none

Sapphire Scans

New Person Sapphire Scan

Code samples

# You can also use wget
curl -X POST https://api.namescan.io/v3.1/person-scans/sapphire \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

POST https://api.namescan.io/v3.1/person-scans/sapphire HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json
api-key: API_KEY

const inputBody = '{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "originalName": "string",
  "gender": "string",
  "dob": " DD/MM/YYYY or YYYY ",
  "country": "string",
  "idNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/person-scans/sapphire',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.post('https://api.namescan.io/v3.1/person-scans/sapphire', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.namescan.io/v3.1/person-scans/sapphire',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/person-scans/sapphire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v3.1/person-scans/sapphire

Performs new Sapphire person scan

Allows you to scan persons on Sapphire lists by entering their information into the fields provided.

Body parameter

{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "originalName": "string",
  "gender": "string",
  "dob": " DD/MM/YYYY or YYYY ",
  "country": "string",
  "idNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}

Parameters

Name	In	Type	Required	Description
body	body	PersonScanSapphireParam	false	The person scan parameter includes several key components for finding information.

Detailed descriptions

body: The person scan parameter includes several key components for finding information.

firstName/lastName or originalName is required. middleName is optional.

For each record, you can choose to check firstName and lastName or originalName or both firstName and lastName and originalName. originalName can either be the person's full name in a Non-Latin/Roman-based language (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name, if you are unable to separate it based on First, Middle and Last Name.

MatchRate is a percentage value ranging from 1-100 that indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% signifying not close and 100% indicating very close.

If you fill in the optional fields such as "dob," "country," or "gender," and they don't match the information in the Sapphire database, the identified entity will be removed from the search results.

The includeAdvancedMedia parameter enables searching for adverse media news articles related to a matched scanned entity. Set it to true to receive articles in the advancedMedia property, which will incur an additional credit of 0.25. If set to false, no advancedMedia property will be returned, and no extra credit will be deducted. In case of Advanced Media failure, the response will not include the advancedMedia property, and no extra credit will be deducted. Note that this individual service may take up to 45 seconds to respond.
Advanced Media is not supported with the Test Key.

Example responses

201 Response

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "persons": [
    {
      "category": "string",
      "matchRate": 0,
      "matchedFields": "string",
      "person": {
        "uniqueId": "string",
        "category": "string",
        "categories": "string",
        "gender": "string",
        "deceased": "string",
        "primaryFirstName": "string",
        "primaryMiddleName": "string",
        "primaryLastName": "string",
        "images": [
          "string"
        ],
        "dateOfBirth": "string",
        "deceasedDate": "string",
        "placeOfBirth": "string",
        "primaryLocation": "string",
        "furtherInformation": "string",
        "lastReviewed": "string",
        "descriptions": [
          {
            "description1": "string",
            "description2": "string"
          }
        ],
        "nameDetails": [
          {
            "nameType": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
          }
        ],
        "roles": [
          {
            "title": "string",
            "segment": "string",
            "from": "string",
            "to": "string",
            "status": "string",
            "country": "string"
          }
        ],
        "importantDates": [
          {
            "dateType": "string",
            "dateValue": "string"
          }
        ],
        "nationalities": [
          "string"
        ],
        "nationalitiesCodes": [
          "string"
        ],
        "locations": [
          {
            "country": "string",
            "countryCode": "string",
            "city": "string",
            "address": "string",
            "type": "string"
          }
        ],
        "officialLists": [
          {
            "keyword": "string",
            "category": "string",
            "description": "string",
            "origin": "string",
            "measures": "string",
            "types": "string",
            "isCurrent": true
          }
        ],
        "identifiers": [
          {
            "type": "string",
            "value": "string"
          }
        ],
        "disqualifiedDirectors": [
          {
            "caseReference": "string",
            "company": "string",
            "reason": "string",
            "from": "string",
            "to": "string"
          }
        ],
        "profileOfInterests": [
          {
            "category": "string",
            "positions": [
              {
                "position": "string",
                "segment": "string",
                "country": "string",
                "from": "string",
                "to": "string"
              }
            ]
          }
        ],
        "linkedIndividuals": [
          {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "linkedCompanies": [
          {
            "name": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "sources": [
          {
            "url": "string",
            "categories": "string",
            "details": [
              {
                "categories": "string",
                "originalUrl": "string",
                "title": "string",
                "credibility": "string",
                "language": "string",
                "summary": "string",
                "keywords": "string",
                "captureDate": "string",
                "publicationDate": "string",
                "assetUrl": "string"
              }
            ]
          }
        ]
      },
      "taxHavenCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string"
        }
      ],
      "sanctionedCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string",
          "isBlackList": true,
          "isGreyList": true
        }
      ]
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Contains information of matched persons.	PersonScanSapphireResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None
503	Service Unavailable	Service Unavailable	None

Get Person Sapphire Scans

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/person-scans/sapphire/{scanId} \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/person-scans/sapphire/{scanId} HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/person-scans/sapphire/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/person-scans/sapphire/{scanId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/person-scans/sapphire/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/person-scans/sapphire/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/person-scans/sapphire/{scanId}

Retrieves Sapphire person scan

Allows you to retrieve person scan on Sapphire lists by entering its scanId.

Parameters

Name	In	Type	Required	Description
scanId	path	string	true	scanId, which includes the scan ID to retrieve. It is required.

Example responses

200 Response

{
  "scanParam": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "originalName": "string",
    "gender": "string",
    "dob": " DD/MM/YYYY or YYYY ",
    "country": "string",
    "idNumber": "string",
    "exact": false,
    "matchRate": 75,
    "maxResultCount": 100,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "persons": [
      {
        "category": "string",
        "matchRate": 0,
        "matchedFields": "string",
        "person": {
          "uniqueId": "string",
          "category": "string",
          "categories": "string",
          "gender": "string",
          "deceased": "string",
          "primaryFirstName": "string",
          "primaryMiddleName": "string",
          "primaryLastName": "string",
          "images": [
            "string"
          ],
          "dateOfBirth": "string",
          "deceasedDate": "string",
          "placeOfBirth": "string",
          "primaryLocation": "string",
          "furtherInformation": "string",
          "lastReviewed": "string",
          "descriptions": [
            {
              "description1": "string",
              "description2": "string"
            }
          ],
          "nameDetails": [
            {
              "nameType": "string",
              "firstName": "string",
              "middleName": "string",
              "lastName": "string"
            }
          ],
          "roles": [
            {
              "title": "string",
              "segment": "string",
              "from": "string",
              "to": "string",
              "status": "string",
              "country": "string"
            }
          ],
          "importantDates": [
            {
              "dateType": "string",
              "dateValue": "string"
            }
          ],
          "nationalities": [
            "string"
          ],
          "nationalitiesCodes": [
            "string"
          ],
          "locations": [
            {
              "country": "string",
              "countryCode": "string",
              "city": "string",
              "address": "string",
              "type": "string"
            }
          ],
          "officialLists": [
            {
              "keyword": "string",
              "category": "string",
              "description": "string",
              "origin": "string",
              "measures": "string",
              "types": "string",
              "isCurrent": true
            }
          ],
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "disqualifiedDirectors": [
            {
              "caseReference": "string",
              "company": "string",
              "reason": "string",
              "from": "string",
              "to": "string"
            }
          ],
          "profileOfInterests": [
            {
              "category": "string",
              "positions": [
                {
                  "position": "string",
                  "segment": "string",
                  "country": "string",
                  "from": "string",
                  "to": "string"
                }
              ]
            }
          ],
          "linkedIndividuals": [
            {
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "linkedCompanies": [
            {
              "name": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "sources": [
            {
              "url": "string",
              "categories": "string",
              "details": [
                {
                  "categories": "string",
                  "originalUrl": "string",
                  "title": "string",
                  "credibility": "string",
                  "language": "string",
                  "summary": "string",
                  "keywords": "string",
                  "captureDate": "string",
                  "publicationDate": "string",
                  "assetUrl": "string"
                }
              ]
            }
          ]
        },
        "taxHavenCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string"
          }
        ],
        "sanctionedCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string",
            "isBlackList": true,
            "isGreyList": true
          }
        ]
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Contains information of Sapphire person scan.	PersonScanSapphireHistoryResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

New Organisation Sapphire Scan

Code samples

# You can also use wget
curl -X POST https://api.namescan.io/v3.1/organisation-scans/sapphire \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

POST https://api.namescan.io/v3.1/organisation-scans/sapphire HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json
api-key: API_KEY

const inputBody = '{
  "name": "string",
  "country": "string",
  "registrationNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/organisation-scans/sapphire',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.post('https://api.namescan.io/v3.1/organisation-scans/sapphire', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.post 'https://api.namescan.io/v3.1/organisation-scans/sapphire',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/organisation-scans/sapphire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v3.1/organisation-scans/sapphire

Performs new Sapphire organisation scan

Allows you to scan organisations on Sapphire lists by entering their information into the fields provided.

Body parameter

{
  "name": "string",
  "country": "string",
  "registrationNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}

Parameters

Name	In	Type	Required	Description
body	body	OrganisationScanSapphireParam	false	The `includeAdvancedMedia` parameter enables searching for adverse media news articles related to a matched scanned entity.

Detailed descriptions

body: The includeAdvancedMedia parameter enables searching for adverse media news articles related to a matched scanned entity. Set it to true to receive articles in the advancedMedia property, which will incur an additional credit of 0.25. If set to false, no advancedMedia property will be returned, and no extra credit will be deducted. In case of Advanced Media failure, the response will not include the advancedMedia property, and no extra credit will be deducted. Note that this individual service may take up to 45 seconds to respond.
Advanced Media is not supported with the Test Key.

Example responses

201 Response

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "corporates": [
    {
      "category": "string",
      "matchedFields": "string",
      "matchRate": 0,
      "entity": {
        "uniqueId": "string",
        "category": "string",
        "categories": "string",
        "primaryName": "string",
        "primaryLocation": "string",
        "images": [
          "string"
        ],
        "furtherInformation": "string",
        "lastReviewed": "string",
        "generalInfo": {
          "businessDescription": "string",
          "website": "string",
          "businessTypes": "string",
          "activities": "string"
        },
        "descriptions": [
          {
            "description1": "string",
            "description2": "string"
          }
        ],
        "nameDetails": [
          {
            "nameType": "string",
            "entityName": "string"
          }
        ],
        "locations": [
          {
            "country": "string",
            "countryCode": "string",
            "city": "string",
            "address": "string",
            "type": "string"
          }
        ],
        "officialLists": [
          {
            "keyword": "string",
            "category": "string",
            "description": "string",
            "origin": "string",
            "measures": "string",
            "types": "string",
            "isCurrent": true
          }
        ],
        "identifiers": [
          {
            "type": "string",
            "value": "string"
          }
        ],
        "profileOfInterests": [
          {
            "category": "string",
            "positions": [
              {
                "position": "string",
                "segment": "string",
                "country": "string",
                "from": "string",
                "to": "string"
              }
            ]
          }
        ],
        "linkedIndividuals": [
          {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "linkedCompanies": [
          {
            "name": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "sources": [
          {
            "url": "string",
            "categories": "string",
            "details": [
              {
                "categories": "string",
                "originalUrl": "string",
                "title": "string",
                "credibility": "string",
                "language": "string",
                "summary": "string",
                "keywords": "string",
                "captureDate": "string",
                "publicationDate": "string",
                "assetUrl": "string"
              }
            ]
          }
        ]
      },
      "taxHavenCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string"
        }
      ],
      "sanctionedCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string",
          "isBlackList": true,
          "isGreyList": true
        }
      ]
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	Contains information of matched organisations.	OrganisationScanSapphireResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None
503	Service Unavailable	Service Unavailable	None

Get Organisation Sapphire Scan

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId} \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId} HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId}', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/organisation-scans/sapphire/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/organisation-scans/sapphire/{scanId}

Retrieves Sapphire organisation scan

Allows you to retrieve organisation scan on Sapphire lists by entering its scanId.

Parameters

Name	In	Type	Required	Description
scanId	path	string	true	scanId, which includes the scan ID to retrieve. It is required.

Example responses

200 Response

{
  "scanParam": {
    "name": "string",
    "country": "string",
    "registrationNumber": "string",
    "exact": false,
    "matchRate": 75,
    "maxResultCount": 100,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "corporates": [
      {
        "category": "string",
        "matchedFields": "string",
        "matchRate": 0,
        "entity": {
          "uniqueId": "string",
          "category": "string",
          "categories": "string",
          "primaryName": "string",
          "primaryLocation": "string",
          "images": [
            "string"
          ],
          "furtherInformation": "string",
          "lastReviewed": "string",
          "generalInfo": {
            "businessDescription": "string",
            "website": "string",
            "businessTypes": "string",
            "activities": "string"
          },
          "descriptions": [
            {
              "description1": "string",
              "description2": "string"
            }
          ],
          "nameDetails": [
            {
              "nameType": "string",
              "entityName": "string"
            }
          ],
          "locations": [
            {
              "country": "string",
              "countryCode": "string",
              "city": "string",
              "address": "string",
              "type": "string"
            }
          ],
          "officialLists": [
            {
              "keyword": "string",
              "category": "string",
              "description": "string",
              "origin": "string",
              "measures": "string",
              "types": "string",
              "isCurrent": true
            }
          ],
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "profileOfInterests": [
            {
              "category": "string",
              "positions": [
                {
                  "position": "string",
                  "segment": "string",
                  "country": "string",
                  "from": "string",
                  "to": "string"
                }
              ]
            }
          ],
          "linkedIndividuals": [
            {
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "linkedCompanies": [
            {
              "name": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "sources": [
            {
              "url": "string",
              "categories": "string",
              "details": [
                {
                  "categories": "string",
                  "originalUrl": "string",
                  "title": "string",
                  "credibility": "string",
                  "language": "string",
                  "summary": "string",
                  "keywords": "string",
                  "captureDate": "string",
                  "publicationDate": "string",
                  "assetUrl": "string"
                }
              ]
            }
          ]
        },
        "taxHavenCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string"
          }
        ],
        "sanctionedCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string",
            "isBlackList": true,
            "isGreyList": true
          }
        ]
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	organisationScanSapphireHistoryResult: contains information of organisation Sapphire scan.	OrganisationScanSapphireHistoryResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

Credits

Get Emerald Credits

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/credits/emerald \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/credits/emerald HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/credits/emerald',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/credits/emerald', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/credits/emerald',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/credits/emerald");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/credits/emerald

Retrieves user's Emerald credits

Allows you to retrieve information about Emerald credits.

Example responses

200 Response

{
  "balance": 0,
  "keyExpiryDate": "2019-08-24T14:15:22Z",
  "credits": [
    {
      "credits": 0,
      "remainingCredits": 0,
      "expiryDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Contains information about user's Emerald credits.	CreditsResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

Get Sapphire Credits

Code samples

# You can also use wget
curl -X GET https://api.namescan.io/v3.1/credits/sapphire \
  -H 'Accept: application/json' \
  -H 'api-key: API_KEY'

GET https://api.namescan.io/v3.1/credits/sapphire HTTP/1.1

Accept: application/json
api-key: API_KEY


const headers = {
  'Accept':'application/json',
  'api-key':'API_KEY'
};

fetch('https://api.namescan.io/v3.1/credits/sapphire',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'api-key': 'API_KEY'
}

r = requests.get('https://api.namescan.io/v3.1/credits/sapphire', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'api-key' => 'API_KEY'
}

result = RestClient.get 'https://api.namescan.io/v3.1/credits/sapphire',
  params: {
  }, headers: headers

p JSON.parse(result)

URL obj = new URL("https://api.namescan.io/v3.1/credits/sapphire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v3.1/credits/sapphire

Retrieves user's Sapphire credits

Allows you to retrieve information about Sapphire credits.

Example responses

200 Response

{
  "balance": 0,
  "keyExpiryDate": "2019-08-24T14:15:22Z",
  "credits": [
    {
      "credits": 0,
      "remainingCredits": 0,
      "expiryDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Contains information about user's Sapphire credits.	CreditsResult
400	Bad Request	Bad request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
500	Internal Server Error	Internal Server Error	None

Schemas

CreditInfo

{
  "credits": 0,
  "remainingCredits": 0,
  "expiryDate": "2019-08-24T14:15:22Z"
}

Represents the information of a credits pack purchased by the user.

Properties

Name	Type	Required	Restrictions	Description
credits	number(double)	false	none	Total credits of a user for a particular pack.
remainingCredits	number(double)	false	none	Remaining credits of the user for a particular pack.
expiryDate	string(date-time)¦null	false	none	Date of expiry for a particular credit pack.

CreditsResult

{
  "balance": 0,
  "keyExpiryDate": "2019-08-24T14:15:22Z",
  "credits": [
    {
      "credits": 0,
      "remainingCredits": 0,
      "expiryDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Represents information about the user's remaining credits.

Properties

Name	Type	Required	Restrictions	Description
balance	number(double)	false	none	Number of remaining balance/scans for the user in a particular pack.
keyExpiryDate	string(date-time)¦null	false	none	Expiry date for the user's remaining credits in a particular pack.
credits	[CreditInfo]¦null	false	none	List of the user's remaining credit packs.

OrganisationScanEmeraldHistoryResult

{
  "scanParam": {
    "name": "string",
    "country": "string",
    "includedLists": "string",
    "excludedLists": "string",
    "matchRate": 50,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "organisations": [
      {
        "uid": "string",
        "updateAt": "string",
        "updateInfo": "string",
        "category": "string",
        "name": "string",
        "originalScriptName": "string",
        "referenceType": "string",
        "references": [
          {
            "name": "string"
          }
        ],
        "program": "string",
        "addresses": [
          {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "region": "string",
            "postalCode": "string",
            "country": "string",
            "text": "string",
            "note": "string"
          }
        ],
        "otherNames": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "identities": [
          {
            "number": "string",
            "country": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "contacts": [
          {
            "value": "string",
            "type": "string"
          }
        ],
        "images": [
          "string"
        ],
        "links": [
          {
            "url": "string",
            "type": "string"
          }
        ],
        "sources": [
          "string"
        ],
        "basis": "string",
        "summary": "string",
        "matchRate": 0
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
scanParam	OrganisationScanEmeraldParam	false	none	Contains information of organisation to be scanned.
scanResult	OrganisationScanEmeraldResult	false	none	Represents information about the Emrald organisation scan and list of scan matched entities. The lists present the scan match results for the organisation.

OrganisationScanEmeraldParam

{
  "name": "string",
  "country": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}

Contains information of organisation to be scanned.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	Length: 0 - 250	Name of organisation to be scanned.
country	string¦null	false	Length: 0 - 100	Country of organisation to be scanned.
includedLists	string¦null	false	Length: 0 - 50	Use the 'includedLists' field if you want to scan over specified Sanctions lists.(e.g., UN, SDN).
excludedLists	string¦null	false	Length: 0 - 50	Use the 'excludedLists' field if you want to exclude specific Sanctions lists from your scan.(e.g., UN, SDN).
matchRate	integer(int32)¦null	false	none	The Match Rate is specified for each matched entity. Values range from 1 (indicating not close) to 100 (representing exact or very close matches).
includeAdvancedMedia	boolean¦null	false	none	includeAdvancedMedia can be set to true or false. If its value is true, it means that articles will be returned based on the matched scanned entity, and an additional credit will be deducted for this operation. Conversely, if the value is false, no results will be returned, and no extra credit will be deducted.

OrganisationScanEmeraldResult

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "organisations": [
    {
      "uid": "string",
      "updateAt": "string",
      "updateInfo": "string",
      "category": "string",
      "name": "string",
      "originalScriptName": "string",
      "referenceType": "string",
      "references": [
        {
          "name": "string"
        }
      ],
      "program": "string",
      "addresses": [
        {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "region": "string",
          "postalCode": "string",
          "country": "string",
          "text": "string",
          "note": "string"
        }
      ],
      "otherNames": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "identities": [
        {
          "number": "string",
          "country": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "contacts": [
        {
          "value": "string",
          "type": "string"
        }
      ],
      "images": [
        "string"
      ],
      "links": [
        {
          "url": "string",
          "type": "string"
        }
      ],
      "sources": [
        "string"
      ],
      "basis": "string",
      "summary": "string",
      "matchRate": 0
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Represents information about the Emrald organisation scan and list of scan matched entities. The lists present the scan match results for the organisation.

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	Date of Scan.
scanId	string¦null	false	none	The identifier to be utilized for retrieving details of the organisation's scan.
numberOfMatches	integer(int32)¦null	false	none	The number of matched entities found indicates whether there are any matches or not; 0 signifies that no matches were found.
organisations	[Emerald.Organisation]¦null	false	none	Lists of the Emerald Scan Match Results for an organisation's Details.
advancedMedia	AdvanceMediaResult	false	none	none

OrganisationScanSapphireHistoryResult

{
  "scanParam": {
    "name": "string",
    "country": "string",
    "registrationNumber": "string",
    "exact": false,
    "matchRate": 75,
    "maxResultCount": 100,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "corporates": [
      {
        "category": "string",
        "matchedFields": "string",
        "matchRate": 0,
        "entity": {
          "uniqueId": "string",
          "category": "string",
          "categories": "string",
          "primaryName": "string",
          "primaryLocation": "string",
          "images": [
            "string"
          ],
          "furtherInformation": "string",
          "lastReviewed": "string",
          "generalInfo": {
            "businessDescription": "string",
            "website": "string",
            "businessTypes": "string",
            "activities": "string"
          },
          "descriptions": [
            {
              "description1": "string",
              "description2": "string"
            }
          ],
          "nameDetails": [
            {
              "nameType": "string",
              "entityName": "string"
            }
          ],
          "locations": [
            {
              "country": "string",
              "countryCode": "string",
              "city": "string",
              "address": "string",
              "type": "string"
            }
          ],
          "officialLists": [
            {
              "keyword": "string",
              "category": "string",
              "description": "string",
              "origin": "string",
              "measures": "string",
              "types": "string",
              "isCurrent": true
            }
          ],
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "profileOfInterests": [
            {
              "category": "string",
              "positions": [
                {
                  "position": "string",
                  "segment": "string",
                  "country": "string",
                  "from": "string",
                  "to": "string"
                }
              ]
            }
          ],
          "linkedIndividuals": [
            {
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "linkedCompanies": [
            {
              "name": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "sources": [
            {
              "url": "string",
              "categories": "string",
              "details": [
                {
                  "categories": "string",
                  "originalUrl": "string",
                  "title": "string",
                  "credibility": "string",
                  "language": "string",
                  "summary": "string",
                  "keywords": "string",
                  "captureDate": "string",
                  "publicationDate": "string",
                  "assetUrl": "string"
                }
              ]
            }
          ]
        },
        "taxHavenCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string"
          }
        ],
        "sanctionedCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string",
            "isBlackList": true,
            "isGreyList": true
          }
        ]
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
scanParam	OrganisationScanSapphireParam	false	none	Contains information of organisation to be scanned.
scanResult	OrganisationScanSapphireResult	false	none	Represents information about the Sapphire organisation scan and list of scan matched entities. The lists present the scan match results for the organisation.

OrganisationScanSapphireParam

{
  "name": "string",
  "country": "string",
  "registrationNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}

Contains information of organisation to be scanned.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	Length: 0 - 250	Name of organisation to be scanned.
country	string¦null	false	Length: 0 - 100	Country of organisation to be scanned.
registrationNumber	string¦null	false	Length: 0 - 100	Company Registration Number could be an ABN, ACN or its equivalent. When you provide a Registration Number, it will be utilized in the matching process, and Company Name matches will be returned if that Registration Number is 'contained' within the watchlist record.
exact	boolean¦null	false	none	The exact match is specified for each matched entity. If the value is true, this indicates an exact match with the scanned entity. Conversely, if the value is false, it signifies that there is no exact match with the scanned entity.
matchRate	integer(int32)¦null	false	none	The Match Rate is specified for each matched entity. Values range from 1 (indicating not close) to 100 (representing exact or very close matches).
maxResultCount	integer(int32)¦null	false	none	Max result count of matched entity. Values are from 1 (Min) to 200 (Max).
includeAdvancedMedia	boolean¦null	false	none	includeAdvancedMedia can be set to true or false. If its value is true, it means that articles will be returned based on the matched scanned entity, and an additional credit will be deducted for this operation. Conversely, if the value is false, no results will be returned, and no extra credit will be deducted.

OrganisationScanSapphireResult

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "corporates": [
    {
      "category": "string",
      "matchedFields": "string",
      "matchRate": 0,
      "entity": {
        "uniqueId": "string",
        "category": "string",
        "categories": "string",
        "primaryName": "string",
        "primaryLocation": "string",
        "images": [
          "string"
        ],
        "furtherInformation": "string",
        "lastReviewed": "string",
        "generalInfo": {
          "businessDescription": "string",
          "website": "string",
          "businessTypes": "string",
          "activities": "string"
        },
        "descriptions": [
          {
            "description1": "string",
            "description2": "string"
          }
        ],
        "nameDetails": [
          {
            "nameType": "string",
            "entityName": "string"
          }
        ],
        "locations": [
          {
            "country": "string",
            "countryCode": "string",
            "city": "string",
            "address": "string",
            "type": "string"
          }
        ],
        "officialLists": [
          {
            "keyword": "string",
            "category": "string",
            "description": "string",
            "origin": "string",
            "measures": "string",
            "types": "string",
            "isCurrent": true
          }
        ],
        "identifiers": [
          {
            "type": "string",
            "value": "string"
          }
        ],
        "profileOfInterests": [
          {
            "category": "string",
            "positions": [
              {
                "position": "string",
                "segment": "string",
                "country": "string",
                "from": "string",
                "to": "string"
              }
            ]
          }
        ],
        "linkedIndividuals": [
          {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "linkedCompanies": [
          {
            "name": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "sources": [
          {
            "url": "string",
            "categories": "string",
            "details": [
              {
                "categories": "string",
                "originalUrl": "string",
                "title": "string",
                "credibility": "string",
                "language": "string",
                "summary": "string",
                "keywords": "string",
                "captureDate": "string",
                "publicationDate": "string",
                "assetUrl": "string"
              }
            ]
          }
        ]
      },
      "taxHavenCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string"
        }
      ],
      "sanctionedCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string",
          "isBlackList": true,
          "isGreyList": true
        }
      ]
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

Represents information about the Sapphire organisation scan and list of scan matched entities. The lists present the scan match results for the organisation.

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	Date of scan.
scanId	string¦null	false	none	The identifier to be utilized for retrieving details of the organisation's scan.
numberOfMatches	integer(int32)¦null	false	none	The number of matched entities found indicates whether there are any matches or not; 0 signifies that no matches were found.
corporates	[Sapphire.SingleScanCorpResultDetail]¦null	false	none	Lists of the Sapphire Scan Match Results for an organisation's Details.
advancedMedia	AdvanceMediaResult	false	none	none

PersonScanEmeraldHistoryResult

{
  "scanParam": {
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "gender": "string",
    "dob": "DD/MM/YYYY or YYYY",
    "country": "string",
    "listType": "string",
    "includedLists": "string",
    "excludedLists": "string",
    "matchRate": 50,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "numberOfPepMatches": 0,
    "numberOfSipMatches": 0,
    "persons": [
      {
        "uid": "string",
        "updateAt": "string",
        "updateInfo": "string",
        "category": "string",
        "deceased": true,
        "deceasedDate": "string",
        "name": "string",
        "title": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "gender": "string",
        "originalScriptName": "string",
        "datesOfBirth": [
          {
            "date": "string",
            "note": "string"
          }
        ],
        "placesOfBirth": [
          {
            "city": "string",
            "region": "string",
            "location": "string",
            "country": "string",
            "text": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "referenceType": "string",
        "references": [
          {
            "name": "string"
          }
        ],
        "program": "string",
        "nationality": "string",
        "citizenship": "string",
        "addresses": [
          {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "region": "string",
            "postalCode": "string",
            "country": "string",
            "text": "string",
            "note": "string"
          }
        ],
        "places": [
          {
            "country": "string",
            "location": "string",
            "type": "string"
          }
        ],
        "otherNames": [
          {
            "name": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "type": "string"
          }
        ],
        "roles": [
          {
            "title": "string",
            "since": "string",
            "to": "string"
          }
        ],
        "occupations": [
          "string"
        ],
        "father": "string",
        "mother": "string",
        "spouse": "string",
        "children": [
          "string"
        ],
        "siblings": [
          "string"
        ],
        "identities": [
          {
            "number": "string",
            "country": "string",
            "note": "string",
            "type": "string"
          }
        ],
        "politicalParties": [
          {
            "title": "string",
            "since": "string",
            "to": "string"
          }
        ],
        "contacts": [
          {
            "value": "string",
            "type": "string"
          }
        ],
        "images": [
          "string"
        ],
        "links": [
          {
            "url": "string",
            "type": "string"
          }
        ],
        "sources": [
          "string"
        ],
        "basis": "string",
        "summary": "string",
        "matchRate": 0
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
scanParam	PersonScanEmeraldParam	false	none	Contains information of person to be scanned.
scanResult	PersonScanEmeraldResult	false	none	It should be utilized for emerald scan match results related to an individual's details.

PersonScanEmeraldParam

{
  "name": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "dob": "DD/MM/YYYY or YYYY",
  "country": "string",
  "listType": "string",
  "includedLists": "string",
  "excludedLists": "string",
  "matchRate": 50,
  "includeAdvancedMedia": false
}

Contains information of person to be scanned.

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	Length: 0 - 250	Name of person to be scanned.
firstName	string¦null	false	Length: 0 - 150	First name of person to be scanned.
middleName	string¦null	false	Length: 0 - 150	Middle name of person to be scanned.
lastName	string¦null	false	Length: 0 - 150	Last name of person to be scanned.
gender	string¦null	false	Length: 0 - 10	Gender of person to be scanned.
dob	string¦null	false	Length: 0 - 10 Pattern: ^((0?[1...	Birth date of person to be scanned.
country	string¦null	false	Length: 0 - 100	Country of person to be scanned.
listType	string¦null	false	Length: 0 - 20	Select the list type to be scan. This can be set to PEP or Sanction, and if left empty, the scan will cover all lists.
includedLists	string¦null	false	Length: 0 - 50	Use the 'includedLists' field if you want to scan over specified Sanctions lists.(e.g., UN, SDN).
excludedLists	string¦null	false	Length: 0 - 50	Use the 'excludedLists' field if you want to exclude specific Sanctions lists from your scan.(e.g., UN, SDN).
matchRate	integer(int32)¦null	false	none	The Match Rate is specified for each matched entity. Values range from 1 (indicating not close) to 100 (representing exact or very close matches).
includeAdvancedMedia	boolean¦null	false	none	includeAdvancedMedia can be set to true or false. If its value is true, it means that articles will be returned based on the matched scanned entity, and an additional credit will be deducted for this operation. Conversely, if the value is false, no results will be returned, and no extra credit will be deducted.

PersonScanEmeraldResult

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "numberOfPepMatches": 0,
  "numberOfSipMatches": 0,
  "persons": [
    {
      "uid": "string",
      "updateAt": "string",
      "updateInfo": "string",
      "category": "string",
      "deceased": true,
      "deceasedDate": "string",
      "name": "string",
      "title": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "gender": "string",
      "originalScriptName": "string",
      "datesOfBirth": [
        {
          "date": "string",
          "note": "string"
        }
      ],
      "placesOfBirth": [
        {
          "city": "string",
          "region": "string",
          "location": "string",
          "country": "string",
          "text": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "referenceType": "string",
      "references": [
        {
          "name": "string"
        }
      ],
      "program": "string",
      "nationality": "string",
      "citizenship": "string",
      "addresses": [
        {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "city": "string",
          "region": "string",
          "postalCode": "string",
          "country": "string",
          "text": "string",
          "note": "string"
        }
      ],
      "places": [
        {
          "country": "string",
          "location": "string",
          "type": "string"
        }
      ],
      "otherNames": [
        {
          "name": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "type": "string"
        }
      ],
      "roles": [
        {
          "title": "string",
          "since": "string",
          "to": "string"
        }
      ],
      "occupations": [
        "string"
      ],
      "father": "string",
      "mother": "string",
      "spouse": "string",
      "children": [
        "string"
      ],
      "siblings": [
        "string"
      ],
      "identities": [
        {
          "number": "string",
          "country": "string",
          "note": "string",
          "type": "string"
        }
      ],
      "politicalParties": [
        {
          "title": "string",
          "since": "string",
          "to": "string"
        }
      ],
      "contacts": [
        {
          "value": "string",
          "type": "string"
        }
      ],
      "images": [
        "string"
      ],
      "links": [
        {
          "url": "string",
          "type": "string"
        }
      ],
      "sources": [
        "string"
      ],
      "basis": "string",
      "summary": "string",
      "matchRate": 0
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

It should be utilized for emerald scan match results related to an individual's details.

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	Date of Scan.
scanId	string¦null	false	none	The identifier of this scan should be utilized to obtain the details related to this person's scan.
numberOfMatches	integer(int32)¦null	false	none	Number of matched entities found. 0 indicates that no matches were found.
numberOfPepMatches	integer(int32)¦null	false	none	Number of matched PEP (Politically Exposed Persons) entities found. 0 indicates that no matches were found.
numberOfSipMatches	integer(int32)¦null	false	none	Number of matched SIP (Special Interest Persons) entities found. 0 indicates that no matches were found.
persons	[Emerald.Person]¦null	false	none	Lists of the Emerald Scan Match Results for an Individual's Details.
advancedMedia	AdvanceMediaResult	false	none	none

PersonScanSapphireHistoryResult

{
  "scanParam": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "originalName": "string",
    "gender": "string",
    "dob": " DD/MM/YYYY or YYYY ",
    "country": "string",
    "idNumber": "string",
    "exact": false,
    "matchRate": 75,
    "maxResultCount": 100,
    "includeAdvancedMedia": false
  },
  "scanResult": {
    "date": "2019-08-24T14:15:22Z",
    "scanId": "string",
    "numberOfMatches": 0,
    "persons": [
      {
        "category": "string",
        "matchRate": 0,
        "matchedFields": "string",
        "person": {
          "uniqueId": "string",
          "category": "string",
          "categories": "string",
          "gender": "string",
          "deceased": "string",
          "primaryFirstName": "string",
          "primaryMiddleName": "string",
          "primaryLastName": "string",
          "images": [
            "string"
          ],
          "dateOfBirth": "string",
          "deceasedDate": "string",
          "placeOfBirth": "string",
          "primaryLocation": "string",
          "furtherInformation": "string",
          "lastReviewed": "string",
          "descriptions": [
            {
              "description1": "string",
              "description2": "string"
            }
          ],
          "nameDetails": [
            {
              "nameType": "string",
              "firstName": "string",
              "middleName": "string",
              "lastName": "string"
            }
          ],
          "roles": [
            {
              "title": "string",
              "segment": "string",
              "from": "string",
              "to": "string",
              "status": "string",
              "country": "string"
            }
          ],
          "importantDates": [
            {
              "dateType": "string",
              "dateValue": "string"
            }
          ],
          "nationalities": [
            "string"
          ],
          "nationalitiesCodes": [
            "string"
          ],
          "locations": [
            {
              "country": "string",
              "countryCode": "string",
              "city": "string",
              "address": "string",
              "type": "string"
            }
          ],
          "officialLists": [
            {
              "keyword": "string",
              "category": "string",
              "description": "string",
              "origin": "string",
              "measures": "string",
              "types": "string",
              "isCurrent": true
            }
          ],
          "identifiers": [
            {
              "type": "string",
              "value": "string"
            }
          ],
          "disqualifiedDirectors": [
            {
              "caseReference": "string",
              "company": "string",
              "reason": "string",
              "from": "string",
              "to": "string"
            }
          ],
          "profileOfInterests": [
            {
              "category": "string",
              "positions": [
                {
                  "position": "string",
                  "segment": "string",
                  "country": "string",
                  "from": "string",
                  "to": "string"
                }
              ]
            }
          ],
          "linkedIndividuals": [
            {
              "firstName": "string",
              "middleName": "string",
              "lastName": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "linkedCompanies": [
            {
              "name": "string",
              "category": "string",
              "description": "string"
            }
          ],
          "sources": [
            {
              "url": "string",
              "categories": "string",
              "details": [
                {
                  "categories": "string",
                  "originalUrl": "string",
                  "title": "string",
                  "credibility": "string",
                  "language": "string",
                  "summary": "string",
                  "keywords": "string",
                  "captureDate": "string",
                  "publicationDate": "string",
                  "assetUrl": "string"
                }
              ]
            }
          ]
        },
        "taxHavenCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string"
          }
        ],
        "sanctionedCountryResults": [
          {
            "isPrimaryLocation": true,
            "countryCode": "string",
            "comment": "string",
            "url": "string",
            "isBlackList": true,
            "isGreyList": true
          }
        ]
      }
    ],
    "advancedMedia": {
      "context": "string",
      "articles": [
        {
          "articleId": "string",
          "siteId": "string",
          "countryCode": "string",
          "countryName": "string",
          "readCount": "string",
          "publishedDate": "string",
          "wordCount": "string",
          "title": "string",
          "articleImages": [
            "string"
          ],
          "author": "string",
          "link": "string",
          "sourceName": "string",
          "sourceUrl": "string",
          "summary": "string",
          "body": "string",
          "caption": "string"
        }
      ],
      "scanStatus": {
        "status": 0,
        "statusDescription": "string"
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
scanParam	PersonScanSapphireParam	false	none	Contains information of person to be scanned.
scanResult	PersonScanSapphireResult	false	none	It should be utilized for Sapphire scan match results related to an individual's details.

PersonScanSapphireParam

{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "originalName": "string",
  "gender": "string",
  "dob": " DD/MM/YYYY or YYYY ",
  "country": "string",
  "idNumber": "string",
  "exact": false,
  "matchRate": 75,
  "maxResultCount": 100,
  "includeAdvancedMedia": false
}

Contains information of person to be scanned.

Properties

Name	Type	Required	Restrictions	Description
firstName	string¦null	false	Length: 0 - 100	First name of person to be scanned.
middleName	string¦null	false	Length: 0 - 100	Middle name of person to be scanned.
lastName	string¦null	false	Length: 0 - 100	Last name of person to be scanned.
originalName	string¦null	false	Length: 0 - 250	Original name of person to be scanned.
gender	string¦null	false	Length: 0 - 10	Gender of person to be scanned.
dob	string¦null	false	Length: 0 - 10 Pattern: ^((0?[1...	Birth date of person to be scanned.
country	string¦null	false	Length: 0 - 100	Country of person to be scanned.
idNumber	string¦null	false	Length: 0 - 100	Person ID Number, such as a Passport number or VAT/Tax number. When you enter an ID Number, it is utilized in the matching process, is compared against the watchlist records. If the ID number is found within a watchlist record, the corresponding person name and details are returned.
exact	boolean¦null	false	none	The exact match is specified for each matched entity. If the value is true, this indicates an exact match with the scanned entity. Conversely, if the value is false, it signifies that there is no exact match with the scanned entity.
matchRate	integer(int32)¦null	false	none	The Match Rate is specified for each matched entity. Values range from 1 (indicating not close) to 100 (representing exact or very close matches).
maxResultCount	integer(int32)¦null	false	none	Max result count indicates the maximum number of matches that should be returned.
includeAdvancedMedia	boolean¦null	false	none	includeAdvancedMedia can be set to true or false. If its value is true, it means that articles will be returned based on the matched scanned entity, and an additional credit will be deducted for this operation. Conversely, if the value is false, no results will be returned, and no extra credit will be deducted.

PersonScanSapphireResult

{
  "date": "2019-08-24T14:15:22Z",
  "scanId": "string",
  "numberOfMatches": 0,
  "persons": [
    {
      "category": "string",
      "matchRate": 0,
      "matchedFields": "string",
      "person": {
        "uniqueId": "string",
        "category": "string",
        "categories": "string",
        "gender": "string",
        "deceased": "string",
        "primaryFirstName": "string",
        "primaryMiddleName": "string",
        "primaryLastName": "string",
        "images": [
          "string"
        ],
        "dateOfBirth": "string",
        "deceasedDate": "string",
        "placeOfBirth": "string",
        "primaryLocation": "string",
        "furtherInformation": "string",
        "lastReviewed": "string",
        "descriptions": [
          {
            "description1": "string",
            "description2": "string"
          }
        ],
        "nameDetails": [
          {
            "nameType": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
          }
        ],
        "roles": [
          {
            "title": "string",
            "segment": "string",
            "from": "string",
            "to": "string",
            "status": "string",
            "country": "string"
          }
        ],
        "importantDates": [
          {
            "dateType": "string",
            "dateValue": "string"
          }
        ],
        "nationalities": [
          "string"
        ],
        "nationalitiesCodes": [
          "string"
        ],
        "locations": [
          {
            "country": "string",
            "countryCode": "string",
            "city": "string",
            "address": "string",
            "type": "string"
          }
        ],
        "officialLists": [
          {
            "keyword": "string",
            "category": "string",
            "description": "string",
            "origin": "string",
            "measures": "string",
            "types": "string",
            "isCurrent": true
          }
        ],
        "identifiers": [
          {
            "type": "string",
            "value": "string"
          }
        ],
        "disqualifiedDirectors": [
          {
            "caseReference": "string",
            "company": "string",
            "reason": "string",
            "from": "string",
            "to": "string"
          }
        ],
        "profileOfInterests": [
          {
            "category": "string",
            "positions": [
              {
                "position": "string",
                "segment": "string",
                "country": "string",
                "from": "string",
                "to": "string"
              }
            ]
          }
        ],
        "linkedIndividuals": [
          {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "linkedCompanies": [
          {
            "name": "string",
            "category": "string",
            "description": "string"
          }
        ],
        "sources": [
          {
            "url": "string",
            "categories": "string",
            "details": [
              {
                "categories": "string",
                "originalUrl": "string",
                "title": "string",
                "credibility": "string",
                "language": "string",
                "summary": "string",
                "keywords": "string",
                "captureDate": "string",
                "publicationDate": "string",
                "assetUrl": "string"
              }
            ]
          }
        ]
      },
      "taxHavenCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string"
        }
      ],
      "sanctionedCountryResults": [
        {
          "isPrimaryLocation": true,
          "countryCode": "string",
          "comment": "string",
          "url": "string",
          "isBlackList": true,
          "isGreyList": true
        }
      ]
    }
  ],
  "advancedMedia": {
    "context": "string",
    "articles": [
      {
        "articleId": "string",
        "siteId": "string",
        "countryCode": "string",
        "countryName": "string",
        "readCount": "string",
        "publishedDate": "string",
        "wordCount": "string",
        "title": "string",
        "articleImages": [
          "string"
        ],
        "author": "string",
        "link": "string",
        "sourceName": "string",
        "sourceUrl": "string",
        "summary": "string",
        "body": "string",
        "caption": "string"
      }
    ],
    "scanStatus": {
      "status": 0,
      "statusDescription": "string"
    }
  }
}

It should be utilized for Sapphire scan match results related to an individual's details.

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	Date of scan.
scanId	string¦null	false	none	The identifier to be utilized for retrieving details of the person's scan.
numberOfMatches	integer(int32)¦null	false	none	Number of matched entities found. 0 indicates that no matches were found.
persons	[Sapphire.SingleScanResultDetail]¦null	false	none	Lists of the Sapphire Scan Match Results for an Individual's Details.
advancedMedia	AdvanceMediaResult	false	none	none

SanctionListInfo

{
  "id": "string",
  "name": "string",
  "enabled": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string¦null	false	none	none
name	string¦null	false	none	none
enabled	boolean	false	none	none

ScanHistoryItem

{
  "scanId": "string",
  "scanDate": "2019-08-24T14:15:22Z",
  "source": "Emerald",
  "entityType": "Person",
  "scannedName": "string",
  "numberOfMatches": 0,
  "numberOfPepMatches": 0,
  "numberOfSipMatches": 0,
  "apiVersion": 0
}

Properties

Name	Type	Required	Restrictions	Description
scanId	string¦null	false	none	none
scanDate	string(date-time)	false	none	none
source	string	false	none	none
entityType	string	false	none	none
scannedName	string¦null	false	none	none
numberOfMatches	integer(int32)¦null	false	none	none
numberOfPepMatches	integer(int32)¦null	false	none	none
numberOfSipMatches	integer(int32)¦null	false	none	none
apiVersion	number(double)¦null	false	none	none

Enumerated Values

Property	Value
source	Emerald
source	Sapphire
entityType	Person
entityType	Organisation

ScanHistoryList

{
  "count": 0,
  "scans": [
    {
      "scanId": "string",
      "scanDate": "2019-08-24T14:15:22Z",
      "source": "Emerald",
      "entityType": "Person",
      "scannedName": "string",
      "numberOfMatches": 0,
      "numberOfPepMatches": 0,
      "numberOfSipMatches": 0,
      "apiVersion": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int32)	false	none	none
scans	[ScanHistoryItem]¦null	false	none	none

AdvanceMediaArticle

{
  "articleId": "string",
  "siteId": "string",
  "countryCode": "string",
  "countryName": "string",
  "readCount": "string",
  "publishedDate": "string",
  "wordCount": "string",
  "title": "string",
  "articleImages": [
    "string"
  ],
  "author": "string",
  "link": "string",
  "sourceName": "string",
  "sourceUrl": "string",
  "summary": "string",
  "body": "string",
  "caption": "string"
}

Properties

Name	Type	Required	Restrictions	Description
articleId	string¦null	false	none	none
siteId	string¦null	false	none	none
countryCode	string¦null	false	none	none
countryName	string¦null	false	none	none
readCount	string¦null	false	none	none
publishedDate	string¦null	false	none	none
wordCount	string¦null	false	none	none
title	string¦null	false	none	none
articleImages	[string]¦null	false	none	none
author	string¦null	false	none	none
link	string¦null	false	none	none
sourceName	string¦null	false	none	none
sourceUrl	string¦null	false	none	none
summary	string¦null	false	none	none
body	string¦null	false	none	none
caption	string¦null	false	none	none

AdvanceMediaResult

{
  "context": "string",
  "articles": [
    {
      "articleId": "string",
      "siteId": "string",
      "countryCode": "string",
      "countryName": "string",
      "readCount": "string",
      "publishedDate": "string",
      "wordCount": "string",
      "title": "string",
      "articleImages": [
        "string"
      ],
      "author": "string",
      "link": "string",
      "sourceName": "string",
      "sourceUrl": "string",
      "summary": "string",
      "body": "string",
      "caption": "string"
    }
  ],
  "scanStatus": {
    "status": 0,
    "statusDescription": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
context	string¦null	false	none	none
articles	[AdvanceMediaArticle]¦null	false	none	none
scanStatus	ScanStatus	false	none	none

ScanStatus

{
  "status": 0,
  "statusDescription": "string"
}

Properties

Name	Type	Required	Restrictions	Description
status	integer(int32)	false	none	Returns the status code 200 - Success 204 - No result found 408 - Timeout 500 - Internal server error
statusDescription	string¦null	false	none	Returns the status description 200 - Success 204 - No result found 408 - Timeout 500 - Internal server error

Emerald.Address

{
  "address1": "string",
  "address2": "string",
  "address3": "string",
  "city": "string",
  "region": "string",
  "postalCode": "string",
  "country": "string",
  "text": "string",
  "note": "string"
}

Represents country, Region (State/Province), City, and address where information is available.

Properties

Name	Type	Required	Restrictions	Description
address1	string¦null	false	none	Contains the major address, if available.
address2	string¦null	false	none	Contains the minor address, if available.
address3	string¦null	false	none	Contains other additional address, if available.
city	string¦null	false	none	City of the matched entity.
region	string¦null	false	none	Region of matched entity.
postalCode	string¦null	false	none	Postal code of matched entity.
country	string¦null	false	none	Country of the matched entity.
text	string¦null	false	none	Additional address details, if available.
note	string¦null	false	none	Note regarding the address details, if available.

Emerald.Contact

{
  "value": "string",
  "type": "string"
}

Represents contact details of the entity.

Properties

Name	Type	Required	Restrictions	Description
value	string¦null	false	none	Value of the entity.
type	string¦null	false	none	Type of the contact.

Emerald.DateOfBirth

{
  "date": "string",
  "note": "string"
}

Represents date and note of birth where information is available.

Properties

Name	Type	Required	Restrictions	Description
date	string¦null	false	none	Date of birth.
note	string¦null	false	none	Note of birth, if any.

Emerald.Identity

{
  "number": "string",
  "country": "string",
  "note": "string",
  "type": "string"
}

Represents the identity of the matched entity.

Properties

Name	Type	Required	Restrictions	Description
number	string¦null	false	none	Id number of the matched entity.
country	string¦null	false	none	Country of identity.
note	string¦null	false	none	Note of the identity, if available.
type	string¦null	false	none	Type of identity including registration number, registration date and status etc.

Emerald.Link

{
  "url": "string",
  "type": "string"
}

Represents the source link information.

Properties

Name	Type	Required	Restrictions	Description
url	string¦null	false	none	Link to original source or website.
type	string¦null	false	none	Type of the source detail.

Emerald.NameDetail

{
  "name": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "type": "string"
}

Represents other name details of person where information is available.

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Name of the person, if available.
firstName	string¦null	false	none	First name of the person, if available.
middleName	string¦null	false	none	Middle name of the person, if available.
lastName	string¦null	false	none	Last name of the person, if available.
type	string¦null	false	none	Type of name, if available.

Emerald.OrgNameDetail

{
  "name": "string",
  "type": "string"
}

Represents name details of organisation where information is available.

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Name of the organisation.
type	string¦null	false	none	Type of the organisation.

Emerald.Organisation

{
  "uid": "string",
  "updateAt": "string",
  "updateInfo": "string",
  "category": "string",
  "name": "string",
  "originalScriptName": "string",
  "referenceType": "string",
  "references": [
    {
      "name": "string"
    }
  ],
  "program": "string",
  "addresses": [
    {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string",
      "text": "string",
      "note": "string"
    }
  ],
  "otherNames": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "identities": [
    {
      "number": "string",
      "country": "string",
      "note": "string",
      "type": "string"
    }
  ],
  "contacts": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "images": [
    "string"
  ],
  "links": [
    {
      "url": "string",
      "type": "string"
    }
  ],
  "sources": [
    "string"
  ],
  "basis": "string",
  "summary": "string",
  "matchRate": 0
}

Represents the information of the organisation scan.

Properties

Name	Type	Required	Restrictions	Description
uid	string¦null	false	none	The unique identifier of the orgaisation.
updateAt	string¦null	false	none	Date the organisation profile was updated in data source.
updateInfo	string¦null	false	none	Information updated in the data source.
category	string¦null	false	none	Category of the organisation.
name	string¦null	false	none	Name of the organisation.
originalScriptName	string¦null	false	none	Original script name of the organisation.
referenceType	string¦null	false	none	Reference type of the organisation.
references	[Emerald.Reference]¦null	false	none	List of references of the organisation, if available.
program	string¦null	false	none	Program associated with the matched entity.
addresses	[Emerald.Address]¦null	false	none	List of addresses which includes country, city, region etc., of the organisation.
otherNames	[Emerald.OrgNameDetail]¦null	false	none	List of other names of matched organisation, if available.
identities	[Emerald.Identity]¦null	false	none	List of registration/ID number of the organisation.
contacts	[Emerald.Contact]¦null	false	none	Contact details of the organisation, if available.
images	[string]¦null	false	none	List of URL links to the pictures of the organisation, if available.
links	[Emerald.Link]¦null	false	none	List of links to the source or website of the organisation.
sources	[string]¦null	false	none	List of all public sources, including both government and media sources, used to build the full profile of the organisation.
basis	string¦null	false	none	Basis for referencing legal regulations and sanctions related to entities, e.g., regulation numbers, dates, references, etc.
summary	string¦null	false	none	Summary of the organisation.
matchRate	number(double)	false	none	For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close).

Emerald.Party

{
  "title": "string",
  "since": "string",
  "to": "string"
}

Represents details about the person's relation with political/other party.

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	Title/Name of the party.
since	string¦null	false	none	Start date of association with the person.
to	string¦null	false	none	End date of association with the person.

Emerald.Person

{
  "uid": "string",
  "updateAt": "string",
  "updateInfo": "string",
  "category": "string",
  "deceased": true,
  "deceasedDate": "string",
  "name": "string",
  "title": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "string",
  "originalScriptName": "string",
  "datesOfBirth": [
    {
      "date": "string",
      "note": "string"
    }
  ],
  "placesOfBirth": [
    {
      "city": "string",
      "region": "string",
      "location": "string",
      "country": "string",
      "text": "string",
      "note": "string",
      "type": "string"
    }
  ],
  "referenceType": "string",
  "references": [
    {
      "name": "string"
    }
  ],
  "program": "string",
  "nationality": "string",
  "citizenship": "string",
  "addresses": [
    {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string",
      "text": "string",
      "note": "string"
    }
  ],
  "places": [
    {
      "country": "string",
      "location": "string",
      "type": "string"
    }
  ],
  "otherNames": [
    {
      "name": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "type": "string"
    }
  ],
  "roles": [
    {
      "title": "string",
      "since": "string",
      "to": "string"
    }
  ],
  "occupations": [
    "string"
  ],
  "father": "string",
  "mother": "string",
  "spouse": "string",
  "children": [
    "string"
  ],
  "siblings": [
    "string"
  ],
  "identities": [
    {
      "number": "string",
      "country": "string",
      "note": "string",
      "type": "string"
    }
  ],
  "politicalParties": [
    {
      "title": "string",
      "since": "string",
      "to": "string"
    }
  ],
  "contacts": [
    {
      "value": "string",
      "type": "string"
    }
  ],
  "images": [
    "string"
  ],
  "links": [
    {
      "url": "string",
      "type": "string"
    }
  ],
  "sources": [
    "string"
  ],
  "basis": "string",
  "summary": "string",
  "matchRate": 0
}

Represents the information of the person scan.

Properties

Name	Type	Required	Restrictions	Description
uid	string¦null	false	none	Unique identifier of the person.
updateAt	string¦null	false	none	Date the person profile was updated in data source.
updateInfo	string¦null	false	none	Information updated in the data source.
category	string¦null	false	none	The categories the matched record belongs to, which can be one or a combination of the following: `PEP, SIP, SIE` etc.
deceased	boolean¦null	false	none	Deceased status of the person, if applicable.
deceasedDate	string¦null	false	none	Deceased date of the person, if applicable.
name	string¦null	false	none	Name of the person.
title	string¦null	false	none	Title of the person, if available.
firstName	string¦null	false	none	First name of the person.
middleName	string¦null	false	none	Middle name of the person.
lastName	string¦null	false	none	Last name of the person.
gender	string¦null	false	none	Gender of the person.
originalScriptName	string¦null	false	none	Original script names of the person.
datesOfBirth	[Emerald.DateOfBirth]¦null	false	none	List of date of birth of the person.
placesOfBirth	[Emerald.PlaceOfBirth]¦null	false	none	List of birth place of the person.
referenceType	string¦null	false	none	Reference type of matched entity. Possible values are: `PEP, Sanctions, Emerald, Other`.
references	[Emerald.Reference]¦null	false	none	List of references for the matched entity, if available.
program	string¦null	false	none	Program associated with the matched entity.
nationality	string¦null	false	none	Nationality of the person.
citizenship	string¦null	false	none	Citizenship of the person.
addresses	[Emerald.Address]¦null	false	none	List of addresses which includes country, city, region etc., of the person.
places	[Emerald.Place]¦null	false	none	List of places which include the person's location, country, and place type, if available.
otherNames	[Emerald.NameDetail]¦null	false	none	List of other names of matched person, if available.
roles	[Emerald.Role]¦null	false	none	List of roles of the person profile.
occupations	[string]¦null	false	none	List of occupations of the person.
father	string¦null	false	none	Father's name of the person.
mother	string¦null	false	none	Mother's name of the person.
spouse	string¦null	false	none	Spouse's name of the person.
children	[string]¦null	false	none	List of the person's children.
siblings	[string]¦null	false	none	List of the person's siblings.
identities	[Emerald.Identity]¦null	false	none	List of registration/ID number of the person.
politicalParties	[Emerald.Party]¦null	false	none	List of political party details with which the person is associated.
contacts	[Emerald.Contact]¦null	false	none	Contact details of the person, if available.
images	[string]¦null	false	none	List of URL links to the pictures of the person, if available.
links	[Emerald.Link]¦null	false	none	List of links to the source or website of the person.
sources	[string]¦null	false	none	List of all public sources, including both government and media sources, used to build the full profile of the person.
basis	string¦null	false	none	Basis for referencing legal regulations and sanctions related to entities, e.g., regulation numbers, dates, references, etc.
summary	string¦null	false	none	Summary of the person.
matchRate	number(double)	false	none	For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close).

Emerald.Place

{
  "country": "string",
  "location": "string",
  "type": "string"
}

Represents country, location, and place type where information is available.

Properties

Name	Type	Required	Restrictions	Description
country	string¦null	false	none	Country of the matched entity.
location	string¦null	false	none	Location of the place.
type	string¦null	false	none	Type of place.

Emerald.PlaceOfBirth

{
  "city": "string",
  "region": "string",
  "location": "string",
  "country": "string",
  "text": "string",
  "note": "string",
  "type": "string"
}

Represents birth place details where information is available.

Properties

Name	Type	Required	Restrictions	Description
city	string¦null	false	none	City of birth place.
region	string¦null	false	none	Region of birth place.
location	string¦null	false	none	Location of birth place, if available.
country	string¦null	false	none	Country of birth place.
text	string¦null	false	none	Details of birth place, if available.
note	string¦null	false	none	Note for place of birth, if any.
type	string¦null	false	none	The type of birth place, if available.

Emerald.Reference

{
  "name": "string"
}

Represents reference details where information is available.

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Name of the reference.

Emerald.Role

{
  "title": "string",
  "since": "string",
  "to": "string"
}

Represents the details of the person's roles where information is available.

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	Represents the Job/Role of the person.
since	string¦null	false	none	The start date of the term of office for the particular role.
to	string¦null	false	none	The end date of the term of office in the particular role.

Sapphire.AssociateCorp

{
  "name": "string",
  "category": "string",
  "description": "string"
}

Profile of the associated or related company, organisation, or other entity.

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Name of associated company.
category	string¦null	false	none	Category of the associated company.
description	string¦null	false	none	Description of the associate.

Sapphire.AssociatePerson

{
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "category": "string",
  "description": "string"
}

Profile of the associate or related individual.

Properties

Name	Type	Required	Restrictions	Description
firstName	string¦null	false	none	Associate's first name.
middleName	string¦null	false	none	Associate's middle name.
lastName	string¦null	false	none	Associate's last name.
category	string¦null	false	none	Category of the associated person.
description	string¦null	false	none	Description of the associate.

Sapphire.CorpNameDetail

{
  "nameType": "string",
  "entityName": "string"
}

Represents other aliases and also known as names of the company.

Properties

Name	Type	Required	Restrictions	Description
nameType	string¦null	false	none	Type of name.
entityName	string¦null	false	none	The organisation name.

Sapphire.Country

{
  "countryType": "string",
  "countryValue": "string"
}

Properties

Name	Type	Required	Restrictions	Description
countryType	string¦null	false	none	none
countryValue	string¦null	false	none	none

Sapphire.Date

{
  "dateType": "string",
  "dateValue": "string"
}

Represents different type of important date.

Properties

Name	Type	Required	Restrictions	Description
dateType	string¦null	false	none	Type of date.
dateValue	string¦null	false	none	Value of date.

Sapphire.Description

{
  "description1": "string",
  "description2": "string"
}

Represents the list of descriptions for the matched entity.

Properties

Name	Type	Required	Restrictions	Description
description1	string¦null	false	none	Contains the major watchlist category description.
description2	string¦null	false	none	Contains the minor watchlist category description.

Sapphire.DisqualifiedDirector

{
  "caseReference": "string",
  "company": "string",
  "reason": "string",
  "from": "string",
  "to": "string"
}

Represents details of the disqualifications. This is applicable to UK only.

Properties

Name	Type	Required	Restrictions	Description
caseReference	string¦null	false	none	The unique Companies House identification number of the disqualification.
company	string¦null	false	none	The name of the company that the person was acting for.
reason	string¦null	false	none	The reason for the disqualification.
from	string¦null	false	none	Start date of the disqualification.
to	string¦null	false	none	End date of the disqualificaiton.

Sapphire.Entity

{
  "uniqueId": "string",
  "category": "string",
  "categories": "string",
  "gender": "string",
  "deceased": "string",
  "primaryFirstName": "string",
  "primaryMiddleName": "string",
  "primaryLastName": "string",
  "images": [
    "string"
  ],
  "dateOfBirth": "string",
  "deceasedDate": "string",
  "placeOfBirth": "string",
  "primaryLocation": "string",
  "furtherInformation": "string",
  "lastReviewed": "string",
  "descriptions": [
    {
      "description1": "string",
      "description2": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string"
    }
  ],
  "roles": [
    {
      "title": "string",
      "segment": "string",
      "from": "string",
      "to": "string",
      "status": "string",
      "country": "string"
    }
  ],
  "importantDates": [
    {
      "dateType": "string",
      "dateValue": "string"
    }
  ],
  "nationalities": [
    "string"
  ],
  "nationalitiesCodes": [
    "string"
  ],
  "locations": [
    {
      "country": "string",
      "countryCode": "string",
      "city": "string",
      "address": "string",
      "type": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "origin": "string",
      "measures": "string",
      "types": "string",
      "isCurrent": true
    }
  ],
  "identifiers": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "disqualifiedDirectors": [
    {
      "caseReference": "string",
      "company": "string",
      "reason": "string",
      "from": "string",
      "to": "string"
    }
  ],
  "profileOfInterests": [
    {
      "category": "string",
      "positions": [
        {
          "position": "string",
          "segment": "string",
          "country": "string",
          "from": "string",
          "to": "string"
        }
      ]
    }
  ],
  "linkedIndividuals": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "category": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "name": "string",
      "category": "string",
      "description": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "details": [
        {
          "categories": "string",
          "originalUrl": "string",
          "title": "string",
          "credibility": "string",
          "language": "string",
          "summary": "string",
          "keywords": "string",
          "captureDate": "string",
          "publicationDate": "string",
          "assetUrl": "string"
        }
      ]
    }
  ]
}

Represents detail profile of matched entity.

Properties

Name	Type	Required	Restrictions	Description
uniqueId	string¦null	false	none	Unique identifier of the person.
category	string¦null	false	none	Category of the person.
categories	string¦null	false	none	Full descriptive categories of the person.
gender	string¦null	false	none	Gender of the person.
deceased	string¦null	false	none	Deceased status of the person, if applicable.
primaryFirstName	string¦null	false	none	Primary first name of the person.
primaryMiddleName	string¦null	false	none	Primary middle name of the person.
primaryLastName	string¦null	false	none	Primary last name of the person.
images	[string]¦null	false	none	List of URL links to the pictures of the person, if available.
dateOfBirth	string¦null	false	none	Date of birth of the person.
deceasedDate	string¦null	false	none	Deceased date of the person, if applicable.
placeOfBirth	string¦null	false	none	Birth place of the person.
primaryLocation	string¦null	false	none	Person's primary location.
furtherInformation	string¦null	false	none	Further information of the person.
lastReviewed	string¦null	false	none	Last reviewed date of the record.
descriptions	[Sapphire.Description]¦null	false	none	Person's description list.
nameDetails	[Sapphire.NameDetail]¦null	false	none	Person's name detail list.
roles	[Sapphire.Role]¦null	false	none	List of roles of the PEP profile.
importantDates	[Sapphire.Date]¦null	false	none	List of important dates for the person.
nationalities	[string]¦null	false	none	List of nationalities for the person.
nationalitiesCodes	[string]¦null	false	none	List of nationalities country codes for the person.
locations	[Sapphire.Location]¦null	false	none	List of locations for the person.
officialLists	[Sapphire.OfficialList]¦null	false	none	List of official lists where the person is found.
identifiers	[Sapphire.Identifier]¦null	false	none	List of registration/ID number of the person.
disqualifiedDirectors	[Sapphire.DisqualifiedDirector]¦null	false	none	List of disqualifications for the person.
profileOfInterests	[Sapphire.ProfileOfInterest]¦null	false	none	List of Profile of Interest (POI) related details for the person.
linkedIndividuals	[Sapphire.AssociatePerson]¦null	false	none	List of individuals associated with the person.
linkedCompanies	[Sapphire.AssociateCorp]¦null	false	none	List of companies associated with the person.
sources	[Sapphire.Source]¦null	false	none	List of all public sources, including both government and media sources, used to build the full profile.

Sapphire.EntityCorp

{
  "uniqueId": "string",
  "category": "string",
  "categories": "string",
  "primaryName": "string",
  "primaryLocation": "string",
  "images": [
    "string"
  ],
  "furtherInformation": "string",
  "lastReviewed": "string",
  "generalInfo": {
    "businessDescription": "string",
    "website": "string",
    "businessTypes": "string",
    "activities": "string"
  },
  "descriptions": [
    {
      "description1": "string",
      "description2": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "entityName": "string"
    }
  ],
  "locations": [
    {
      "country": "string",
      "countryCode": "string",
      "city": "string",
      "address": "string",
      "type": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "origin": "string",
      "measures": "string",
      "types": "string",
      "isCurrent": true
    }
  ],
  "identifiers": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "profileOfInterests": [
    {
      "category": "string",
      "positions": [
        {
          "position": "string",
          "segment": "string",
          "country": "string",
          "from": "string",
          "to": "string"
        }
      ]
    }
  ],
  "linkedIndividuals": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "category": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "name": "string",
      "category": "string",
      "description": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "details": [
        {
          "categories": "string",
          "originalUrl": "string",
          "title": "string",
          "credibility": "string",
          "language": "string",
          "summary": "string",
          "keywords": "string",
          "captureDate": "string",
          "publicationDate": "string",
          "assetUrl": "string"
        }
      ]
    }
  ]
}

Represents detail profile of matched entity.

Properties

Name	Type	Required	Restrictions	Description
uniqueId	string¦null	false	none	Unique identifier of the organisation.
category	string¦null	false	none	Category of the organisation.
categories	string¦null	false	none	Full descriptive categories of the organisation.
primaryName	string¦null	false	none	organisation's primary name.
primaryLocation	string¦null	false	none	Organisation's primary location.
images	[string]¦null	false	none	List of URL links to the pictures of the organisation, if available.
furtherInformation	string¦null	false	none	Additional information of the organisation.
lastReviewed	string¦null	false	none	Last reviewed date of the profile record.
generalInfo	Sapphire.InfoCorp	false	none	Contains some general information about Organisation.
descriptions	[Sapphire.Description]¦null	false	none	Organisation's description list.
nameDetails	[Sapphire.CorpNameDetail]¦null	false	none	Detailed list of organisation name.
locations	[Sapphire.Location]¦null	false	none	List of locations associated with the organisation.
officialLists	[Sapphire.OfficialList]¦null	false	none	List of official lists where the organisation is found.
identifiers	[Sapphire.Identifier]¦null	false	none	List of registration/ID number of the organisation.
profileOfInterests	[Sapphire.ProfileOfInterest]¦null	false	none	List of Profile of Interest (POI) related details for the organisation.
linkedIndividuals	[Sapphire.AssociatePerson]¦null	false	none	List of individuals associated with the organisation.
linkedCompanies	[Sapphire.AssociateCorp]¦null	false	none	List of companies associated with the organisation.
sources	[Sapphire.Source]¦null	false	none	List of all public sources, including both government and media sources, used to build the full profile.

Sapphire.IDNumber

{
  "type": "string",
  "idNotes": "string",
  "number": "string"
}

Properties

Name	Type	Required	Restrictions	Description
type	string¦null	false	none	none
idNotes	string¦null	false	none	none
number	string¦null	false	none	none

Sapphire.Identifier

{
  "type": "string",
  "value": "string"
}

Identification or registration numbers from national and international authorities.

Properties

Name	Type	Required	Restrictions	Description
type	string¦null	false	none	Type of identity including registration number, registration date and status e.g. `Business Registration Number`, `Business Registration Date`, `Business Registration Status`, `OFAC Unique ID`, `SIC Number`, `DUNS number`, `Corporate Identification Number`, `VAT/Tax Number` etc.
value	string¦null	false	none	Value of the associated identity.

Sapphire.Info

{
  "nationality": "string",
  "alternateTitle": "string"
}

Contains some general information about person.

Properties

Name	Type	Required	Restrictions	Description
nationality	string¦null	false	none	Nationality of the person.
alternateTitle	string¦null	false	none	Alternative title of the person, if available.

Sapphire.InfoCorp

{
  "businessDescription": "string",
  "website": "string",
  "businessTypes": "string",
  "activities": "string"
}

Contains some general information about Organisation.

Properties

Name	Type	Required	Restrictions	Description
businessDescription	string¦null	false	none	The description about business of organisation.
website	string¦null	false	none	The website of the organisation.
businessTypes	string¦null	false	none	The type of business organisation involved.
activities	string¦null	false	none	Activities that are performed by organisation.

Sapphire.Location

{
  "country": "string",
  "countryCode": "string",
  "city": "string",
  "address": "string",
  "type": "string"
}

Represents Country, Region (State/Province), City, and address where information is available.

Properties

Name	Type	Required	Restrictions	Description
country	string¦null	false	none	Location country.
countryCode	string¦null	false	none	The ISO 3166-2 country code (alpha-2 code) of the location.
city	string¦null	false	none	Location city.
address	string¦null	false	none	Location address.
type	string¦null	false	none	Location type.

Sapphire.NameDetail

{
  "nameType": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string"
}

Represents details of the person's name including original script name, spelling variations and aliases.

Properties

Name	Type	Required	Restrictions	Description
nameType	string¦null	false	none	Type of name e.g. Original Script Name, Name Spelling Variation, Nickname etc.
firstName	string¦null	false	none	First name of the person.
middleName	string¦null	false	none	Middle name of the person.
lastName	string¦null	false	none	Last name of the person.

Sapphire.OfficialList

{
  "keyword": "string",
  "category": "string",
  "description": "string",
  "origin": "string",
  "measures": "string",
  "types": "string",
  "isCurrent": true
}

Represents detailed information about the official list.

Properties

Name	Type	Required	Restrictions	Description
keyword	string¦null	false	none	Name of the official list.
category	string¦null	false	none	Watchlist category of the official list.
description	string¦null	false	none	Name of the official list.
origin	string¦null	false	none	The country or region of the official list.
measures	string¦null	false	none	List of measures enforced by the official sanctioning body, if available.
types	string¦null	false	none	Types of sanctions classified by the official list, if available. Examples include: `Counter Narcotics`, `Human Rights`, `Non-Proliferation`, `Territorial Violation`, `Terrorism`.
isCurrent	boolean	false	none	Indicates if the Official List is still current (true) or outdated (false).

Sapphire.ProfileOfInterest

{
  "category": "string",
  "positions": [
    {
      "position": "string",
      "segment": "string",
      "country": "string",
      "from": "string",
      "to": "string"
    }
  ]
}

Represents details of the Profile of Interest (POI).

Properties

Name	Type	Required	Restrictions	Description
category	string¦null	false	none	The category of the POI.
positions	[Sapphire.ProfileOfInterestPosition]¦null	false	none	The positions held by the POI, if available.

Sapphire.ProfileOfInterestPosition

{
  "position": "string",
  "segment": "string",
  "country": "string",
  "from": "string",
  "to": "string"
}

Represents the position details of the Profile of Interest(POI).

Properties

Name	Type	Required	Restrictions	Description
position	string¦null	false	none	The job or role of the POI.
segment	string¦null	false	none	The category of in scope positions of the POI.
country	string¦null	false	none	Country of the term of office for the particular position.
from	string¦null	false	none	The Start date of the term of office for the particular position.
to	string¦null	false	none	The End date of the term of office in the particular position.

Sapphire.Role

{
  "title": "string",
  "segment": "string",
  "from": "string",
  "to": "string",
  "status": "string",
  "country": "string"
}

Represents the details of the PEP roles.

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	Represents the Job/Role of the PEP in the particular PEP Position.
segment	string¦null	false	none	The category of in scope positions of the PEP for a particular country.
from	string¦null	false	none	The Start date of the term of office for the particular role.
to	string¦null	false	none	The End date of the term of office in the particular role.
status	string¦null	false	none	Represent whether the particular role is `Current` or `Former`. There can be more than one Current and Former roles held by the PEP.
country	string¦null	false	none	Country of the term of office for the particular role.

Sapphire.SanctionedCountryResult

{
  "isPrimaryLocation": true,
  "countryCode": "string",
  "comment": "string",
  "url": "string",
  "isBlackList": true,
  "isGreyList": true
}

Details of the Sanctioned country.

Properties

Name	Type	Required	Restrictions	Description
isPrimaryLocation	boolean¦null	false	none	Indicates whether the sanctioned country is primary location of the entity.
countryCode	string¦null	false	none	Indicates 2-letter country code.
comment	string¦null	false	none	Description of sanctioned country.
url	string¦null	false	none	The reference link for sanctioned country.
isBlackList	boolean	false	none	Identifies whether the country is in BlackList or not.
isGreyList	boolean	false	none	Identifies whether the country is in GreyList or not.

Sapphire.SingleScanCorpResultDetail

{
  "category": "string",
  "matchedFields": "string",
  "matchRate": 0,
  "entity": {
    "uniqueId": "string",
    "category": "string",
    "categories": "string",
    "primaryName": "string",
    "primaryLocation": "string",
    "images": [
      "string"
    ],
    "furtherInformation": "string",
    "lastReviewed": "string",
    "generalInfo": {
      "businessDescription": "string",
      "website": "string",
      "businessTypes": "string",
      "activities": "string"
    },
    "descriptions": [
      {
        "description1": "string",
        "description2": "string"
      }
    ],
    "nameDetails": [
      {
        "nameType": "string",
        "entityName": "string"
      }
    ],
    "locations": [
      {
        "country": "string",
        "countryCode": "string",
        "city": "string",
        "address": "string",
        "type": "string"
      }
    ],
    "officialLists": [
      {
        "keyword": "string",
        "category": "string",
        "description": "string",
        "origin": "string",
        "measures": "string",
        "types": "string",
        "isCurrent": true
      }
    ],
    "identifiers": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "profileOfInterests": [
      {
        "category": "string",
        "positions": [
          {
            "position": "string",
            "segment": "string",
            "country": "string",
            "from": "string",
            "to": "string"
          }
        ]
      }
    ],
    "linkedIndividuals": [
      {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "category": "string",
        "description": "string"
      }
    ],
    "linkedCompanies": [
      {
        "name": "string",
        "category": "string",
        "description": "string"
      }
    ],
    "sources": [
      {
        "url": "string",
        "categories": "string",
        "details": [
          {
            "categories": "string",
            "originalUrl": "string",
            "title": "string",
            "credibility": "string",
            "language": "string",
            "summary": "string",
            "keywords": "string",
            "captureDate": "string",
            "publicationDate": "string",
            "assetUrl": "string"
          }
        ]
      }
    ]
  },
  "taxHavenCountryResults": [
    {
      "isPrimaryLocation": true,
      "countryCode": "string",
      "comment": "string",
      "url": "string"
    }
  ],
  "sanctionedCountryResults": [
    {
      "isPrimaryLocation": true,
      "countryCode": "string",
      "comment": "string",
      "url": "string",
      "isBlackList": true,
      "isGreyList": true
    }
  ]
}

Contains details about a organisation's single scan match result.

Properties

Name	Type	Required	Restrictions	Description
category	string¦null	false	none	The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, POI.
matchedFields	string¦null	false	none	Indicates matched fields. Contains combination of AKA, PrimaryName, FullPrimaryName, ScriptName, Gender, DOB, YOB and Country values.
matchRate	integer(int32)¦null	false	none	none
entity	Sapphire.EntityCorp	false	none	Represents detail profile of matched entity.
taxHavenCountryResults	[Sapphire.TaxHavenCountryResult]¦null	false	none	Provides tax haven information if country is identified as tax haven based on primary location and locations.
sanctionedCountryResults	[Sapphire.SanctionedCountryResult]¦null	false	none	Provides sanctioned information if country is identified as sanctioned based on primary location and locations.

Sapphire.SingleScanResultDetail

{
  "category": "string",
  "matchRate": 0,
  "matchedFields": "string",
  "person": {
    "uniqueId": "string",
    "category": "string",
    "categories": "string",
    "gender": "string",
    "deceased": "string",
    "primaryFirstName": "string",
    "primaryMiddleName": "string",
    "primaryLastName": "string",
    "images": [
      "string"
    ],
    "dateOfBirth": "string",
    "deceasedDate": "string",
    "placeOfBirth": "string",
    "primaryLocation": "string",
    "furtherInformation": "string",
    "lastReviewed": "string",
    "descriptions": [
      {
        "description1": "string",
        "description2": "string"
      }
    ],
    "nameDetails": [
      {
        "nameType": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string"
      }
    ],
    "roles": [
      {
        "title": "string",
        "segment": "string",
        "from": "string",
        "to": "string",
        "status": "string",
        "country": "string"
      }
    ],
    "importantDates": [
      {
        "dateType": "string",
        "dateValue": "string"
      }
    ],
    "nationalities": [
      "string"
    ],
    "nationalitiesCodes": [
      "string"
    ],
    "locations": [
      {
        "country": "string",
        "countryCode": "string",
        "city": "string",
        "address": "string",
        "type": "string"
      }
    ],
    "officialLists": [
      {
        "keyword": "string",
        "category": "string",
        "description": "string",
        "origin": "string",
        "measures": "string",
        "types": "string",
        "isCurrent": true
      }
    ],
    "identifiers": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "disqualifiedDirectors": [
      {
        "caseReference": "string",
        "company": "string",
        "reason": "string",
        "from": "string",
        "to": "string"
      }
    ],
    "profileOfInterests": [
      {
        "category": "string",
        "positions": [
          {
            "position": "string",
            "segment": "string",
            "country": "string",
            "from": "string",
            "to": "string"
          }
        ]
      }
    ],
    "linkedIndividuals": [
      {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "category": "string",
        "description": "string"
      }
    ],
    "linkedCompanies": [
      {
        "name": "string",
        "category": "string",
        "description": "string"
      }
    ],
    "sources": [
      {
        "url": "string",
        "categories": "string",
        "details": [
          {
            "categories": "string",
            "originalUrl": "string",
            "title": "string",
            "credibility": "string",
            "language": "string",
            "summary": "string",
            "keywords": "string",
            "captureDate": "string",
            "publicationDate": "string",
            "assetUrl": "string"
          }
        ]
      }
    ]
  },
  "taxHavenCountryResults": [
    {
      "isPrimaryLocation": true,
      "countryCode": "string",
      "comment": "string",
      "url": "string"
    }
  ],
  "sanctionedCountryResults": [
    {
      "isPrimaryLocation": true,
      "countryCode": "string",
      "comment": "string",
      "url": "string",
      "isBlackList": true,
      "isGreyList": true
    }
  ]
}

Contains details about a person's single scan match result.

Properties

Name	Type	Required	Restrictions	Description
category	string¦null	false	none	The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA.
matchRate	integer(int32)¦null	false	none	Indicates the Match Rate for each matched entity. Values are from 1 to 100.
matchedFields	string¦null	false	none	Indicates matched fields. Contains combination of `AKA`, `PrimaryName`, `FullPrimaryName`, `ScriptName`, `Gender`, `DOB`, `YOB` and `Country` values.
person	Sapphire.Entity	false	none	Represents detail profile of matched entity.
taxHavenCountryResults	[Sapphire.TaxHavenCountryResult]¦null	false	none	Provides tax haven information if country is identified as tax haven based on primary location and nationalities.
sanctionedCountryResults	[Sapphire.SanctionedCountryResult]¦null	false	none	Provides sanctioned information if country is identified as sanctioned based on primary location and nationalities.

Sapphire.Source

{
  "url": "string",
  "categories": "string",
  "details": [
    {
      "categories": "string",
      "originalUrl": "string",
      "title": "string",
      "credibility": "string",
      "language": "string",
      "summary": "string",
      "keywords": "string",
      "captureDate": "string",
      "publicationDate": "string",
      "assetUrl": "string"
    }
  ]
}

Details of public sources used to build the full profile.

Properties

Name	Type	Required	Restrictions	Description
url	string¦null	false	none	Link to original source or website.
categories	string¦null	false	none	List of source categories. Possible values are: `PEP`, `PEP by Association`, `Profile Of Interest`, `Sanctions`, `Regulatory Enforcement List`, `Disqualified Director`, `Insolvency`, `Reputational Risk Exposure`, `Identity`, `Gambling Risk Intelligence`, `Corporate/Business`, `State-Owned Enterprise`.
details	[Sapphire.SourceDetails]¦null	false	none	List of details for the dates when the source was recorded or captured.

Sapphire.SourceDetails

{
  "categories": "string",
  "originalUrl": "string",
  "title": "string",
  "credibility": "string",
  "language": "string",
  "summary": "string",
  "keywords": "string",
  "captureDate": "string",
  "publicationDate": "string",
  "assetUrl": "string"
}

Details of each date the source was recorded or captured.

Properties

Name	Type	Required	Restrictions	Description
categories	string¦null	false	none	List of source categories. Possible values are: `PEP`, `PEP by Association`, `Profile Of Interest`, `Sanctions`, `Regulatory Enforcement List`, `Disqualified Director`, `Insolvency`, `Reputational Risk Exposure`, `Identity`, `Gambling Risk Intelligence`, `Corporate/Business`, `State-Owned Enterprise`.
originalUrl	string¦null	false	none	Link to original source or website.
title	string¦null	false	none	The title captured from the source.
credibility	string¦null	false	none	The credibility of the source.
language	string¦null	false	none	The ISO 639-3 code for the language of the source.
summary	string¦null	false	none	A text snippet from the source, if available.
keywords	string¦null	false	none	The keywords associated with the source.
captureDate	string¦null	false	none	The date that the source was recorded or captured.
publicationDate	string¦null	false	none	The date that the source was originally published.
assetUrl	string¦null	false	none	The URL link to the PDF version of the source, if available.

Sapphire.TaxHavenCountryResult

{
  "isPrimaryLocation": true,
  "countryCode": "string",
  "comment": "string",
  "url": "string"
}

Details of the TaxHaven country.

Properties

Name	Type	Required	Restrictions	Description
isPrimaryLocation	boolean¦null	false	none	Indicates whether the tax haven country is primary location of the entity.
countryCode	string¦null	false	none	Indicates 2-letter country code.
comment	string¦null	false	none	Description of tax haven country.
url	string¦null	false	none	The reference link for tax haven country.