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": "",
"country": "string",
"listType": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
}';
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": "",
"country": "string",
"listType": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PersonScanEmeraldParam | false | Person scan parameter, which includes person information to find. name or firstName/lastName is required. name can be full name or original script. original script is a name in any Non-Latin/Roman based language, such as Cyrillic, Arabic, Hebrew, Chinese, etc... |
Detailed descriptions
body: Person scan parameter, which includes person information to find. name or firstName/lastName is required. name can be full name or original script. original script is a name in any Non-Latin/Roman based language, such as Cyrillic, Arabic, Hebrew, Chinese, etc... When both firstName/lastName and name are entered and name is Latin/Roman, the name is ignored and only firstName/lastName are scanned but, when the name is original script (Non-Latin/Roman) the result includes profiles matched with firstName/lastName or original script. gender can be male, female or empty. dob can be in dd/mm/yyyy or yyyy formats. listType can be pep or sanction. leave listType as empty to scan on all lists. use includedLists if you want to scan only over a specified sanction lists. use includedLists if you wish to scan against only specific sanction lists. If you wish to exclude particular sanction lists from your scan use excludedLists. Only one of the two lists can have a value and their value should be a comma separated id. Eg: UN, SDN etc. matchRate is a percentage from 1-100, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 100% being very close. When the entered name is an original script, match rate is calculated based on the number of matched parts. If you enter the optional fields dob, country or gender and they do not match the Emerald database, the match rate will be reduced by 40%, 50% or 60% respectively.
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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
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}
Retrieve Emerald person scan
Allows you to retrieve person scan on Emerald list by entering its scanId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | string | true | Scan Id, which includes scan id to retrieve. It is required. |
Example responses
200 Response
{
"scanParam": {
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"dob": "",
"country": "string",
"listType": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
},
"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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
}
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
}';
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
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OrganisationScanEmeraldParam | false | Organisation scan parameter, which includes organisation information to find. name is required and can be original script. use includedLists if you want to scan only over a specified sanction lists. use includedLists if you wish to scan against only specific sanction lists. If you wish to exclude particular sanction lists from your scan use excludedLists. Only one of the two lists can have a value and their value should be a comma separated id. Eg: UN, SDN etc. matchRate is a percentage from 1-100, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 100% being very close. If you enter the optional field country and it does not match the Emerald database, the match rate will be reduced by 50%. |
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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
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}
Retrieve Emerald organisation scan
Allows you to retrieve organisation scan on Emerald list by entering its scanId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | string | true | Scan Id, which includes scan id to retrieve. It is required. |
Example responses
200 Response
{
"scanParam": {
"name": "string",
"country": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
},
"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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
}
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
Retrieve Emerald sanction lists information
Allows you to retrieve information of Emerald sanction lists.
Example responses
200 Response
[
{
"id": "string",
"name": "string",
"enabled": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contains id, name and status of sanction 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": "",
"country": "string",
"matchRate": 75,
"maxResultCount": 100
}';
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": "",
"country": "string",
"matchRate": 75,
"maxResultCount": 100
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PersonScanSapphireParam | false | Person scan parameter, which includes person information to find. 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 Non-Latin/Roman based language (e.g. Cyrillic, Arabic, Chinese etc) or the full Latin-based name if you are unable to separate based on First, Middle and Last Name. gender can be male, female or empty. dob can be in date in dd/mm/yyyy or yyyy format. matchRate is a percentage from 1-100, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 100% being very close. If you enter the optional fields dob, country or gender and they do not match the Sapphire database, the found entity will be removed from the results. maxResultCount indicates the maximum number of matches that should be returned. It must be between 1 and 200; defaults to 100. |
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"
],
"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"
}
]
}
]
}
}
]
}
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}
Retrieve Sapphire person scan
Allows you to retrieve person scan on Sapphire list by entering its scanId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | string | true | Scan Id, which includes scan id to retrieve. It is required. |
Example responses
200 Response
{
"scanParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"originalName": "string",
"gender": "string",
"dob": "",
"country": "string",
"matchRate": 75,
"maxResultCount": 100
},
"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"
],
"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"
}
]
}
]
}
}
]
}
}
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",
"exact": false,
"maxResultCount": 100
}';
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",
"exact": false,
"maxResultCount": 100
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OrganisationScanSapphireParam | false | Organisation scan parameter, which includes organisation information to find. name is required. exact parameter indicates that the exactly matched results or closely matched results should be returned. maxResultCount indicates the maximum number of matches that should be returned. It must be between 1 and 200; defaults to 100. |
Example responses
201 Response
{
"date": "2019-08-24T14:15:22Z",
"scanId": "string",
"numberOfMatches": 0,
"corporates": [
{
"category": "string",
"matchedFields": "string",
"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"
}
]
}
]
}
}
]
}
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}
Retrieve Sapphire organisation scan
Allows you to retrieve organisation scan on Sapphire list by entering its scanId.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | string | true | Scan Id, which includes scan id to retrieve. It is required. |
Example responses
200 Response
{
"scanParam": {
"name": "string",
"country": "string",
"exact": false,
"maxResultCount": 100
},
"scanResult": {
"date": "2019-08-24T14:15:22Z",
"scanId": "string",
"numberOfMatches": 0,
"corporates": [
{
"category": "string",
"matchedFields": "string",
"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"
}
]
}
]
}
}
]
}
}
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
Retrieve user 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 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
Retrieve user 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 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
OrganisationScanEmeraldHistoryResult
{
"scanParam": {
"name": "string",
"country": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
},
"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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | OrganisationScanEmeraldParam | false | none | none |
| scanResult | OrganisationScanEmeraldResult | false | none | none |
OrganisationScanEmeraldParam
{
"name": "string",
"country": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Length: 0 - 250 | none |
| country | string¦null | false | Length: 0 - 100 | none |
| includedLists | string¦null | false | Length: 0 - 50 | none |
| excludedLists | string¦null | false | Length: 0 - 50 | none |
| matchRate | integer(int32)¦null | false | none | none |
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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | none |
| scanId | string¦null | false | none | none |
| numberOfMatches | integer(int32)¦null | false | none | none |
| organisations | [Emerald.Organisation]¦null | false | none | none |
OrganisationScanSapphireHistoryResult
{
"scanParam": {
"name": "string",
"country": "string",
"exact": false,
"maxResultCount": 100
},
"scanResult": {
"date": "2019-08-24T14:15:22Z",
"scanId": "string",
"numberOfMatches": 0,
"corporates": [
{
"category": "string",
"matchedFields": "string",
"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"
}
]
}
]
}
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | OrganisationScanSapphireParam | false | none | none |
| scanResult | OrganisationScanSapphireResult | false | none | none |
OrganisationScanSapphireParam
{
"name": "string",
"country": "string",
"exact": false,
"maxResultCount": 100
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | Length: 0 - 250 | none |
| country | string¦null | false | Length: 0 - 100 | none |
| exact | boolean | true | none | none |
| maxResultCount | integer(int32)¦null | false | none | none |
OrganisationScanSapphireResult
{
"date": "2019-08-24T14:15:22Z",
"scanId": "string",
"numberOfMatches": 0,
"corporates": [
{
"category": "string",
"matchedFields": "string",
"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"
}
]
}
]
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | none |
| scanId | string¦null | false | none | none |
| numberOfMatches | integer(int32)¦null | false | none | none |
| corporates | [Sapphire.SingleScanCorpResultDetail]¦null | false | none | none |
PersonScanEmeraldHistoryResult
{
"scanParam": {
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"dob": "",
"country": "string",
"listType": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
},
"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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | PersonScanEmeraldParam | false | none | none |
| scanResult | PersonScanEmeraldResult | false | none | none |
PersonScanEmeraldParam
{
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"dob": "",
"country": "string",
"listType": "string",
"includedLists": "string",
"excludedLists": "string",
"matchRate": 50
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | Length: 0 - 250 | none |
| firstName | string¦null | false | Length: 0 - 150 | none |
| middleName | string¦null | false | Length: 0 - 150 | none |
| lastName | string¦null | false | Length: 0 - 150 | none |
| gender | string¦null | false | Length: 0 - 10 | none |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
| country | string¦null | false | Length: 0 - 100 | none |
| listType | string¦null | false | Length: 0 - 20 | none |
| includedLists | string¦null | false | Length: 0 - 50 | none |
| excludedLists | string¦null | false | Length: 0 - 50 | none |
| matchRate | integer(int32)¦null | false | none | none |
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",
"since": "string",
"to": "string",
"idInList": "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
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | none |
| scanId | 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 |
| persons | [Emerald.Person]¦null | false | none | none |
PersonScanSapphireHistoryResult
{
"scanParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"originalName": "string",
"gender": "string",
"dob": "",
"country": "string",
"matchRate": 75,
"maxResultCount": 100
},
"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"
],
"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"
}
]
}
]
}
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | PersonScanSapphireParam | false | none | none |
| scanResult | PersonScanSapphireResult | false | none | none |
PersonScanSapphireParam
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"originalName": "string",
"gender": "string",
"dob": "",
"country": "string",
"matchRate": 75,
"maxResultCount": 100
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | Length: 0 - 100 | none |
| middleName | string¦null | false | Length: 0 - 100 | none |
| lastName | string¦null | false | Length: 0 - 100 | none |
| originalName | string¦null | false | Length: 0 - 250 | none |
| gender | string¦null | false | Length: 0 - 10 | none |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
| country | string¦null | false | Length: 0 - 100 | none |
| matchRate | integer(int32)¦null | false | none | none |
| maxResultCount | integer(int32)¦null | false | none | none |
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"
],
"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"
}
]
}
]
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | none |
| scanId | string¦null | false | none | none |
| numberOfMatches | integer(int32)¦null | false | none | none |
| persons | [Sapphire.SingleScanResultDetail]¦null | false | none | none |
CreditInfo
{
"credits": 0,
"remainingCredits": 0,
"expiryDate": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| credits | number(double) | false | none | none |
| remainingCredits | number(double) | false | none | none |
| expiryDate | string(date-time)¦null | false | none | none |
CreditsResult
{
"balance": 0,
"keyExpiryDate": "2019-08-24T14:15:22Z",
"credits": [
{
"credits": 0,
"remainingCredits": 0,
"expiryDate": "2019-08-24T14:15:22Z"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| balance | number(double) | false | none | none |
| keyExpiryDate | string(date-time)¦null | false | none | none |
| credits | [CreditInfo]¦null | 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 |
Emerald.Address
{
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"text": "string",
"note": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| address3 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| region | string¦null | false | none | none |
| postalCode | string¦null | false | none | none |
| country | string¦null | false | none | none |
| text | string¦null | false | none | none |
| note | string¦null | false | none | none |
Emerald.Contact
{
"value": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.DateOfBirth
{
"date": "string",
"note": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string¦null | false | none | none |
| note | string¦null | false | none | none |
Emerald.Identity
{
"number": "string",
"country": "string",
"note": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| number | string¦null | false | none | none |
| country | string¦null | false | none | none |
| note | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.Link
{
"url": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.NameDetail
{
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.OrgNameDetail
{
"name": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.Organisation
{
"uid": "string",
"updateAt": "string",
"updateInfo": "string",
"category": "string",
"name": "string",
"originalScriptName": "string",
"referenceType": "string",
"references": [
{
"name": "string",
"since": "string",
"to": "string",
"idInList": "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
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uid | string¦null | false | none | none |
| updateAt | string¦null | false | none | none |
| updateInfo | string¦null | false | none | none |
| category | string¦null | false | none | none |
| name | string¦null | false | none | none |
| originalScriptName | string¦null | false | none | none |
| referenceType | string¦null | false | none | none |
| references | [Emerald.Reference]¦null | false | none | none |
| program | string¦null | false | none | none |
| addresses | [Emerald.Address]¦null | false | none | none |
| otherNames | [Emerald.OrgNameDetail]¦null | false | none | none |
| identities | [Emerald.Identity]¦null | false | none | none |
| contacts | [Emerald.Contact]¦null | false | none | none |
| images | [string]¦null | false | none | none |
| links | [Emerald.Link]¦null | false | none | none |
| sources | [string]¦null | false | none | none |
| basis | string¦null | false | none | none |
| summary | string¦null | false | none | none |
| matchRate | number(double) | false | none | none |
Emerald.Party
{
"title": "string",
"since": "string",
"to": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| since | string¦null | false | none | none |
| to | string¦null | false | none | none |
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",
"since": "string",
"to": "string",
"idInList": "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
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uid | string¦null | false | none | none |
| updateAt | string¦null | false | none | none |
| updateInfo | string¦null | false | none | none |
| category | string¦null | false | none | none |
| deceased | boolean¦null | false | none | none |
| deceasedDate | string¦null | false | none | none |
| name | string¦null | false | none | none |
| title | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| gender | string¦null | false | none | none |
| originalScriptName | string¦null | false | none | none |
| datesOfBirth | [Emerald.DateOfBirth]¦null | false | none | none |
| placesOfBirth | [Emerald.PlaceOfBirth]¦null | false | none | none |
| referenceType | string¦null | false | none | none |
| references | [Emerald.Reference]¦null | false | none | none |
| program | string¦null | false | none | none |
| nationality | string¦null | false | none | none |
| citizenship | string¦null | false | none | none |
| addresses | [Emerald.Address]¦null | false | none | none |
| places | [Emerald.Place]¦null | false | none | none |
| otherNames | [Emerald.NameDetail]¦null | false | none | none |
| roles | [Emerald.Role]¦null | false | none | none |
| occupations | [string]¦null | false | none | none |
| father | string¦null | false | none | none |
| mother | string¦null | false | none | none |
| spouse | string¦null | false | none | none |
| children | [string]¦null | false | none | none |
| siblings | [string]¦null | false | none | none |
| identities | [Emerald.Identity]¦null | false | none | none |
| politicalParties | [Emerald.Party]¦null | false | none | none |
| contacts | [Emerald.Contact]¦null | false | none | none |
| images | [string]¦null | false | none | none |
| links | [Emerald.Link]¦null | false | none | none |
| sources | [string]¦null | false | none | none |
| basis | string¦null | false | none | none |
| summary | string¦null | false | none | none |
| matchRate | number(double) | false | none | none |
Emerald.Place
{
"country": "string",
"location": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | none |
| location | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.PlaceOfBirth
{
"city": "string",
"region": "string",
"location": "string",
"country": "string",
"text": "string",
"note": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| city | string¦null | false | none | none |
| region | string¦null | false | none | none |
| location | string¦null | false | none | none |
| country | string¦null | false | none | none |
| text | string¦null | false | none | none |
| note | string¦null | false | none | none |
| type | string¦null | false | none | none |
Emerald.Reference
{
"name": "string",
"since": "string",
"to": "string",
"idInList": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| since | string¦null | false | none | none |
| to | string¦null | false | none | none |
| idInList | string¦null | false | none | none |
Emerald.Role
{
"title": "string",
"since": "string",
"to": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| since | string¦null | false | none | none |
| to | string¦null | false | none | none |
Sapphire.AssociateCorp
{
"name": "string",
"category": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| category | string¦null | false | none | none |
| description | string¦null | false | none | none |
Sapphire.AssociatePerson
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| category | string¦null | false | none | none |
| description | string¦null | false | none | none |
Sapphire.CorpNameDetail
{
"nameType": "string",
"entityName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | none |
| entityName | string¦null | false | none | none |
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"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateType | string¦null | false | none | none |
| dateValue | string¦null | false | none | none |
Sapphire.Description
{
"description1": "string",
"description2": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description1 | string¦null | false | none | none |
| description2 | string¦null | false | none | none |
Sapphire.DisqualifiedDirector
{
"caseReference": "string",
"company": "string",
"reason": "string",
"from": "string",
"to": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseReference | string¦null | false | none | none |
| company | string¦null | false | none | none |
| reason | string¦null | false | none | none |
| from | string¦null | false | none | none |
| to | string¦null | false | none | none |
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"
],
"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"
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | string¦null | false | none | none |
| category | string¦null | false | none | none |
| categories | string¦null | false | none | none |
| gender | string¦null | false | none | none |
| deceased | string¦null | false | none | none |
| primaryFirstName | string¦null | false | none | none |
| primaryMiddleName | string¦null | false | none | none |
| primaryLastName | string¦null | false | none | none |
| images | [string]¦null | false | none | none |
| dateOfBirth | string¦null | false | none | none |
| deceasedDate | string¦null | false | none | none |
| placeOfBirth | string¦null | false | none | none |
| primaryLocation | string¦null | false | none | none |
| furtherInformation | string¦null | false | none | none |
| lastReviewed | string¦null | false | none | none |
| descriptions | [Sapphire.Description]¦null | false | none | none |
| nameDetails | [Sapphire.NameDetail]¦null | false | none | none |
| roles | [Sapphire.Role]¦null | false | none | none |
| importantDates | [Sapphire.Date]¦null | false | none | none |
| nationalities | [string]¦null | false | none | none |
| locations | [Sapphire.Location]¦null | false | none | none |
| officialLists | [Sapphire.OfficialList]¦null | false | none | none |
| identifiers | [Sapphire.Identifier]¦null | false | none | none |
| disqualifiedDirectors | [Sapphire.DisqualifiedDirector]¦null | false | none | none |
| profileOfInterests | [Sapphire.ProfileOfInterest]¦null | false | none | none |
| linkedIndividuals | [Sapphire.AssociatePerson]¦null | false | none | none |
| linkedCompanies | [Sapphire.AssociateCorp]¦null | false | none | none |
| sources | [Sapphire.Source]¦null | false | none | none |
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"
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | string¦null | false | none | none |
| category | string¦null | false | none | none |
| categories | string¦null | false | none | none |
| primaryName | string¦null | false | none | none |
| primaryLocation | string¦null | false | none | none |
| images | [string]¦null | false | none | none |
| furtherInformation | string¦null | false | none | none |
| lastReviewed | string¦null | false | none | none |
| generalInfo | Sapphire.InfoCorp | false | none | none |
| descriptions | [Sapphire.Description]¦null | false | none | none |
| nameDetails | [Sapphire.CorpNameDetail]¦null | false | none | none |
| locations | [Sapphire.Location]¦null | false | none | none |
| officialLists | [Sapphire.OfficialList]¦null | false | none | none |
| identifiers | [Sapphire.Identifier]¦null | false | none | none |
| profileOfInterests | [Sapphire.ProfileOfInterest]¦null | false | none | none |
| linkedIndividuals | [Sapphire.AssociatePerson]¦null | false | none | none |
| linkedCompanies | [Sapphire.AssociateCorp]¦null | false | none | none |
| sources | [Sapphire.Source]¦null | false | none | none |
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"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | none |
| value | string¦null | false | none | none |
Sapphire.Info
{
"nationality": "string",
"alternateTitle": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nationality | string¦null | false | none | none |
| alternateTitle | string¦null | false | none | none |
Sapphire.InfoCorp
{
"businessDescription": "string",
"website": "string",
"businessTypes": "string",
"activities": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| businessDescription | string¦null | false | none | none |
| website | string¦null | false | none | none |
| businessTypes | string¦null | false | none | none |
| activities | string¦null | false | none | none |
Sapphire.Location
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | none |
| countryCode | string¦null | false | none | none |
| city | string¦null | false | none | none |
| address | string¦null | false | none | none |
| type | string¦null | false | none | none |
Sapphire.NameDetail
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
Sapphire.OfficialList
{
"keyword": "string",
"category": "string",
"description": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| keyword | string¦null | false | none | none |
| category | string¦null | false | none | none |
| description | string¦null | false | none | none |
| origin | string¦null | false | none | none |
| measures | string¦null | false | none | none |
| types | string¦null | false | none | none |
| isCurrent | boolean | false | none | none |
Sapphire.ProfileOfInterest
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | none |
| positions | [Sapphire.ProfileOfInterestPosition]¦null | false | none | none |
Sapphire.ProfileOfInterestPosition
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| position | string¦null | false | none | none |
| segment | string¦null | false | none | none |
| country | string¦null | false | none | none |
| from | string¦null | false | none | none |
| to | string¦null | false | none | none |
Sapphire.Role
{
"title": "string",
"segment": "string",
"from": "string",
"to": "string",
"status": "string",
"country": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| segment | string¦null | false | none | none |
| from | string¦null | false | none | none |
| to | string¦null | false | none | none |
| status | string¦null | false | none | none |
| country | string¦null | false | none | none |
Sapphire.SingleScanCorpResultDetail
{
"category": "string",
"matchedFields": "string",
"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"
}
]
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | none |
| matchedFields | string¦null | false | none | none |
| entity | Sapphire.EntityCorp | false | none | none |
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"
],
"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"
}
]
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | none |
| matchRate | integer(int32) | false | none | none |
| matchedFields | string¦null | false | none | none |
| person | Sapphire.Entity | false | none | none |
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"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string¦null | false | none | none |
| categories | string¦null | false | none | none |
| details | [Sapphire.SourceDetails]¦null | false | none | none |
Sapphire.SourceDetails
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categories | string¦null | false | none | none |
| originalUrl | string¦null | false | none | none |
| title | string¦null | false | none | none |
| credibility | string¦null | false | none | none |
| language | string¦null | false | none | none |
| summary | string¦null | false | none | none |
| keywords | string¦null | false | none | none |
| captureDate | string¦null | false | none | none |
| publicationDate | string¦null | false | none | none |
| assetUrl | string¦null | false | none | none |