MemberCheck API Reference v2.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
v10.2 Updated: Sunday October 27, 2024.
The MemberCheck RESTful API provides you with access to MemberCheck functionality.
The MemberCheck API is organised around REST. It has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
Built-in HTTP features, such as HTTP authentication and HTTP verbs are used, which are understood by off-the-shelf HTTP clients.
Cross-origin resource sharing is supported, which allows you to interact securely with the API from a client-side web application (although 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 shaded area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Production URL: https://api.membercheck.com/api/v2
Demo URL: https://demo.api.membercheck.com/api/v2
Authentication
HTTP Authentication, scheme: bearer Please insert access token into field
API Key (ApiKey)
- Parameter Name: api-key, in: header. API Key Authentication
Authenticate your account when using the API by including your secret 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.
MemberCheck API expects the api-key to be included in all API requests to the server, in a header like this:
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
MemberCheck 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 the MemberCheck services.
HTTP status code summary
| Code | Status | Description |
|---|---|---|
| 200 | OK | The request was successful 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 or processed by the server. Bad Request is sent when no other error is applicable, or if the exact error is unknown, or does not have its own error code. |
| 401 | Unauthorised | The requested resource requires authentication. |
| 403 | Forbidden | The server is not able to fulfill the request. |
| 404 | Not Found | The requested resource does not exist on the server. |
| 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 details of the error.
401 example response
{
"Message": "Authorisation has been denied for this request."
}
Also the 400 - Bad Request response always contains a ModelState that describes detail of the incorrect or invalid parameter that was sent.
400 example response
{
"Message": "The request is invalid.",
"ModelState": {
"from": [
"Cannot convert 'from' query parameter value '123' to DateTime. The expected format is DD/MM/YYYY."
]
}
}
Pagination
GET requests that return multiple items will be paginated with 20 items by default. You can specify further pages with the pageIndex parameter. You can also set a custom page size up to 100 with the pageSize parameter.
ARGUMENTS
| Name | Description |
|---|---|
| pageIndex | The zero-based numbering for page index of results. Default Value: 0 |
| pageSize | The number of items or results per page. Default Value: 20 |
The "x-total-count" in Response Headers contains the total number of results.
Code samples
# You can also use wget
curl -X get https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10
GET https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10 HTTP/1.1
Host: demo.api.membercheck.com
Content-Type: application/json
Accept: application/json
api-key: your-api-key
<script>
$.ajax({
url: 'https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10',
method: 'get',
headers: {'api-key': 'your-api-key'},
success: function(data) {
console.log(JSON.stringify(data));
}
})
</script>
const request = require('node-fetch');
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10', { method: 'GET'})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10', params:
{
# TODO
}
p JSON.parse(result)
import requests
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10', params={
# TODO
})
print r.json()
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single?pageIndex=1&pageSize=10");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("api-key", "your-api-key");
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());
URI Scheme
All API access is over HTTPS, and accessed from https://demo.api.membercheck.com/api. All data is sent and received as JSON.
Where data is not available for fields, these blank fields will return as null.
Health Check
Health
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/health \
-H 'Accept: text/plain'
GET https://demo.api.membercheck.com/health HTTP/1.1
Accept: text/plain
const headers = {
'Accept':'text/plain'
};
fetch('https://demo.api.membercheck.com/health',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res;
}).then(function(body) {
console.log(body);
});
require 'rest-client'
headers = {
'Accept' => 'text/plain'
}
result = RestClient.get 'https://demo.api.membercheck.com/health',
params: {
}, headers: headers
import requests
headers = {
'Accept': 'text/plain'
}
r = requests.get('https://demo.api.membercheck.com/health', headers = headers)
print(r)
URL obj = new URL("https://demo.api.membercheck.com/health");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"text/plain"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/health", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /health
Returns the health status of the MemberCheck API service. This can be used to check the liveness of the service.
Example responses
200 Response
Healthy
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Indicates that the API service is healthy. | None |
| 503 | Service Unavailable | Indicates that the API Service is unhealthy or an error has occurred. | None |
Member Scans
The member scans API methods allow you to manage member single and batch scans (get history, get a specific scan, perform new scan).
New Member Single Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single
Performs new member single scan.
Member Scan - Scan New allows you to scan members by entering member information into the fields provided.
Body parameter
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | ScanInputParam | false | Scan parameters, which include match type and policy options, applicable to each scan. Please check with your Compliance Officer the Organisation's Scan Setting requirements in the MemberCheck web application. |
Example responses
201 Response
{
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"dataBreachCheckResults": [
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
],
"fatfJurisdictionRiskResults": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | ScanResult: contains brief information of matched entities. The returned scanId should be used in GET /member-scans/single/{id} API method to obtain details of this scan. The returned matchedEntities.resultId of each matched entity should be used in GET /member-scans/single/results/{id} API method to obtain entity profile information. |
ScanResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single
Returns member scan history.
Member Scan - Scan History provides a record of all scans performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | query | integer(int32) | false | Scan user id. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| matchType | query | array[string] | false | Match Type. See supported values below. |
| whitelistPolicy | query | array[string] | false | Whitelist Policy. See supported values below. |
| includeWebSearch | query | array[string] | false | Web Search included or not. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Monitoring update status (if available). See supported values below. |
| idvStatus | query | array[string] | false | ID Verification result status. Only applicable for IDVerification scanService. See supported values below. |
| idvFaceMatchStatus | query | array[string] | false | FaceMatch Verification result status. Only applicable for IDVerification scanService. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | IDVerification |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"scanService": "PepAndSanction",
"idvStatus": "NotVerified",
"idvFaceMatchStatus": "Pass",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of ScanHistoryLog; lists the scan match results for the scans that you searched for. The returned scanId should be used in GET /member-scans/single/{id} API method to obtain details of each scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ScanHistoryLog] | false | none | [Represents member scan history data.] |
| » date | string(date-time) | true | none | Date of scan. |
| » scanType | string¦null | false | none | Scan type. |
| » matchType | string¦null | false | none | Match type scanned. |
| » whitelist | string¦null | false | none | Whitelist policy used for scan. |
| » residence | string¦null | false | none | Address policy used for scan. |
| » blankAddress | string¦null | false | none | Blank address policy used for scan. |
| » pepJurisdiction | string¦null | false | none | PEP jurisdiction used for scan. |
| » excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| » scanService | string | false | none | none |
| » idvStatus | string¦null | false | none | ID Check result status of ID Verification scans. Only applicable for IDVerification scanService. |
| » idvFaceMatchStatus | string¦null | false | none | FaceMatch result status of ID Verification scans. Only applicable for IDVerification scanService. |
| » scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| » matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| » decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| »» match | integer(int32) | false | none | Number of Match decisions. |
| »» noMatch | integer(int32) | false | none | Number of No Match decisions. |
| »» notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| »» notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| »» risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
| » category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| » firstName | string¦null | false | none | The member first name scanned. |
| » middleName | string¦null | false | none | The member middle name scanned (if available). |
| » lastName | string¦null | false | none | The member last name scanned. |
| » scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| » dob | string¦null | false | none | The member date of birth scanned. |
| » idNumber | string¦null | false | none | The member ID number scanned. |
| » memberNumber | string¦null | false | none | The member number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The client id scanned. |
| » monitor | boolean¦null | false | none | Indicates if the member is being actively monitored. This property is returned for request pageSize of 100 and less. |
| » monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| » monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| scanService | PepAndSanction |
| scanService | IDVerification |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Member Single Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/report
Downloads a report of list of member scan history in Excel, Word, PDF or CSV.
Member Scan - Scan History - Report Download a report of scans based on specified filters for the selected organisation. Returns all records in CSV format, but up to 10,000 records in other formats.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| includeResultsSummary | query | boolean | false | Include matched result entities information or not. Only applicable for CSV format. |
| userId | query | integer(int32) | false | Scan user id. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| matchType | query | array[string] | false | Match Type. See supported values below. |
| whitelistPolicy | query | array[string] | false | Whitelist Policy. See supported values below. |
| includeWebSearch | query | array[string] | false | Web Search included or not. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Monitoring update status (if available). See supported values below. |
| idvStatus | query | array[string] | false | ID Verification result status. Only applicable for IDVerification scanService. See supported values below. |
| idvFaceMatchStatus | query | array[string] | false | FaceMatch Verification result status. Only applicable for IDVerification scanService. See supported values below. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | IDVerification |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/{id}
Returns details of a specific member scan.
Member Scan - Scan History - Detail of Scan History returns details of the Scan Parameters used and member information that was scanned and lists Found Entities that were identified from the Watchlists as possible matches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /member-scans/single API method response class returns this identifier in scanId. |
| fields | query | string | false | To retrieve specific fields in the response, use this parameter. Default value is scanParam, scanResult, resultEntities, you can also request decisions field. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
Example responses
200 Response
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"watchLists": [
"string"
],
"watchlistsNote": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
},
"scanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"dataBreachCheckResults": [
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
],
"fatfJurisdictionRiskResults": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | ScanHistoryDetail; details of the Scan Parameters used and member information that was scanned and lists Found Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /member-scans/single/results/{id} API method to obtain entity profile information. |
ScanHistoryDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Single Scan Result Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}
Gets the Profile Information of the Entity (all available information from the watchlists).
Member Scan - Scan History - Found Entities Returns all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"id": 0,
"person": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SingleScanResultDetail; Entity's Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. | SingleScanResultDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Single Scan Result Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/report
Downloads report file of Profile Information of the Entity.
Member Scan - Scan History - Found Entities - Report Downloads report file of all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Single Scan No Result Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/no-results-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/{id}/no-results-report
Downloads report file of no matches found scan.
Member Scan - Scan History - No Matches Entities - Report Downloads report file of no matches found scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /member-scans/single API method response class returns this identifier in scanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Member Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/batch \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/batch HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"param": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"updateMonitoringList": false,
"allowDuplicateFileName": true,
"includeJurisdictionRisk": "No"
},
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/batch
Performs new member batch scan.
Member Scan - Batch Scan allows you to scan uploaded batch files of member data against selected watchlists.
Body parameter
param:
matchType: Close
closeMatchRateThreshold: 80
whitelist: Apply
residence: Ignore
blankAddress: ApplyResidenceCountry
pepJurisdiction: Apply
excludeDeceasedPersons: No
dobTolerance: 0
updateMonitoringList: false
allowDuplicateFileName: true
includeJurisdictionRisk: No
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | object | false | none |
| » param | body | BatchScanInputParam | false | Batch scan parameters, which include match type and policy options. |
| »» matchType | body | string¦null | false | Used to determine how closely a watchlist entity name must match a member before being considered a match. |
| »» closeMatchRateThreshold | body | integer(int32)¦null | false | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| »» whitelist | body | string¦null | false | Used for eliminating match results previously determined to not be a true match. |
| »» residence | body | string¦null | false | Used for eliminating match results where the member and matching entity have a different Country of Residence. |
| »» blankAddress | body | string¦null | false | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| »» pepJurisdiction | body | string¦null | false | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. |
| »» excludeDeceasedPersons | body | string¦null | false | Used for eliminating deceased persons in match results. |
| »» dobTolerance | body | integer(int32)¦null | false | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| »» updateMonitoringList | body | boolean | false | none |
| »» allowDuplicateFileName | body | boolean | false | Used for allowing scan of files with duplicate name. |
| »» includeJurisdictionRisk | body | string¦null | false | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| » File | body | string(binary) | false | Batch file containing members |
Enumerated Values
| Parameter | Value |
|---|---|
| »» matchType | Close |
| »» matchType | Exact |
| »» matchType | ExactMidName |
| »» whitelist | Apply |
| »» whitelist | Ignore |
| »» residence | Ignore |
| »» residence | ApplyPEP |
| »» residence | ApplySIP |
| »» residence | ApplyRCA |
| »» residence | ApplyPOI |
| »» residence | ApplyAll |
| »» blankAddress | ApplyResidenceCountry |
| »» blankAddress | Ignore |
| »» pepJurisdiction | Apply |
| »» pepJurisdiction | Ignore |
| »» excludeDeceasedPersons | No |
| »» excludeDeceasedPersons | Yes |
| »» includeJurisdictionRisk | No |
| »» includeJurisdictionRisk | Yes |
Example responses
201 Response
{
"batchScanId": 0,
"status": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | BatchScanResult; contains batch scan identifier. The returned batchScanId should be used in GET /member-scans/batch/{id} API method to obtain details of this batch scan. |
BatchScanResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 409 | Conflict | An existing batch file with the same file name has been run within the last 12 months. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch
Returns member batch scan history.
Member Scan - Batch Scan History provides a record of all batch scans performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of BatchScanHistoryLog; lists the batch files that have been uploaded and includes Date and time, File name, Number of Members Scanned, Number of Matched Members, Total Number of Matches and Status of the scan. The returned batchScanId should be used in GET /member-scans/batch/{id} API method to obtain details of each batch scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BatchScanHistoryLog] | false | none | [Represents details of the member batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » membersScanned | integer(int32) | false | none | Number of members scanned. |
| » matchedMembers | integer(int32) | false | none | Number of matched members. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Member Batch Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/report
Downloads a list of member batch scan history report in Excel, Word or PDF.
Member Scan - Batch Scan History - Report Download a report file of all batch scans based on specified filters for the selected organisation. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/{id}
Returns details of a specific batch scan.
Member Scan - Batch Scan History - View Exception Report shows the batch scan results and a list of matched members.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
Example responses
200 Response
{
"organisation": "string",
"user": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"dobTolerance": 0,
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | BatchScanResults; lists the batch scan results and a list of matched members. The returned matchedEntities.scanId should be used in GET /member-scans/single/{id} API method to obtain details of each member scan of this batch. |
BatchScanResults |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/{id}/report
Downloads the report file for a member batch scan.
Member Scan - Batch Scan History - View Exception Report - Download Report Downloads a report of member batch scan results and a list of matched members if any, in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scan Exception Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/exception-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/{id}/exception-report
Downloads the exception report file (csv) of member batch scan.
Member Scan - Batch Scan History - Download Exception Report (csv) Downloads exception report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
| includeResultsSummary | query | boolean | false | Include matched result entities information or not. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scan Full Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/full-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/{id}/full-report
Downloads the full report file (csv) of member batch scan.
Member Scan - Batch Scan History - Download Full Report (csv) Downloads full report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Batch Scan Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/batch/{id}/status
Gets membe batch scan status detail.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
Example responses
200 Response
{
"batchScanId": 0,
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | BatchScanStatus; membe batch scan status detail. | BatchScanStatus |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Cancel Member Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/cancel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/batch/{id}/cancel
Canceles a scheduled membe batch scan.
Member Scan - Batch Scan History - Scheduled Cancel Canceles a scheduled membe batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member batch scan. The GET /member-scans/batch or POST /member-scans/batch API method response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Monitoring History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/monitoring',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/monitoring',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/monitoring");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/monitoring
Returns the monitoring history activities for members.
Member Scan - Monitoring History provides a record of all auto scans activities performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return member monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return member monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | MonitoringWithUpdates |
| scanResult | AllMonitoringScans |
| reviewStatus | NotReviewed |
| reviewStatus | InProgress |
| reviewStatus | Reviewed |
| reviewStatus | All |
Example responses
200 Response
[
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalMembersMonitored": 0,
"membersChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of MonitoringScanHistoryLog; lists the monitoring scans that have been done and includes Date, Total Members Monitored, Members Checked, New Matches, Updated Entities, Removed Matches and Status of the scan. The returned monitoringScanId should be used in GET /member-scans/monitoring/{id} API method to obtain details of each monitoring scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MonitoringScanHistoryLog] | false | none | [Represents details of the automated member monitoring scan.] |
| » monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan. |
| » date | string(date-time) | false | none | Date the monitoring scan was run. |
| » scanType | string | false | none | Monitoring Scan or Rescan. |
| » totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| » membersChecked | integer(int32) | false | none | Number of members in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| » newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the member. |
| » updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the member which have had changes detected in the watchlists. |
| » removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the member. |
| » status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| » reviewStatus | string¦null | false | none | Reviewed status for a monitoring scan. |
| » membersReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
Member Monitoring History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/monitoring/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/monitoring/report
Downloads a list of member monitoring activities in Excel, Word or PDF.
Member Scan - Monitoring History - Report Downloads a report of all auto scan activities based on specified filters for the selected organisation in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return member monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return member monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | MonitoringWithUpdates |
| scanResult | AllMonitoringScans |
| reviewStatus | NotReviewed |
| reviewStatus | InProgress |
| reviewStatus | Reviewed |
| reviewStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Monitoring Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/monitoring/{id}
Returns details of a specific monitoring scan.
Member Scan - Monitoring History shows the monitoring scan results and a list of members with detected changes and matches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member monitoring scan. The GET /member-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Example responses
200 Response
{
"organisation": "string",
"user": "string",
"scanType": "Single",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"totalMembersMonitored": 0,
"membersChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | MonitoringScanResults; lists the monitoring scan results and a list of matched members. The returned entities.scanId should be used in GET /member-scans/single/{id} API method to obtain details of each member scan of this monitoring scan. |
MonitoringScanResults |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Monitoring Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/monitoring/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/monitoring/{id}/report
Downloads a report of a specific monitoring scan in Excel, Word or PDF.
Member Scan - Monitoring History - View Exception Report - Download Report Downloads a report of monitoring scan results and a list of members with detected changes and new matches in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member monitoring scan. The GET /member-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| idNumber | query | string | false | Full ID Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIP subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | PEP |
| category | SIP |
| category | RCA |
| category | POI |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Enable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/{id}/monitor/enable
Enables a scanned member to be actively monitored and adds them to the Monitoring List.
Member Scan - Scan History - Monitor column Enables the member to be actively monitored and added to the Monitoring List. If the same Client Id already exists in the Monitoring List, this will replace the existing member in the Monitoring List. Client Ids for members must be unique as this will replace any existing member with the same Client Id in the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /member-scans/single API method response class returns this identifier in scanId. |
| forceUpdate | query | boolean | false | Used to ignore check existing member with the same scan history clientId in the Monitoring List. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 409 | Conflict | The requested resource conflicted with an existing member with the same clientId in the Monitoring List. |
None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Disable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/{id}/monitor/disable
Disables a scanned member from being monitored.
Member Scan - Scan History - Monitor column Disables the member in the Monitoring List from being actively monitored. The scanned member remains in the Monitoring List but is not actively monitored. To remove the member entirely from the Monitoring List, refer to Delete Member Monitoring.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /member-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Review Member Monitoring Results
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/{id}/monitor/review", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/{id}/monitor/review
Set review status of member monitoring scan and return review summary with "date;username" format.
Member Scan - Scan History - Review column Set review status of member monitoring result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /member-scans/single API method response class returns this identifier in scanId. |
| status | query | boolean | false | Specifies is member scan reviewed by the client. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success and last review change information is in the response body when status set to true. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Compromised Information Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/compromised-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/compromised-report
Downloads report file of Compromised Information of the Entity based on email address.
Member Scan - Scan History - Found data breaches - Report Downloads report file of all available data breaches found for given email address.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Linked Individual Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}
Gets the Profile Information of the linked individual entity of a matched member.
Member Scan - Scan History - Found Entities - Linked Individuals Returns all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedIndividuals.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Entity's Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. | Entity |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Linked Individual Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/linked-individuals/{individualId}/report
Downloads report file of Profile Information of the linked individual entity of a matched member.
Member Scan - Scan History - Found Entities - Linked Individuals - Report Downloads report file of all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedIndividuals.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Linked Company Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/linked-companies/{companyId}
Gets the Profile Information of the linked company entity of a matched member.
Member Scan - Scan History - Found Entities - Linked Companies Returns the Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedCompanies.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. | EntityCorp |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Linked Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/linked-companies/{companyId}/report
Downloads report file of Profile Information of the linked company entity of a matched member.
Member Scan - Scan History - Found Entities - Linked Companies - Report Downloads report file of all available information in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedCompanies.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Members Due Diligence Decisions
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/results/decisions
Adds a due diligence decision for matched persons.
Member Scan - Due Diligence Decision You are able to input due diligence decisions for a person selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | query | string | false | The result ids of matched members. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Member Due Diligence Decision
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/results/{id}/decisions
Adds a due diligence decision for a matched person.
Member Scan - Due Diligence Decision You are able to input due diligence decisions for a person selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Due Diligence History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/decisions
Gets due diligence decision history.
Member Scan - Due Diligence Decision provides due diligence decision history of person selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"username": "string",
"date": "2019-08-24T14:15:22Z",
"decision": "string",
"comment": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of DecisionHistory; lists the due diligence decisions for a person selected in the scan results or scan history. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DecisionHistory] | false | none | [Returns the due diligence decisions for a person or corporate entity.] |
| » username | string¦null | false | none | The user who recorded the decision. |
| » date | string(date-time) | false | none | The date and time of decision. |
| » decision | string¦null | false | none | The status and risk of decision. |
| » comment | string¦null | false | none | Additional comment entered with the decision. |
New Member AI Analysis Question
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"question": "string",
"helperText": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/single/results/{id}/questions
Provides answer according to user's question.
AI Analysis Allows you to ask questions and returns the answer details.
Body parameter
{
"question": "string",
"helperText": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | AIAnalysisInputParam | false | AIAnalysis param, which includes Question and HelperText. |
Example responses
201 Response
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | AIAnalysisResultInfo: returns answer details of asked question. The returned scanResultId should be used as id in GET /member-scans/single/results/{id}/questions API method to obtain details of the record. |
AIAnalysisResultInfo |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member AI Analysis Question History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/questions
Returns the answer details of an entity.
AI Analysis Returns AI Analysis records including question and answer details.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of AIAnalysisResultInfo; Returns AI Analysis records for an entity. The returned id should be used as questionId in PUT /member-scans/single/results/{id}/questions/{questionId} API method to perform strike/unstrike operation on record. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AIAnalysisResultInfo] | false | none | [Represents AIAnalysisResultInfo for entity.] |
| » id | integer(int32) | false | none | Identifier of AI Analysis record. This should be used in PUT /ai-analysis/question/{id} API method to Perform strike/unstrike operation on record. |
| » scanResultId | integer(int32) | false | none | The identifier of matched entity. The GET /member-scans/single/{id} or GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| » question | string¦null | false | none | Question to be asked for AI Analysis. |
| » answer | string¦null | false | none | Provides answer to the question. |
| » isStrikedOut | boolean | false | none | Identifies AI Analysis record is striked out or not. |
Update Member AI Analysis Question
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId} \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/questions/{questionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/member-scans/single/results/{id}/questions/{questionId}
Performs strike/unstrike operation.
AI Analysis allows user to strike/unstrike records if they want to suspend the answer information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| questionId | path | integer(int32) | true | Identifier of AI Analysis record. The POST /member-scans/single/results/{id}/questions or GET /member-scans/single/results/{id}/questions API method response class returns this identifier in id. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Single Scan Category Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/member-scans/single/results/{id}/category-risks", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/member-scans/single/results/{id}/category-risks
Returns category wise risks and overall risk level.
Member Scan - Due Diligence Decision provides category wise risks and overall risk level of person selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"categoryRisks": [
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
],
"overAllRisk": "Unallocated"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of RiskResult; lists of the category wise risks and overall risk level for a person selected in the scan results or scan history. | RiskResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Scans
The corp-scans API methods allow you to manage corporate single and batch scans (get history, get a specific scan, perform new scan).
New Corporate Single Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single
Performs new corporate single scan.
Corporate Scan - Scan New allows you to scan companies.
Body parameter
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | CorpScanInputParam | false | Scan parameters, which include match type and policy options, applicable to each scan. Please check with your Compliance Officer the Organisation's Scan Setting requirements in the MemberCheck web application. |
Example responses
201 Response
{
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"kybScanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | CorpScanResult; contains brief information of matched entities. The returned scanId should be used in GET /corp-scans/single/{id} API method to obtain details of this scan. The returned matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. |
CorpScanResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single
Returns corporate scan history.
Corporate Scan - Scan History provides a record of all scans performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | query | integer(int32) | false | Scan user id. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | none |
| matchType | query | array[string] | false | Match Type. See supported values below. |
| whitelistPolicy | query | array[string] | false | Whitelist Policy. See supported values below. |
| includeWebSearch | query | array[string] | false | Web Search included or not. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Monitoring update status (if available). |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | KYB |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"kybProductsCount": 0,
"kybCompanyProfileCount": 0,
"isPaS": true,
"isKYB": true,
"scanService": "PepAndSanction",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpScanHistoryLog; lists the scan match results for the scans that you searched for. The returned scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpScanHistoryLog] | false | none | [Represents corporate scan history data.] |
| » date | string(date-time) | false | none | Date of scan. |
| » scanType | string | false | none | Scan type. See supported values below. |
| » matchType | string | false | none | Match type scanned. See supported values below. |
| » whitelist | string | false | none | Whitelist policy scanned. |
| » addressPolicy | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » kybProductsCount | integer(int32)¦null | false | none | KYB Products Count. |
| » kybCompanyProfileCount | integer(int32)¦null | false | none | KYB Company Profile Count. |
| » isPaS | boolean¦null | false | none | Identifies that Sanctioned and Adverse Media scan is performed or not. |
| » isKYB | boolean¦null | false | none | Identifies that Know Your Business scan is performed or not. |
| » scanService | string | false | none | Type of service for scan. |
| » scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| » matches | integer(int32) | false | none | Number of matches found for the company. |
| » decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| »» match | integer(int32) | false | none | Number of Match decisions. |
| »» noMatch | integer(int32) | false | none | Number of No Match decisions. |
| »» notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| »» notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| »» risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
| » category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| » companyName | string¦null | false | none | The company name scanned. |
| » idNumber | string¦null | false | none | The company registration/ID number scanned. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| » registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| » entityNumber | string¦null | false | none | The company entity number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The company client id scanned. |
| » monitor | boolean¦null | false | none | Indicates if the company is being actively monitored. This property is returned for request pageSize of 100 and less. |
| » monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| » monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Corporate Single Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/report
Downloads a report of list of corporate scan history in Excel, Word, PDF or CSV.
Corporate Scan - Scan History - Report Download a report of scans based on specified filters for the selected organisation. Returns all records in CSV format, but up to 10,000 records in other formats.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| includeResultsSummary | query | boolean | false | Include matched result entities information or not. Only applicable for CSV format. |
| userId | query | integer(int32) | false | Scan user id. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| matchType | query | array[string] | false | Match Type. See supported values below. |
| whitelistPolicy | query | array[string] | false | Whitelist Policy. See supported values below. |
| includeWebSearch | query | array[string] | false | Web Search included or not. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Monitoring update status (if available). |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | KYB |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/{id}
Returns details of a specific corporate scan.
Corporate Scan - Scan History - Detail of Scan History returns details of the Scan Parameters used and company information that was scanned and lists Found Entities that were identified from the Watchlists as possible matches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| fields | query | string | false | To retrieve specific fields in the response, use this parameter. Default value is scanParam, scanResult, resultEntities, you can also request decisions field. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
Example responses
200 Response
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
},
"scanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"kybScanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpScanHistoryDetail; details of the Company information that was scanned and lists Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. |
CorpScanHistoryDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Single Scan Result Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}
Gets the Profile Information of the Entity (all available information from the watchlists).
Corporate Scan - Scan History - Found Entities Returns the Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"id": 0,
"entity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SingleScanCorpResultDetail; Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. | SingleScanCorpResultDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Single Scan Result Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/report
Downloads report file of Profile Information of the Entity.
Corporate Scan - Scan History - Found Entities - Report Downloads report file of all available information in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Single Scan No Result Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/no-results-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/{id}/no-results-report
Downloads report file of no matches found scan.
Corporate Scan - Scan History - No Matches Entities - Report Downloads report file of no matches found scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Corporate Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/batch \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/batch HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"param": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"updateMonitoringList": false,
"allowDuplicateFileName": true,
"includeJurisdictionRisk": "No"
},
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/batch
Performs new corporate batch scan.
Corporate Scan - Batch Scan allows you to scan uploaded batch files of company data against the lists and Watchlists to which your organisation has access.
Body parameter
param:
matchType: Close
closeMatchRateThreshold: 80
whitelist: Apply
addressPolicy: Ignore
blankAddress: ApplyDefaultCountry
updateMonitoringList: false
allowDuplicateFileName: true
includeJurisdictionRisk: No
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | object | false | none |
| » param | body | CorpBatchScanInputParam | false | Batch scan parameters, which include match type and policy options. |
| »» matchType | body | string¦null | false | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. |
| »» closeMatchRateThreshold | body | integer(int32)¦null | false | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| »» whitelist | body | string¦null | false | Used for eliminating match results previously determined to not be a true match. |
| »» addressPolicy | body | string¦null | false | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| »» blankAddress | body | string¦null | false | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| »» updateMonitoringList | body | boolean | false | Used for adding the companies to Monitoring List for all records in the batch file with clientId/entityNumber, if the Monitoring setting is On. |
| »» allowDuplicateFileName | body | boolean | false | Used for allowing scan of files with duplicate name. |
| »» includeJurisdictionRisk | body | string¦null | false | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| » File | body | string(binary) | false | Batch file containing companies |
Enumerated Values
| Parameter | Value |
|---|---|
| »» matchType | Close |
| »» matchType | Exact |
| »» matchType | ExactMidName |
| »» whitelist | Apply |
| »» whitelist | Ignore |
| »» addressPolicy | Ignore |
| »» addressPolicy | ApplyAll |
| »» blankAddress | ApplyDefaultCountry |
| »» blankAddress | Ignore |
| »» includeJurisdictionRisk | No |
| »» includeJurisdictionRisk | Yes |
Example responses
201 Response
{
"batchScanId": 0,
"status": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | BatchScanResult: contains batch scan identifier. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of this batch scan. |
BatchScanResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 409 | Conflict | An existing batch file with the same file name has been run within the last 12 months. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch
Returns corporate batch scan history.
Corporate Scan - Batch Scan History provides a record of all batch scans performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpBatchScanHistoryLog; lists the batch files that have been uploaded and includes Date and time, File name, Number of Companies Scanned, Number of Matched Companies, Total Number of Matches and Status of the scan. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of each batch scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpBatchScanHistoryLog] | false | none | [Represents details of the batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| » matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Corporate Batch Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/report
Downloads a list of corporate batch scan history report in Excel, Word or PDF.
Corporate Scan - Batch Scan History - Report Download a report file of all batch scans based on specified filters for the selected organisation. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/{id}
Returns details of a specific batch scan.
Corporate Scan - Batch Scan History - View Exception Report shows the batch scan results and a list of matched companies.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
Example responses
200 Response
{
"organisation": "string",
"user": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpBatchScanResults; lists the batch scan results and a list of matched companies. The returned matchedEntities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each company scan of this batch. |
CorpBatchScanResults |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/{id}/report
Downloads the report file for a corporate batch scan.
Corporate Scan - Batch Scan History - Download Exception Report Downloads a report of corporate batch scan results and a list of matched corporates if any, in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scan Exception Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/exception-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/{id}/exception-report
Downloads the exception report file (csv) of corporate batch scan.
Corporate Scan - Batch Scan History - Download Exception Report (csv) Downloads exception report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| includeResultsSummary | query | boolean | false | Include matched result entities information or not. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scan Full Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/full-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/{id}/full-report
Downloads the full report file (csv) of corporate batch scan.
Corporate Scan - Batch Scan History - Download Full Report (csv) Downloads full report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Batch Scan Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/batch/{id}/status
Gets corporate batch scan status detail.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
Example responses
200 Response
{
"batchScanId": 0,
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpBatchScanStatus; corporate batch scan status detail. | CorpBatchScanStatus |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Cancel Corporate Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/batch/{id}/cancel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/batch/{id}/cancel
Canceles a scheduled corporate batch scan.
Corporate Scan - Batch Scan History - Scheduled Cancel Canceles a scheduled corporate batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Monitoring History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/monitoring',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/monitoring");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/monitoring
Returns the monitoring history actvities for companies.
Corporate Scan - Monitoring History provides a record of all auto scan activities performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return company monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return company monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | MonitoringWithUpdates |
| scanResult | AllMonitoringScans |
| reviewStatus | NotReviewed |
| reviewStatus | InProgress |
| reviewStatus | Reviewed |
| reviewStatus | All |
Example responses
200 Response
[
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"companiesChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpMonitoringScanHistoryLog; lists the monitoring scans that have been done and includes Date, Total Companies Monitored, Companies Checked, New Matches, Updated Entities, Removed Matches and Status of the scan. The returned monitoringScanId should be used in GET /corp-scans/monitoring/{id} API method to obtain details of each monitoring scan. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpMonitoringScanHistoryLog] | false | none | [Represents details of the automated corporate monitoring scan.] |
| » monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| » date | string(date-time) | false | none | Date the monitoring scan was run. |
| » scanType | string | false | none | Monitoring Scan or Rescan. |
| » totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| » companiesChecked | integer(int32) | false | none | Number of companies in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| » newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| » updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| » removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| » status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| » reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| » companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
Corporate Monitoring History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/monitoring/report
Downloads a list of corporate monitoring activities in Excel, Word or PDF.
Corporate Scan - Monitoring History - Report Downloads a report of all auto scan activities based on specified filters for the selected organisation in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return company monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return company monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | MonitoringWithUpdates |
| scanResult | AllMonitoringScans |
| reviewStatus | NotReviewed |
| reviewStatus | InProgress |
| reviewStatus | Reviewed |
| reviewStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Monitoring Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/monitoring/{id}
Returns details of a specific monitoring scan.
Corporate Scan - Monitoring History shows the monitoring scan results and a list of companies with detected changes or matches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Example responses
200 Response
{
"organisation": "string",
"user": "string",
"scanType": "Single",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"totalCompaniesMonitored": 0,
"companiesChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpMonitoringScanResults; lists the monitoring scan results and a list of matched corporates. The returned entities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each corporate scan of this monitoring scan. |
CorpMonitoringScanResults |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Monitoring Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/monitoring/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/monitoring/{id}/report
Downloads a report of a specific monitoring scan in Excel, Word or PDF.
Corporate Scan - Monitoring History - View Exception Report - Download Report Downloads a report of monitoring scan results and a list of corporates with detected changes and new matches in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | All or part of Entity Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | All |
| subCategory | SanctionsLists |
| subCategory | LawEnforcement |
| subCategory | RegulatoryEnforcement |
| subCategory | OrganisedCrime |
| subCategory | FinancialCrime |
| subCategory | NarcoticsCrime |
| subCategory | ModernSlavery |
| subCategory | BriberyAndCorruption |
| subCategory | CyberCrime |
| subCategory | DisqualifiedDirectors |
| subCategory | ReputationalRisk |
| subCategory | Other |
| subCategory | Insolvency |
| subCategory | CustomWatchlist |
| subCategory | WarCrimes |
| subCategory | EndUseControl |
| subCategory | EnvironmentalCrime |
| subCategory | Fugitive |
| subCategory | Gambling |
| subCategory | HumanRightsViolation |
| subCategory | InterstateCommerceViolation |
| subCategory | LabourViolation |
| subCategory | PharmaTrafficking |
| subCategory | Piracy |
| subCategory | UnauthorisedIncident |
| subCategory | FormerSanctions |
| subCategory | All |
| decision | NotReviewed |
| decision | Match |
| decision | NoMatch |
| decision | NotSure |
| decision | All |
| risk | High |
| risk | Medium |
| risk | Low |
| risk | Unallocated |
| risk | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Enable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/{id}/monitor/enable
Enables a scanned company to be actively monitored and adds them to the Monitoring List.
Corporate Scan - Scan History - Monitor column Enables the company to be actively monitored and added to the Monitoring List. If the same Client Id already exists in the Monitoring List, this will replace the existing company in the Monitoring List. Client Ids for companies must be unique as this will replace any existing company with the same Client Id in the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| forceUpdate | query | boolean | false | Used to ignore check existing company with the same scan history clientId in the Monitoring List. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 409 | Conflict | The requested resource conflicted with an existing company with the same clientId in the Monitoring List. |
None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Disable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/{id}/monitor/disable
Disables a scanned company from being monitored.
Corporate Scan - Scan History - Monitor column Disables the company in the Monitoring List from being actively monitored. The scanned company remains in the Monitoring List but is not actively monitored. To remove the company entirely from the Monitoring List, refer to Delete Company Monitoring.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Review Corporate Monitoring Results
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/{id}/monitor/review", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/{id}/monitor/review
Set review status of corporate monitoring scan and return review summary with "date;username" format.
Corporate Scan - Scan History - Review column Set review status of corporate monitoring scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| status | query | boolean | false | Specifies is corporate scan reviewed by the client. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success and last review change information is in the response body when status set to true. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Linked Individual Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}
Gets the Profile Information of the linked individual entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Individuals Returns all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedIndividuals.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Entity's Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. | Entity |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Linked Individual Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/linked-individuals/{individualId}/report
Downloads report file of Profile Information of the linked individual entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Individuals - Report Downloads report file of all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedIndividuals.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Linked Company Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}
Gets the Profile Information of the linked company entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Companies Returns the Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedCompanies.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. | EntityCorp |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Linked Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/linked-companies/{companyId}/report
Downloads report file of Profile Information of the linked company entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Companies - Report Downloads report file of all available information in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedCompanies.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Corporates Due Diligence Decisions
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/results/decisions
Adds a due diligence decision for matched corporates.
Corporate Scan - Due Diligence Decision You are able to input due diligence decisions for a corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | query | string | false | The result ids of matched corporates. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New Corporate Due Diligence Decision
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/results/{id}/decisions
Adds a due diligence decision for a matched corporate.
Corporate Scan - Due Diligence Decision You are able to input due diligence decisions for a corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched corporate. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Due Diligence History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/decisions
Gets due diligence decision history.
Corporate Scan - Due Diligence Decision provides due diligence decision history of Entity selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched corporate. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"username": "string",
"date": "2019-08-24T14:15:22Z",
"decision": "string",
"comment": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of DecisionHistory; lists the due diligence decisions for a corporate selected in the scan results or scan history. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DecisionHistory] | false | none | [Returns the due diligence decisions for a person or corporate entity.] |
| » username | string¦null | false | none | The user who recorded the decision. |
| » date | string(date-time) | false | none | The date and time of decision. |
| » decision | string¦null | false | none | The status and risk of decision. |
| » comment | string¦null | false | none | Additional comment entered with the decision. |
New Corporate AI Analysis Question
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"question": "string",
"helperText": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/corp-scans/single/results/{id}/questions
Provides answer according to user's question.
AI Analysis Allows you to ask questions and returns the answer details.
Body parameter
{
"question": "string",
"helperText": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | AIAnalysisInputParam | false | AIAnalysis param, which includes Question and HelperText. |
Example responses
201 Response
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | AIAnalysisResultInfo: returns answer details of asked question. The returned scanResultId should be used as id in GET /corp-scans/single/results/{id}/questions API method to obtain details of the record. |
AIAnalysisResultInfo |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate AI Analysis Question History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/questions
Returns the answer details of an entity.
AI Analysis Returns AI Analysis records including question and answer details.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of AIAnalysisResultInfo; Returns AI Analysis records for an entity. The returned id should be used as questionId in PUT /corp-scans/results/{id}/questions/{questionId} API method to perform strike/unstrike operation on record. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AIAnalysisResultInfo] | false | none | [Represents AIAnalysisResultInfo for entity.] |
| » id | integer(int32) | false | none | Identifier of AI Analysis record. This should be used in PUT /ai-analysis/question/{id} API method to Perform strike/unstrike operation on record. |
| » scanResultId | integer(int32) | false | none | The identifier of matched entity. The GET /member-scans/single/{id} or GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| » question | string¦null | false | none | Question to be asked for AI Analysis. |
| » answer | string¦null | false | none | Provides answer to the question. |
| » isStrikedOut | boolean | false | none | Identifies AI Analysis record is striked out or not. |
Update Corporate AI Analysis Question
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId} \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/questions/{questionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/corp-scans/single/results/{id}/questions/{questionId}
Performs strike/unstrike operation.
AI Analysis allows user to strike/unstrike records if they want to suspend the answer information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| questionId | path | integer(int32) | true | Identifier of AI Analysis record. The POST /corp-scans/single/results/{id}/questions or GET /corp-scans/single/results/{id}/questions API method response class returns this identifier in id. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Single Scan Category Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/corp-scans/single/results/{id}/category-risks", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/corp-scans/single/results/{id}/category-risks
Returns category wise risks and overall risk level.
Corporate Scan - Due Diligence Decision provides category wise risks and overall risk level of corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"categoryRisks": [
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
],
"overAllRisk": "Unallocated"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of RiskResult; lists of the category wise risks and overall risk level for a corporate selected in the scan results or scan history. | RiskResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Users
Users List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/users \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/users HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/users', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/users
Returns list of users.
Administration - User displays all users, for the organisations to which you are assigned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| username | query | string | false | All or part of username. |
| firstName | query | string | false | All or part of user first name. |
| lastName | query | string | false | All or part of user last name. |
| query | string | false | All or part of user email. | |
| orgId | query | string | false | User's organization id. |
| roleId | query | integer(int32) | false | User role id. |
| accessRightId | query | integer(int32) | false | User access right id. |
| isMfaActive | query | boolean | false | If MFA is activated for user. |
| status | query | string | false | User status. |
| fullResult | query | boolean | false | If true, returns full data result including email, lastLoginDate, lastActiveDate. Default is false. |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
Example responses
200 Response
[
{
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of UserInfo; lists all the users that you have searched for. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [UserInfo] | false | none | none |
| » id | integer(int32) | false | none | none |
| » username | string¦null | false | none | none |
| » firstName | string¦null | false | none | none |
| » lastName | string¦null | false | none | none |
| » role | UserRole¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» name | string¦null | false | none | none |
| »» label | string¦null | false | none | none |
| »» accessRights | [UserAccessRight]¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» allow | boolean | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| » status | string | false | none | none |
| » creationDate | string(date-time)¦null | false | none | none |
| » lastLoginDate | string(date-time)¦null | false | none | none |
| » lastActiveDate | string(date-time)¦null | false | none | none |
| » dateTimeZone | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
New User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users
Creates a new user.
Administration - User - Add User creates a new user.
Body parameter
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserDetails | false | User information including user details, access rights and assigned organisations. |
Example responses
201 Response
0
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The user has been created and ID of newly created user returned. | integer |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
User Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/users/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/users/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/users/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/users/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/users/{id}
Returns details of a specific user.
Administration - User - User Details displays the user detail information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Example responses
200 Response
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | UserDetails; the user's detail. | UserDetails |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Update User
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/users/{id} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v2/users/{id} HTTP/1.1
Content-Type: application/json
const inputBody = '{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/users/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/users/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/users/{id}
Updates the information for the specified user.
Administration - User - Edit User updates a user information.
Body parameter
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
| body | body | UserDetails | false | User information including user details, access rights and assigned organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Users Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/users/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/users/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/users/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/users/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/users/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/users/report
Downloads the report file (csv) of users.
Administration - User - Download CSV downloads the report file (csv) of users.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| username | query | string | false | All or part of username. |
| firstName | query | string | false | All or part of user first name. |
| lastName | query | string | false | All or part of user last name. |
| query | string | false | All or part of user email. | |
| orgId | query | string | false | User's organization id. |
| roleId | query | integer(int32) | false | User role id. |
| accessRightId | query | integer(int32) | false | User access right id. |
| isMfaActive | query | boolean | false | If MFA is activated for user. |
| status | query | string | false | User status. |
| sort | query | string | false | Return results sorted by this parameter. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
My Profile
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/users/myprofile \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/users/myprofile HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/myprofile',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/users/myprofile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/users/myprofile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/myprofile");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/users/myprofile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/users/myprofile
Returns logon user profile detail.
Example responses
200 Response
{
"passwordExpiryDays": 0,
"agreementRequiredOrganisations": [
"string"
],
"acceptedAgreementFileName": "string",
"appLogo": "string",
"appLogoMini": "string",
"userRoles": [
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
],
"userStatuses": [
"Inactive"
],
"rights": [
"string"
],
"notifications": [
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
],
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | MyProfile; the logon user's profile detail. | MyProfile |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Update My Profile
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/users/myprofile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v2/users/myprofile HTTP/1.1
Content-Type: application/json
const inputBody = '{
"currentPassword": "string",
"newPassword": "string",
"mfaType": "Disabled",
"mfaVerificationCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/myprofile',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/users/myprofile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/users/myprofile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/myprofile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/users/myprofile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/users/myprofile
Updates logon user security details.
User profile updates logon user security details.
Body parameter
{
"currentPassword": "string",
"newPassword": "string",
"mfaType": "Disabled",
"mfaVerificationCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | MyProfileSecurity | false | Logon user security information including password details and MFA details. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Update My Profile MFA
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/myprofile/reset-mfa", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/myprofile/reset-mfa
Initiates MFA token for logon user.
User Profile Email: A verification code will be sent to logon user email. VirtualMfaDevice: Virtual authenticator token will be returned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| mfaType | query | string | false | New MFA type for logon user to be set. |
Enumerated Values
| Parameter | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
Example responses
200 Response
{
"tokenExpiry": 0,
"manualEntryKey": "string",
"qrCodeSetupImageUrl": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Logon user MFA token initiated. | MyProfileMfaSetupCode |
| 204 | No Content | Indicates success but nothing is in the response body (when mfaType value is Disabled). | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Reset User Password
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/{id}/reset-password \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/{id}/reset-password HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}/reset-password',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/{id}/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/{id}/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}/reset-password");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/{id}/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/{id}/reset-password
Resets password for the specified user.
Administration - User - Reset Passord resets password for a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Activate User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/{id}/activate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/{id}/activate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}/activate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/{id}/activate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/{id}/activate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}/activate");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/{id}/activate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/{id}/activate
Activates the specified user.
Administration - User - Activate User enables a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Deactivate User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/{id}/deactivate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/{id}/deactivate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}/deactivate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/{id}/deactivate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/{id}/deactivate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}/deactivate");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/{id}/deactivate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/{id}/deactivate
Deactivates the specified user.
Administration - User - Deactivate User disables a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Unlock User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/{id}/unlock \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/{id}/unlock HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}/unlock',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/{id}/unlock',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/{id}/unlock', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}/unlock");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/{id}/unlock", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/{id}/unlock
Unlocks the specified user.
Administration - User - Unlock User unlocks a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Reset API Key
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/users/{id}/reset-api-key", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/users/{id}/reset-api-key
Generates a new API access key for the specified user.
Administration - User - Reset API Access Key generates a new API access key for the specified user. It is valid for only 10 minutes. To apply this new key for the specified user, you must call for PUT /users/{id}.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 202 | Accepted | New API access key. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Organisations
Organisations List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations
Returns list of organisations.
Administration - Organisation Displays all organisations to which the user account with the API Key is assigned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| isKybActive | query | boolean | false | If the KYB service is enabled for the organisation. |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Example responses
200 Response
[
{
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "string",
"creationDate": "2019-08-24T14:15:22Z",
"isIdvActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgInfo; lists all the organisations that you have searched for. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgInfo] | false | none | none |
| » name | string¦null | false | none | none |
| » displayName | string¦null | false | none | none |
| » parentOrg | OrgInfo0¦null | false | none | none |
| »» id | string¦null | false | none | none |
| »» fullPath | string¦null | false | none | none |
| »» isReseller | boolean¦null | false | none | none |
| » country | OrgCountry¦null | false | none | none |
| »» timeZoneId | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» code | string¦null | false | Length: 0 - 5 | none |
| » complianceOfficers | [OrgUser]¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» firstName | string¦null | false | none | none |
| »» lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| »» username | string¦null | false | none | none |
| »» role | UserRole¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» label | string¦null | false | none | none |
| »»» accessRights | [UserAccessRight]¦null | false | none | none |
| »»»» id | integer(int32) | false | none | none |
| »»»» name | string¦null | false | none | none |
| »»»» allow | boolean | false | none | none |
| »» status | string¦null | false | none | none |
| »» singleOrgAssigned | boolean¦null | false | none | none |
| » accountManager | OrgUser¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» firstName | string¦null | false | none | none |
| »» lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| »» username | string¦null | false | none | none |
| »» role | UserRole¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» label | string¦null | false | none | none |
| »»» accessRights | [UserAccessRight]¦null | false | none | none |
| »» status | string¦null | false | none | none |
| »» singleOrgAssigned | boolean¦null | false | none | none |
| string¦null | false | none | none | |
| » creationDate | string(date-time)¦null | false | none | none |
| » isIdvActive | boolean¦null | false | none | none |
| » isMonitoringActive | boolean¦null | false | none | none |
| » isApiActive | boolean¦null | false | none | none |
| » status | string | false | none | none |
| » isAIAnalysisActive | boolean¦null | false | none | none |
| » isKybActive | boolean¦null | false | none | none |
| » id | string¦null | false | none | none |
| » fullPath | string¦null | false | none | none |
| » isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
| status | Inactive |
| status | Active |
Organisation Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations/{id}
Returns details of a specific organisation.
Administration - Organisation - Organisation Details displays the organisation detail information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Example responses
200 Response
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"scanEmailsSendToCO": true,
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "string",
"renewalDate": "string",
"terminationDate": "string"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"isIgnoreBlankDobActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
]
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankDobActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin"
}
],
"defaultCountry": {
"name": "string",
"code": "strin"
}
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "string",
"creationDate": "2019-08-24T14:15:22Z",
"isIdvActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OrgDetails; the organisation's detail. | OrgDetails |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Organisation Scan Settings
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations/{id}/scan-settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations/{id}/scan-settings
Returns brief details of a specific organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Example responses
200 Response
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"scanEmailsSendToCO": true,
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "string",
"renewalDate": "string",
"terminationDate": "string"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"isIgnoreBlankDobActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
]
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankDobActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin"
}
],
"defaultCountry": {
"name": "string",
"code": "strin"
}
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "string",
"creationDate": "2019-08-24T14:15:22Z",
"isIdvActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OrgDetails; the organisation's brief detail. | OrgDetails |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Activate Organisation
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/organisations/{id}/activate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/organisations/{id}/activate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}/activate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/organisations/{id}/activate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/organisations/{id}/activate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}/activate");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/organisations/{id}/activate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/organisations/{id}/activate
Activates the specified organisation.
Administration - Organisation - Activate Organisation enables an organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Deactivate Organisation
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/organisations/{id}/deactivate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/organisations/{id}/deactivate
Deactivates the specified organisation.
Administration - Organisation - Deactivate Organisation disables an organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Organisation List Accesses
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations/allListAccesses \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations/allListAccesses HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/allListAccesses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations/allListAccesses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations/allListAccesses', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/allListAccesses");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations/allListAccesses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations/allListAccesses
Returns all List Accesses.
Administration - Organisation Organisation Detail - List Access.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{}
]
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgListAccess; returns all available List Access for data source. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgListAccess] | false | none | none |
| » id | integer(int32) | false | none | none |
| » name | string¦null | false | none | none |
| » subLists | [OrgSubList]¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» name | string¦null | false | none | none |
| »» description | string¦null | false | none | none |
| »» subLists | [OrgSubList]¦null | false | none | none |
Organisation Countries
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations/countries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations/countries HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/countries");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations/countries
Returns list of organisation's countries.
Administration - Organisation Organisation List search - Country list.
Example responses
200 Response
[
{
"timeZoneId": "string",
"name": "string",
"code": "strin"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgCountry; lists countries of all organisations. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgCountry] | false | none | none |
| » timeZoneId | string¦null | false | none | none |
| » name | string¦null | false | none | none |
| » code | string¦null | false | Length: 0 - 5 | none |
New Organisation Custom Watchlists
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"fileType": "Individual",
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/organisations/{id}/custom-list
Uploads a custom list file for an organisation.
Administration - Organisation Organisation Detail - List Access.
Body parameter
fileType: Individual
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
| body | body | object | false | none |
| » fileType | body | string | false | The file type. See supported values below. |
| » File | body | string(binary) | false | Custom watchlist CSV file (ZIP compression of CSV format is also acceptable) containing profiles. |
Enumerated Values
| Parameter | Value |
|---|---|
| » fileType | Individual |
| » fileType | Corporate |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 201 | Created | The file has been uploaded and ID of newly uploaded file returned. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Organisation Custom Watchlists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId} \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/organisations/{id}/custom-list/{fileId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/organisations/{id}/custom-list/{fileId}
Downloads the custom list file.
Administration - Organisation Organisation Detail - List Access.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
| fileId | path | string | true | The identifier of a specific custom list file. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Account
Reset Password Token
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/account/reset-password \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v2/account/reset-password HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/account/reset-password',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/account/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/account/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/account/reset-password");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/account/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/account/reset-password
Returns reset password token validity.
Checks reset password token validity and returns token type.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| token | query | string | false | none |
Example responses
200 Response
{
"tokenExpired": true,
"isNewAccountPassword": true,
"passwordHistoryLimit": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | AccountResetPasswordTokenInfo: contains reset password token information. | AccountResetPasswordTokenInfo |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Reset Password
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/account/reset-password \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v2/account/reset-password HTTP/1.1
Content-Type: application/json
const inputBody = '{
"token": "string",
"newPassword": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/account/reset-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/account/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/account/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/account/reset-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/account/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/account/reset-password
Sets account new password.
Sets new password for specified account by token.
Body parameter
{
"token": "string",
"newPassword": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountResetPasswordData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The specified token is invalid or has expired. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Forgot Username
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/account/forgot-username \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v2/account/forgot-username HTTP/1.1
Content-Type: application/json
const inputBody = '{
"email": "string",
"recaptchaResponse": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/account/forgot-username',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/account/forgot-username',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/account/forgot-username', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/account/forgot-username");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/account/forgot-username", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/account/forgot-username
Sends username reminder to registered email address.
Sends username reminder to registered email address.
Body parameter
{
"email": "string",
"recaptchaResponse": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountForgotUsernameData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The captcha response could not verified. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Forgot Password
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v2/account/forgot-password \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v2/account/forgot-password HTTP/1.1
Content-Type: application/json
const inputBody = '{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/account/forgot-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v2/account/forgot-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v2/account/forgot-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/account/forgot-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v2/account/forgot-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v2/account/forgot-password
Resets password.
Resets user password and a link to reset password will be sent to registered email address.
Body parameter
{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountForgotPasswordData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The specified answer or captcha response could not verified. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Data Management
Member Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/data-management/member-batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/data-management/member-batch-scans
Returns member batch scan history.
Administration - Data Mgmt Data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of BatchScanHistoryLog; lists all member batch files of current organisation. The returned batchScanId could be used in DELETE /data-management/batch-scans/ API method. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BatchScanHistoryLog] | false | none | [Represents details of the member batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » membersScanned | integer(int32) | false | none | Number of members scanned. |
| » matchedMembers | integer(int32) | false | none | Number of matched members. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Corporate Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/data-management/corp-batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/data-management/corp-batch-scans
Returns corporate batch scan history.
Administration - Data Mgmt Data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpBatchScanHistoryLog; lists all corporate batch files of current organisation. The returned batchScanId could be used in DELETE /data-management/batch-scans/ API method. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpBatchScanHistoryLog] | false | none | [Represents details of the batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| » matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Member Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/data-management/member-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/data-management/member-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/member-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/data-management/member-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/data-management/member-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/member-scans");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/data-management/member-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/data-management/member-scans
Returns member scan history.
Administration - Data Mgmt Data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| clientId | query | string | false | Full Client ID. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanService | PepAndSanction |
| scanService | IDVerification |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"scanService": "PepAndSanction",
"idvStatus": "NotVerified",
"idvFaceMatchStatus": "Pass",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of ScanHistoryLog; lists all PEP & Sanctions and IDV member single scans of current organisation. The returned scanId could be used in DELETE /data-management/single-scans/ API method. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ScanHistoryLog] | false | none | [Represents member scan history data.] |
| » date | string(date-time) | true | none | Date of scan. |
| » scanType | string¦null | false | none | Scan type. |
| » matchType | string¦null | false | none | Match type scanned. |
| » whitelist | string¦null | false | none | Whitelist policy used for scan. |
| » residence | string¦null | false | none | Address policy used for scan. |
| » blankAddress | string¦null | false | none | Blank address policy used for scan. |
| » pepJurisdiction | string¦null | false | none | PEP jurisdiction used for scan. |
| » excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| » scanService | string | false | none | none |
| » idvStatus | string¦null | false | none | ID Check result status of ID Verification scans. Only applicable for IDVerification scanService. |
| » idvFaceMatchStatus | string¦null | false | none | FaceMatch result status of ID Verification scans. Only applicable for IDVerification scanService. |
| » scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| » matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| » decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| »» match | integer(int32) | false | none | Number of Match decisions. |
| »» noMatch | integer(int32) | false | none | Number of No Match decisions. |
| »» notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| »» notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| »» risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
| » category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| » firstName | string¦null | false | none | The member first name scanned. |
| » middleName | string¦null | false | none | The member middle name scanned (if available). |
| » lastName | string¦null | false | none | The member last name scanned. |
| » scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| » dob | string¦null | false | none | The member date of birth scanned. |
| » idNumber | string¦null | false | none | The member ID number scanned. |
| » memberNumber | string¦null | false | none | The member number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The client id scanned. |
| » monitor | boolean¦null | false | none | Indicates if the member is being actively monitored. This property is returned for request pageSize of 100 and less. |
| » monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| » monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| scanService | PepAndSanction |
| scanService | IDVerification |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Corporate Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/data-management/corp-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/data-management/corp-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/corp-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/data-management/corp-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/data-management/corp-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/corp-scans");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/data-management/corp-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/data-management/corp-scans
Returns corporate scan history.
Administration - Data Mgmt Data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanService | PepAndSanction |
| scanService | KYB |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"kybProductsCount": 0,
"kybCompanyProfileCount": 0,
"isPaS": true,
"isKYB": true,
"scanService": "PepAndSanction",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpScanHistoryLog; lists all Sanctions corporate single scans of current organisation. The returned scanId could be used in DELETE /data-management/single-scans/ API method. |
Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpScanHistoryLog] | false | none | [Represents corporate scan history data.] |
| » date | string(date-time) | false | none | Date of scan. |
| » scanType | string | false | none | Scan type. See supported values below. |
| » matchType | string | false | none | Match type scanned. See supported values below. |
| » whitelist | string | false | none | Whitelist policy scanned. |
| » addressPolicy | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » kybProductsCount | integer(int32)¦null | false | none | KYB Products Count. |
| » kybCompanyProfileCount | integer(int32)¦null | false | none | KYB Company Profile Count. |
| » isPaS | boolean¦null | false | none | Identifies that Sanctioned and Adverse Media scan is performed or not. |
| » isKYB | boolean¦null | false | none | Identifies that Know Your Business scan is performed or not. |
| » scanService | string | false | none | Type of service for scan. |
| » scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| » matches | integer(int32) | false | none | Number of matches found for the company. |
| » decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| »» match | integer(int32) | false | none | Number of Match decisions. |
| »» noMatch | integer(int32) | false | none | Number of No Match decisions. |
| »» notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| »» notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| »» risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
| » category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| » companyName | string¦null | false | none | The company name scanned. |
| » idNumber | string¦null | false | none | The company registration/ID number scanned. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| » registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| » entityNumber | string¦null | false | none | The company entity number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The company client id scanned. |
| » monitor | boolean¦null | false | none | Indicates if the company is being actively monitored. This property is returned for request pageSize of 100 and less. |
| » monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| » monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
Delete Batches
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/data-management/batch-scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/data-management/batch-scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/batch-scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/data-management/batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/data-management/batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/batch-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/data-management/batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/data-management/batch-scans
Delete PEP and Sanctions batches.
Administration - Data Mgmt Deletes data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| batchIds | query | string | false | ID of the selected batch files to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Scans Count
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/data-management/scans/count \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/data-management/scans/count HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/scans/count',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/data-management/scans/count',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/data-management/scans/count', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/scans/count");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/data-management/scans/count", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/data-management/scans/count
Returns scans count.
Administration - Data Mgmt
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanType | query | string | false | Scan Type. See supported values below. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Idv |
| scanType | Kyb |
| scanType | NoMatchFound |
| scanType | All |
| scanType | AllWithMonitoring |
Example responses
200 Response
0
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Indicates success but nothing is in the response body. | integer |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Scans
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/data-management/scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/data-management/scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/data-management/scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/data-management/scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/data-management/scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/data-management/scans
Delete Scans
Administration - Data Mgmt Deletes data in the specific organisation account. Idv - ID Verification scan data only; Kyb - KYB scan data only; NoMatchFound - All PEP and Sanctions scan data where No Matches were found (applies to Single and Batch Scans); All - All Single Scan, Batch Scan and whitelist data; AllWithMonitoring - All Single Scan, Batch Scan, whitelist and Monitoring List data.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanType | query | string | false | Scan Type. See supported values below. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Idv |
| scanType | Kyb |
| scanType | NoMatchFound |
| scanType | All |
| scanType | AllWithMonitoring |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Single Scans
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/data-management/single-scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/data-management/single-scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/data-management/single-scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/data-management/single-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/data-management/single-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/data-management/single-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/data-management/single-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/data-management/single-scans
Delete PEP & Sanctions, Know Your Business (KYB) and IDV single scans.
Administration - Data Mgmt Deletes data from selected PEP & Sanctions, Know Your Business (KYB) and IDV single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanIds | query | string | false | ID of the selected scans to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
ID Verification
ID Verification Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single/{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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/id-verification/single/{scanId}
Returns result of a specific ID Verification scan.
Individual Scan - Scan Results - Detail of Scan History returns details of the IDV Parameters and verification result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
{
"idvParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"birthDate": "DD/MM/YYYY",
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"idvResult": {
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "string",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z"
},
"idvFaceMatchStatus": "Pass",
"signatureKey": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"idvStatus": "NotVerified"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | IDVHistoryDetail: contains verification result of specified IDV scan. | IDVHistoryDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
ID Verification Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/id-verification/single/{scanId}/report
Downloads report file of ID Verification result.
Individual Scan - Scan Results - ID Verification - Report Downloads report file of ID Verification result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| isSingleScanReport | query | boolean | false | Indicates that request come from single scan or scan result report. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
New ID Verification
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/id-verification/single \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/id-verification/single HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"birthDate": "DD/MM/YYYY",
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/id-verification/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/id-verification/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/id-verification/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/id-verification/single
Performs new ID Verification.
Individual Scan - Single Scan - ID Verification allows you to apply ID Verification for your members by entering member information into the fields provided.
Body parameter
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"birthDate": "DD/MM/YYYY",
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | IDVInputParam | false | Information of the individual, including name and mobile number, and the country for source of verification. |
Example responses
201 Response
0
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The ID Verification request was created and its identifier was returned. | integer |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Resend
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/resend", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/id-verification/single/{scanId}/resend
Resends ID Verification link message to client.
Individual Scan - Scan Results - ID Verification - Resend Verification Link resends verification link if not received by the members.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of ID Verification scan. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
File URL
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/file-url", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/id-verification/single/{scanId}/file-url
Returns presigned URL of original file.
Individual Scan - Scan Results - ID Verification - Image or Video URL Returns the URL of the biometric facial matching image, liveness image or video, if available. The links to the images and video automatically expire after 15 minutes and will no longer be accessible.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of ID Verification scan. |
| type | query | string | false | Specify the file type. Options are IDFrontImage, IDBackImage, LivenessImage and LivenessVideo1. |
| isCompressed | query | boolean | false | Indicates whether to retrieve url of compressed file or original file. |
Enumerated Values
| Parameter | Value |
|---|---|
| type | IDBackImage |
| type | IDFrontImage |
| type | LivenessVideo1 |
| type | LivenessImage |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | String type. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/id-verification/single/{scanId}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/id-verification/single/{scanId}/status
To check whether IDV Status is completed or not.
Notifies whether IDV Status is completed or not.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of ID Verification scan. |
Example responses
200 Response
true
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Boolean type | boolean |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Business Ubo-Check
Country List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/countries \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/countries HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/countries");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/countries
Returns the list of countries.
Corporate Scan - Scan New - Know Your Business - Countries provides a list of countries available to perform a Know Your Business (KYB) scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"code": "string",
"name": "string",
"hasStates": true,
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of KYBCountryResult; lists the countries supported for the Know Your Business scans. Some countries contain State jurisdictions, and if the business Registration Number is supported for the Country. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBCountryResult] | false | none | [KYB Country information elements.] |
| » code | string¦null | false | none | The ISO 3166 2-letter country code. |
| » name | string¦null | false | none | Name of the country. |
| » hasStates | boolean | false | none | Indicates whether the country has registry subdivisions such as states or provinces. |
| » supportsRegistrationNumber | boolean | false | none | Denotes whether the country registry supports searching by business registration number. |
| » companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| » productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
Country-State List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/countries/{countryCode}/states", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/countries/{countryCode}/states
Returns a list of registry subdivisions such as States or provinces for the country. Where a country has subdivisions, you must use this code instead of the country code when performing a Know Your Business scan.
Corporate Scan - Scan New - Know Your Business - Country States provides a list of States or provinces for the specified country where the Know Your Business scan has subdivisions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| countryCode | path | string | true | The code of country. The GET /kyb/countries API method response class returns this identifier in CountryCode. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"code": "string",
"name": "string",
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of KYBStateResult; lists the States for the specified country and if the business Registration Number is supported for the State. | Inline |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBStateResult] | false | none | [Lists the KYB state results.] |
| » code | string¦null | false | none | The code for the registry subdivision. This is a combination of the ISO 3166 country and state codes. |
| » name | string¦null | false | none | Name of the subdivision (state or province). |
| » supportsRegistrationNumber | boolean | false | none | Denotes whether the subdivision registry supports searching by business Registration Number. |
| » companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| » productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
Company List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/kyb/company \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/kyb/company HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"countryCode": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"allowDuplicateKYBScan": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/company',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/kyb/company',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/kyb/company', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/company");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/kyb/company", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/kyb/company
The first step in performing a Know Your Business search for a company within the country (or state) registry. The company search will return the high-level information and status of matching companies and company codes which can then be used to query additional details.
Corporate Scan - Scan New - Know Your Business - Company Search allows you to search for a company within a country or state registry by entering the company's name or business registration number (if supported for the registry).
Body parameter
{
"countryCode": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"allowDuplicateKYBScan": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | KYBCompanyInputParam | false | Search parameters, which include Country ISO Code, ClientID, Company Name or Company Business Number |
Example responses
201 Response
{
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBScanResult; contains brief information of matched companies. The returned scanId should be used in GET /kyb/{scanId} API method to obtain details of this scan. |
KYBScanResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Company UBO
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/kyb/{scanId}/company/profile
Performs an enhanced-company profile search for ultimate beneficial ownership (UBO). Charges may apply for this additional information. Please check for cost details in kyb/{scanId}/company/profile/charge.
Corporate Scan - Scan New - Know Your Business - Company Profile performs an enhanced-company profile search for ultimate beneficial ownership (UBO). All available information of the company profile, representatives, shareholders and directors, and UBO information, if available, are returned.
Body parameter
{
"companyCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBCompanyProfileInputParam | false | Company Profile parameters, which include Company Code and ScanId |
Example responses
201 Response
{
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "string",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBEnhancedProfileResult; contains brief information of company profile. | KYBEnhancedProfileResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Company Product List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/kyb/{scanId}/products
Search for available document products on the selected company profile following the company search.
Corporate Scan - Scan New - Know Your Business - Product Search lists available company document products by entering the company scan identifier and the company code. Document products include current and historical company information and disclosure notices.
Body parameter
{
"companyCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBProductInputParam | false | Search parameters, which include Company Code |
Example responses
201 Response
{
"productResults": [
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyCode": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBProductResult; contains a list of available company document products for purchase. Information includes document title, cost charge, estimated delivery time, document summary and if a sample document report is available for preview before purchase. | KYBProductResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Product Order
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string",
"productEntityId": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/order", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/kyb/{scanId}/products/order
Creates an order to purchase document products of the company.
Corporate Scan - Scan New - Know Your Business - Products Order allows you to purchase documents available for the company by specifying the company code and selected product entity identifiers.
Body parameter
{
"companyCode": "string",
"productEntityId": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBProductOrderInputParam | false | Products Order parameters, which include company code and product entity identifier. |
Example responses
201 Response
{
"companyId": 0,
"productId": 0,
"message": "string",
"status": "Requested"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBProductOrderResult; contains the status of the document product ordered. The returned productId should be used in GET /kyb/{scanId}/products/{productId} API method to obtain the product. | KYBProductOrderResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Products Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/products/status
Returns details of the document products from a specific Know Your Business scan.
Corporate Scan - Scan History - Know Your Business - Document Products returns details of the document products from a specific Know Your Business scan and which includes Company Name, Product Title, Creation Date, Completion Date, Price and Status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBProductHistoryResult; details of the document products from a specific Know Your Business scan. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBProductHistoryResult] | false | none | [Represents details of product information.] |
| » productId | integer(int32) | false | none | The identifier of a specific product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
| » companyNumber | string¦null | false | none | Provides the registration number of company. |
| » companyName | string¦null | false | none | This provides the full name of the company. |
| » creationDate | string(date-time) | false | none | Identifies the creation date of the product. |
| » status | string | false | none | Identifies the status of the product. |
| » completionDate | string(date-time)¦null | false | none | The completion date of the product. |
| » productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| » currency | string¦null | false | none | The currency of the document product. |
| » productFormat | string¦null | false | none | The format of the document product. |
| » productTitle | string¦null | false | none | The title of the document product. |
| » deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| » productInfo | string¦null | false | none | Provides the document product information. |
| » price | number(double) | false | none | The price of the document product. |
| » isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
Product Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/{productId}/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/products/{productId}/file
Downloads the specific document product in PDF format.
Corporate Scan - Scan History - Know Your Business - Download Product Download the document product of the company based on the provided unique scan identifier and product identifier. Returns document in PDF format.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| productId | path | integer(int32) | true | The identifier of a specific document product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
KYB Details By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}
Returns details of the scan settings applied to a specific scan.
Corporate Scan - Scan History - Know Your Business - Detail of Know Your Business History returns details of the scan settings applied during scanning and may contain details from various screening services run during scanning. For KYB specific scan, this includes company information that was entered, the list of companies selected for enhanced profile UBO details, and document products that were requested at the time of the scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
},
"companyResults": [
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "string",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
],
"documentResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"kybParam": {
"country": "string",
"state": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBScanHistoryDetail; details of the Scan Parameters used, company information, list of companies with its enhanced profile and products that were requested at the time of scan. | KYBScanHistoryDetail |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/company/{companyId}/report
Downloads the results of the company scan and the document product information of the specific company profile. The report is available in PDF format only.
Corporate Scan - Scan History - Know Your Business - Company Report Downloads the PDF report file of all available information of the company profile including Company Name, ACN, Address, Status, Date and Documents purchased which includes Document Title, Date, Status and Price.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Products By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/products/file
Downloads all available purchased document products from a specific Know Your Business scan in a ZIP file format.
Corporate Scan - Scan History - Know Your Business - Companies Documents Download all available purchased document products from a specific Know Your Business scan in a ZIP file format. Only documents which have been fulfilled from the registry can be downloaded.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Products By CompanyId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/products/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/company/{companyId}/products/file
Downloads all purchased document products for a specific company.
Corporate Scan - Scan History - Know Your Business - Download Documents Downloads a ZIP file of all purchased documents for a specific company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Sample Product
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/sample/{productTitle}/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/products/sample/{productTitle}/file
Download a sample company document product in PDF format.
Corporate Scan - Scan New - Know Your Business - Sample Document Download a sample document product based on the the specified scan identifier and product title to preview before purchasing. Files are in PDF format.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| productTitle | path | string | true | Title of the product.The POST /kyb/{scanId}/products method response class returns this identifier in productResults.productTitle. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Company Profile Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/{companyId}/profile/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/company/{companyId}/profile/report
Downloads a PDF report file of a specific company profile details.
Corporate Scan - Scan History - Know Your Business - Report Downloads a PDF report file of all available information in the Company Profile including Basic Details, Representatives, Directors, Shareholders and UBO.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The unique identifier of the KYB company search. The POST /kyb/company/search API method response class returns this identifier in corpScanResult.kybSearchResults.Companies.code. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Company UBO Pricing Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/company/profile/charge", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/company/profile/charge
Returns the cost charge to access the enhanced-company profile (UBO).
Corporate Scan - Scan New - Know Your Business - Company Profile Charges returns the cost to access the enhanced-company profile. Results include the availability of the types of information from the registry which may include company registration details, representatives, shareholders and UBO information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
{
"enhancedProfilePrice": 0,
"basicInformation": true,
"representatives": true,
"shareholders": true,
"uboDeclaration": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBEnhancedProfileCreditChargeResult; details of Company Profile Credit Charge and the availability of the types of information including UBO information. | KYBEnhancedProfileCreditChargeResult |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Products Report By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/kyb/{scanId}/products/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/kyb/{scanId}/products/report
Downloads a PDF report file listing all company document products for a specific KYB scan.
Corporate Scan - Scan History - Know Your Business - Company documents - Report Download a PDF report file of all company documents requested for a specific KYB scan. Report includes Company Name, Registration Number, Document Title, Requested date, Downloaded date and Status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Lookup Values
System Settings
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/lookup-values/system-settings \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v2/lookup-values/system-settings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/lookup-values/system-settings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/lookup-values/system-settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/lookup-values/system-settings', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/lookup-values/system-settings");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/lookup-values/system-settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/lookup-values/system-settings
Returns system public settings.
Example responses
200 Response
{
"reCaptchaSettings": {
"globalUrl": "string",
"publicKey": "string"
},
"mailSettings": {
"fromEmail": "string",
"supportEmail": "string"
},
"serverTimezone": "string",
"isSSOEnabled": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SystemPublicSettings; detail of system public settings. | SystemPublicSettings |
| 500 | Internal Server Error | An error has occurred on the server. | None |
SSO URL
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token} \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token}");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/lookup-values/sso-url/{token}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/lookup-values/sso-url/{token}
Returns the single sign-on (SSO) login and logout URLs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| token | path | string | true | none |
Example responses
200 Response
{
"callbackUrl": "string",
"signOutUrl": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SsoSettings; detail of aws cognito settings. | SsoSettings |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Countries
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/lookup-values/countries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/lookup-values/countries HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/lookup-values/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/lookup-values/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/lookup-values/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/lookup-values/countries");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/lookup-values/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/lookup-values/countries
Returns list of countries.
Administration - Organisation - Organisation Details Country list.
Example responses
200 Response
[
{
"timeZoneId": "string",
"name": "string",
"code": "strin"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgCountry; lists all available countries. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgCountry] | false | none | none |
| » timeZoneId | string¦null | false | none | none |
| » name | string¦null | false | none | none |
| » code | string¦null | false | Length: 0 - 5 | none |
Timezones
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/lookup-values/time-zones \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/lookup-values/time-zones HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/lookup-values/time-zones',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/lookup-values/time-zones',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/lookup-values/time-zones', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/lookup-values/time-zones");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/lookup-values/time-zones", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/lookup-values/time-zones
Returns list of time zones.
Administration - Organisation Time zone list.
Example responses
200 Response
[
{
"id": "string",
"name": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgTimeZone; lists all available time zones. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgTimeZone] | false | none | none |
| » id | string¦null | false | none | none |
| » name | string¦null | false | none | none |
Monitoring Lists
Member Monitoring Lists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/monitoring-lists/member \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/monitoring-lists/member HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/member',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/monitoring-lists/member',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/monitoring-lists/member', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/member");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/monitoring-lists/member", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/monitoring-lists/member
Returns details of members in the monitoring list.
Monitoring - Monitoring List provides a record of all members in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| status | query | array[string] | false | Status of monitoring for the member i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Example responses
200 Response
[
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"gender": "string",
"idNumber": "string",
"address": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of MonitoringListMemberItem; lists the member's monitoring list items. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MonitoringListMemberItem] | false | none | none |
| » id | integer(int32) | false | none | The unique identifier for the member assigned by the system within the monitoring list. |
| » monitor | boolean | false | none | Status of monitoring for the member i.e. actively monitored (true) or disabled from monitoring (false). |
| » addedBy | string¦null | false | none | User who added the member to the monitoring list during a scan. |
| » dateAdded | string(date-time) | false | none | Date the member was first added to the monitoring list. |
| » memberNumber | string¦null | false | none | The unique Member Number entered for the member during scans. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The unique Client ID entered for the member during scans. |
| » firstName | string¦null | false | none | The first name scanned for the member. |
| » middleName | string¦null | false | none | The middle name scanned for the member. |
| » lastName | string¦null | false | none | The last name scanned for the member. |
| » scriptNameFullName | string¦null | false | none | The original script / full name scanned for the member. |
| » dob | string¦null | false | none | The date of birth scanned for the member. |
| » gender | string¦null | false | none | The gender scanned for the member. |
| » idNumber | string¦null | false | none | The ID Number scanned for the member. |
| » address | string¦null | false | none | The address scanned for the member. |
Member Monitoring Lists Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/monitoring-lists/member/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/monitoring-lists/member/report
Downloads the report file (csv) of members in the monitoring list.
Monitoring - Monitoring List - Download CSV Downloads the report file (csv) of all members in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| memberNumber | query | string | false | Full Member Number. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | Full Client ID. |
| status | query | array[string] | false | Status of monitoring for the member i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Monitoring lists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/monitoring-lists/corp \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/monitoring-lists/corp HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corp',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corp");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corp", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/monitoring-lists/corp
Returns details of companies in the monitoring list.
Monitoring - Monitoring List provides a record of all companies in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | The Entity Number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | The Client ID scanned. |
| status | query | array[string] | false | Status of monitoring for the company i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Example responses
200 Response
[
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"entityNumber": "string",
"clientId": "string",
"companyName": "string",
"address": "string",
"idNumber": "string",
"registrationNumber": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of MonitoringListCorpItem; lists the corporate's monitoring list items. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MonitoringListCorpItem] | false | none | none |
| » id | integer(int32) | false | none | The unique identifier for the company assigned by the system within the monitoring list. |
| » monitor | boolean | false | none | Status of monitoring for the company i.e. actively monitored (true) or disabled from monitoring (false). |
| » addedBy | string¦null | false | none | User who added the company to the monitoring list during a scan. |
| » dateAdded | string(date-time) | false | none | Date the company was first added to the monitoring list. |
| » entityNumber | string¦null | false | none | The unique Entity Number for the company entered during scans. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| » clientId | string¦null | false | none | The unique Client ID for the company entered during scans. |
| » companyName | string¦null | false | none | The name scanned for the company. |
| » address | string¦null | false | none | The address scanned for the company. |
| » idNumber | string¦null | false | none | The ID Number scanned for the company. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| » registrationNumber | string¦null | false | none | The Registration Number scanned for the company. |
Corporate Monitoring Lists Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/monitoring-lists/corp/report
Downloads the report file (csv) of companies in the monitoring list.
Monitoring - Monitoring List - Download CSV Downloads the report file (csv) of all companies in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| companyName | query | string | false | All or part of Company Name. |
| entityNumber | query | string | false | The Entity Number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | query | string | false | The Client ID scanned. |
| status | query | array[string] | false | Status of monitoring for the company i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Enable Member
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/monitoring-lists/member/{id}/enable
Activates monitoring for an existing member in the Monitoring List.
Monitoring - Monitoring List Enables an existing member in Monitoring List to be actively monitored. Member must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Disable Member
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/monitoring-lists/member/{id}/disable
Deactivates monitoring for an existing member in the Monitoring List.
Monitoring - Monitoring List Disables an existing member in the Monitoring List from being monitored. Member must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Enable Corporate
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/monitoring-lists/corp/{id}/enable
Activates monitoring for an existing company in the Monitoring List.
Monitoring - Monitoring List Enables an existing company in Monitoring List to be actively monitored. The company must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Disable Corporate
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/monitoring-lists/corp/{id}/disable
Deactivates monitoring for an existing company in the Monitoring List.
Monitoring - Monitoring List Disables an existing company in the Monitoring List from being monitored. Company must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Member
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/monitoring-lists/member/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/monitoring-lists/member/{id}
Delete an existing member from the Monitoring List.
Monitoring - Monitoring List Deletes an existing member from the Monitoring List. This does not impact on historical scans. The deleted member can be re-enabled for monitoring through POST member-scans/single/{id}/monitor/enable.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Corporate
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corp/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/monitoring-lists/corp/{id}
Delete an existing company from the Monitoring List.
Monitoring - Monitoring List Deletes an existing corporate from the Monitoring List. This does not impact on historical scans. The deleted corporation can be re-enabled for monitoring through POST corp-scans/single/{id}/monitor/enable.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Members
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/members \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/members HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"clientIds": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/members',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/monitoring-lists/members',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/monitoring-lists/members', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/members");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/monitoring-lists/members", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/monitoring-lists/members
Delete members from the Monitoring List.
Deletes existing members from the Monitoring List. This does not impact on historical scans.
Body parameter
{
"clientIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | MonitoringItems | false | Client Ids of items to be deleted. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of deleted items. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Delete Corporates
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/corps \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v2/monitoring-lists/corps HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"clientIds": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/monitoring-lists/corps',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v2/monitoring-lists/corps',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v2/monitoring-lists/corps', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/monitoring-lists/corps");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v2/monitoring-lists/corps", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v2/monitoring-lists/corps
Delete companies from the Monitoring List.
Deletes existing corporates from the Monitoring List. This does not impact on historical scans.
Body parameter
{
"clientIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | MonitoringItems | false | Client Ids of items to be deleted. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of deleted items. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Reports
Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/reports/single-activity \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/reports/single-activity HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/single-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/reports/single-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/reports/single-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/single-activity");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/reports/single-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/reports/single-activity
Downloads report file of Activity Report in Excel, Word or PDF.
Report - Activity Report Download a report of Activity Report based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
KYB Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/reports/business-ubo-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/reports/business-ubo-activity
Downloads a report file of the KYB and UBO Activity Report in Excel, Word or PDF.
Report - Business UBO Activity Report Download a report of KYB and UBO Activity Report which includes all company documents purchased based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Group Activity Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/reports/group-activity \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/reports/group-activity HTTP/1.1
Content-Type: application/json
const inputBody = '{
"fundIDs": "string",
"from": "string",
"to": "string",
"format": "PDF"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/group-activity',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/reports/group-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/reports/group-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/group-activity");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/reports/group-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/reports/group-activity
Downloads report file of Group Activity Report in Excel, Word or PDF.
Report - Group Activity Report Download a report of Group Activity Report based on specified filters for the selected organisations.
Body parameter
{
"fundIDs": "string",
"from": "string",
"to": "string",
"format": "PDF"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GroupActivityReportParam | false | Group Activity Report parameters, which include fundIDs, date range and format. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Monitoring Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/reports/monitoring \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/reports/monitoring HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/monitoring',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/reports/monitoring',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/reports/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/monitoring");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/reports/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/reports/monitoring
Downloads report file of Monitoring Report in Excel, Word or PDF.
Report - Monitoring Report Download a report of Monitoring Report based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| includeAllActivities | query | boolean | false | Report to include only Monitoring with updates OR All monitoring activities |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Member Due Diligence Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/reports/member-due-diligence \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/reports/member-due-diligence HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/member-due-diligence',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/reports/member-due-diligence',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/reports/member-due-diligence', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/member-due-diligence");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/reports/member-due-diligence", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/reports/member-due-diligence
Downloads report file of Member Due Diligence Report in Excel, Word, PDF or CSV.
Report - Member Due Diligence Report Downloads report file of Member Due Diligence Report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| from | query | string | false | Decision/Comment date from (DD/MM/YYYY). |
| to | query | string | false | Decision/Comment date to (DD/MM/YYYY). |
| includeAllDecisions | query | boolean | false | Report to include Latest Decision / Latest Comment OR All Decisions / All Comments. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Corporate Due Diligence Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v2/reports/corp-due-diligence", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v2/reports/corp-due-diligence
Downloads report file of Corporate Due Diligence Report in Excel, Word, PDF or CSV.
Report - Corporate Due Diligence Report Downloads report file of Corporate Due Diligence Report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| from | query | string | false | Decision/Comment date from (DD/MM/YYYY). |
| to | query | string | false | Decision/Comment date to (DD/MM/YYYY). |
| includeAllDecisions | query | boolean | false | Report to include Latest Decision / Latest Comment OR All Decisions / All Comments. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Business UBO Pricing List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/octet-stream' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
const inputBody = '{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/octet-stream',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/octet-stream',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/octet-stream',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/octet-stream"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/reports/business-ubo-pricing/search
Returns details of the KYB Business and UBO Pricing.
Report - KYB Business and UBO Pricing Report returns details of the documents and enhanced profile from a specific Know Your Business scan which includes Scan Date, Country, Company Name, Product Title, Requested Date, Completion Date, Price and Status.
Body parameter
{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | KYBPricingParam | false | KYB Business and UBO Pricing Report parameters, which include fundIDs, date range , document status and include enhanced profile. |
Example responses
200 Response
[
{
"scanDate": "string",
"orgNameWithFundID": "string",
"countryCode": "string",
"companyName": "string",
"productTitle": "string",
"orderId": "string",
"creditCharge": 0,
"creditCostPrice": "string",
"price": "string",
"requestedDate": "string",
"downloadedDate": "string",
"status": "string",
"enhancedProfileRequested": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBPricingReportResult; details of the business and UBO pricing. | Inline |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 403 | Forbidden | The server is not able to fulfill the request. | None |
| 404 | Not Found | The requested resource not found. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBPricingReportResult] | false | none | [Represents details of the KYB pricing report.] |
| » scanDate | string¦null | false | none | Provides the scan date. |
| » orgNameWithFundID | string¦null | false | none | Provides the organisation name and org id. |
| » countryCode | string¦null | false | none | Provides the code of the country. |
| » companyName | string¦null | false | none | Provides the full name of the company. |
| » productTitle | string¦null | false | none | The title of the document product. |
| » orderId | string¦null | false | none | The order reference of the document product. |
| » creditCharge | number(double) | false | none | Provides the credit charge of the document or enhanced profile. |
| » creditCostPrice | string¦null | false | none | Provides the credit cost price of the document or enhanced profile. |
| » price | string¦null | false | none | Provides the price of the document or enhanced profile. |
| » requestedDate | string¦null | false | none | Provides the requested date of the document or enhanced profile. |
| » downloadedDate | string¦null | false | none | Provides the downloaded date of the document or enhanced profile. |
| » status | string¦null | false | none | Provides the status of the document product. |
| » enhancedProfileRequested | boolean | false | none | Identifies enhanced profile is requested or not. |
Business UBO Pricing Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing HTTP/1.1
Content-Type: application/json
const inputBody = '{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/reports/business-ubo-pricing", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/reports/business-ubo-pricing
Downloads report file of KYB Business and UBO Pricing Report in CSV.
Report - KYB Business and UBO Pricing Report Download a report of KYB Business and UBO Pricing based on specified filters for the selected organisations, document statuses and enhanced profile inclusion.
Body parameter
{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | KYBPricingReportParam | false | KYB Business and UBO Pricing Report parameters, which include fundIDs, date range , document status and include enhanced profile. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Group Monitoring Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary HTTP/1.1
Content-Type: application/json
const inputBody = '{
"fundIDs": "string",
"from": "string",
"to": "string",
"format": "PDF"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary");
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());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v2/reports/monitoring-group-summary", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/reports/monitoring-group-summary
Downloads report file of Monitoring Group Summary Report in Excel, Word or PDF.
Report - Monitoring Group Summary Report Download a report of Monitoring Group Summary Report based on specified filters for the selected organisations.
Body parameter
{
"fundIDs": "string",
"from": "string",
"to": "string",
"format": "PDF"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GroupActivityReportParam | false | Monitoring Group Summary Report parameters, which include fundIDs, date range and format. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | The request could not be understood or processed by the server. | None |
| 401 | Unauthorized | The requested resource requires authentication. | None |
| 500 | Internal Server Error | An error has occurred on the server. | None |
Schemas
AIAnalysisInputParam
{
"question": "string",
"helperText": "string"
}
AIAnalysisInputParam which includes ScanResultId, Question and Helpertext.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| question | string | true | none | Question to be asked for AI Analysis. |
| helperText | string¦null | false | none | Used to define question context for AI Analysis. |
AIAnalysisResultInfo
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
Represents AIAnalysisResultInfo for entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Identifier of AI Analysis record. This should be used in PUT /ai-analysis/question/{id} API method to Perform strike/unstrike operation on record. |
| scanResultId | integer(int32) | false | none | The identifier of matched entity. The GET /member-scans/single/{id} or GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| question | string¦null | false | none | Question to be asked for AI Analysis. |
| answer | string¦null | false | none | Provides answer to the question. |
| isStrikedOut | boolean | false | none | Identifies AI Analysis record is striked out or not. |
AccountForgotPasswordData
{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| username | string | true | none | none |
| recaptchaResponse | string | true | none | none |
| answer | string¦null | false | none | none |
AccountForgotUsernameData
{
"email": "string",
"recaptchaResponse": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| string | true | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| recaptchaResponse | string | true | none | none |
AccountResetPasswordData
{
"token": "string",
"newPassword": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| token | string | true | none | none |
| newPassword | string¦null | false | Length: 0 - 100 Pattern: ^(?=.&#... |
none |
AccountResetPasswordTokenInfo
{
"tokenExpired": true,
"isNewAccountPassword": true,
"passwordHistoryLimit": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokenExpired | boolean | false | none | none |
| isNewAccountPassword | boolean¦null | false | none | none |
| passwordHistoryLimit | integer(int32)¦null | false | none | none |
AssociateCorp
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
Profile of the associated or related company, organisation, or other entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | Name of associated company. |
| category | string¦null | false | none | Category of the associated company. |
| subcategories | string¦null | false | none | Subcategory of associated company.Note: Decommissioned on 1 July 2020. |
| description | string¦null | false | none | Description of the associate. |
AssociatePerson
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
Profile of the associate or related individual.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| firstName | string¦null | false | none | Associate's first name. |
| middleName | string¦null | false | none | Associate's middle name. |
| lastName | string¦null | false | none | Associate's last name. |
| category | string¦null | false | none | Category of the associated person. |
| subcategories | string¦null | false | none | Subcategory of the associate.Note: Decommissioned on 1 July 2020. |
| description | string¦null | false | none | Description of the associate. |
BatchScanHistoryLog
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Represents details of the member batch files, which have been uploaded and scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| membersScanned | integer(int32) | false | none | Number of members scanned. |
| matchedMembers | integer(int32) | false | none | Number of matched members. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
BatchScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"updateMonitoringList": false,
"allowDuplicateFileName": true,
"includeJurisdictionRisk": "No"
}
Batch scan parameters, which include match type and policy options.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| updateMonitoringList | boolean | false | none | none |
| allowDuplicateFileName | boolean | false | none | Used for allowing scan of files with duplicate name. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
BatchScanResult
{
"batchScanId": 0,
"status": "string"
}
Returns the batch scan identifier.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of this batch scan. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
BatchScanResults
{
"organisation": "string",
"user": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"dobTolerance": 0,
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Represents member batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the batch scan. |
| user | string¦null | false | none | The User performing the batch scan. |
| matchType | string | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string | false | none | Whitelist policy scanned. |
| residence | string | false | none | Address policy scanned. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| blankAddress | string | false | none | Blank address policy scanned. |
| pepJurisdiction | string | false | none | PEP jurisdiction scanned. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| excludeDeceasedPersons | string | false | none | Exclude deceased persons policy used for scan. |
| categoryResults | [CategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| matchedEntities | [ScanHistoryLog0]¦null | false | none | List of matched entities. |
| dobTolerance | integer(int32)¦null | false | none | DOB Tolerance used for scan. |
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| membersScanned | integer(int32) | false | none | Number of members scanned. |
| matchedMembers | integer(int32) | false | none | Number of matched members. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
BatchScanStatus
{
"batchScanId": 0,
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Represents status of the member batch file.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| membersScanned | integer(int32)¦null | false | none | Number of members scanned. This only available for Completed or Completed with errors status. |
| matchedMembers | integer(int32)¦null | false | none | Number of matched members. This only available for Completed or Completed with errors status. |
| numberOfMatches | integer(int32)¦null | false | none | Total number of matches. This only available for Completed or Completed with errors status. |
| progress | integer(int32)¦null | false | none | Progress of scanning. This only available for In Progress or Scanning status. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
CategoryResults
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
Represents the categories the matched record belongs to.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | Category of matched record, which can be TER, PEP, SIP and RCA. |
| matchedMembers | integer(int32) | false | none | Number of matched members with this Category. |
| numberOfMatches | integer(int32) | false | none | Number of total matches by Category and as a Total. |
CategoryRisk
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | none |
| subCategory | string¦null | false | none | none |
| risk | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| risk | Unallocated |
| risk | Low |
| risk | Med |
| risk | High |
CompanyResult
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
Represents the result data of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string¦null | false | none | A unique code for that entity that will be used for ordering a company profile or retrieving product documents. |
| companyNumber | string¦null | false | none | The registration number of the company. |
| date | string¦null | false | none | The date of the company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| legalStatusDescription | string¦null | false | none | Additional information on the legal status of the company. |
| address | string¦null | false | none | The address of the company. |
CorpBatchScanHistoryLog
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Represents details of the batch files, which have been uploaded and scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
CorpBatchScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"updateMonitoringList": false,
"allowDuplicateFileName": true,
"includeJurisdictionRisk": "No"
}
Batch scan parameters, which include match type and policy options.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| updateMonitoringList | boolean | false | none | Used for adding the companies to Monitoring List for all records in the batch file with clientId/entityNumber, if the Monitoring setting is On. |
| allowDuplicateFileName | boolean | false | none | Used for allowing scan of files with duplicate name. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
CorpBatchScanResults
{
"organisation": "string",
"user": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string"
}
Represents corporate batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the batch scan. |
| user | string¦null | false | none | The User performing the batch scan. |
| matchType | string | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string | false | none | Whitelist policy scanned. |
| addressPolicy | string | false | none | Address policy scanned. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| blankAddress | string | false | none | Blank address policy scanned. |
| categoryResults | [CorpCategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| matchedEntities | [CorpScanHistoryLog0]¦null | false | none | List of matched entities. |
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
CorpBatchScanStatus
{
"batchScanId": 0,
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Represents status of the corporate batch file.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| companiesScanned | integer(int32)¦null | false | none | Number of companies scanned. This only available for Completed or Completed with errors status. |
| matchedCompanies | integer(int32)¦null | false | none | Number of companies matched. This only available for Completed or Completed with errors status. |
| numberOfMatches | integer(int32)¦null | false | none | Total number of matches. This only available for Completed or Completed with errors status. |
| progress | integer(int32)¦null | false | none | Progress of scanning. This only available for In Progress or Scanning status. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
CorpCategoryResults
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
Represents the categories the matched record belongs to.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | Category of matched record, which can be TER, SIE, SOE and POI. |
| matchedCompanies | integer(int32) | false | none | Number of matched companies with this Category. |
| numberOfMatches | integer(int32) | false | none | Number of total matches by Category and as a Total. |
CorpMonitoringScanHistoryLog
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"companiesChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0
}
Represents details of the automated corporate monitoring scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string | false | none | Monitoring Scan or Rescan. |
| totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| companiesChecked | integer(int32) | false | none | Number of companies in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
CorpMonitoringScanResults
{
"organisation": "string",
"user": "string",
"scanType": "Single",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"totalCompaniesMonitored": 0,
"companiesChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0
}
Represents corporate batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the scan. |
| user | string¦null | false | none | The User performing the scan. |
| scanType | string | false | none | Monitoring Scan or Rescan. |
| matchType | string | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string | false | none | Whitelist policy scanned. |
| addressPolicy | string | false | none | Address policy scanned. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| blankAddress | string | false | none | Blank address policy scanned. |
| categoryResults | [CorpCategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| entities | [CorpScanHistoryLog0]¦null | false | none | List of matched entities. |
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| companiesChecked | integer(int32) | false | none | Number of companies in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
CorpNameDetail
{
"nameType": "string",
"entityName": "string"
}
Represents other aliases and also known as names of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | Type of name. |
| entityName | string¦null | false | none | The company name. |
CorpScanEntity
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Represents the scan result of the Corporate scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resultId | integer(int32) | false | none | The identifier of each matched entity. It should be used when requesting the GET /corp-scans/single/results/{id} API method to get the entity profile information. |
| uniqueId | integer(int32) | false | none | The unique identifier of matched entity. |
| resultEntity | EntityCorp¦null | false | none | Represents detail profile of matched entiry. |
| monitoredOldEntity | EntityCorp¦null | false | none | Represents old detail profile of monitored entiry. This only available if monitoringStatus is UpdatedMatches. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| matchedFields | string¦null | false | none | Indicates matched fields. Contains combination of AKA, PrimaryName, FullPrimaryName, ScriptName, Gender, DOB, YOB and Country values. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| name | string¦null | false | none | The name of the matched company. |
| matchRate | integer(int32)¦null | false | none | For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close). |
| primaryLocation | string¦null | false | none | The primary location of the matched company. |
| decisionDetail | DecisionDetail¦null | false | none | A list of due diligence decisions for matched entity. (If clientId/entityNumber was not included in the scan, decision will not available). |
| aiAnalysisQuestionCount | integer(int32)¦null | false | none | Number of AIAnalysis questions asked for matched entity. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and locations. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and locations. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
CorpScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
},
"scanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"kybScanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Details of the scan parameters and company information used to scan and list of Found Entities identified as possible matches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | CorpScanInputParamHistory | true | none | Scan parameters and company information used to scan. |
| scanResult | CorpScanResult | true | none | Lists Found Entities identified from the Watchlists as possible matches. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
CorpScanHistoryLog
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"kybProductsCount": 0,
"kybCompanyProfileCount": 0,
"isPaS": true,
"isKYB": true,
"scanService": "PepAndSanction",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
Represents corporate scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | Date of scan. |
| scanType | string | false | none | Scan type. See supported values below. |
| matchType | string | false | none | Match type scanned. See supported values below. |
| whitelist | string | false | none | Whitelist policy scanned. |
| addressPolicy | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| kybProductsCount | integer(int32)¦null | false | none | KYB Products Count. |
| kybCompanyProfileCount | integer(int32)¦null | false | none | KYB Company Profile Count. |
| isPaS | boolean¦null | false | none | Identifies that Sanctioned and Adverse Media scan is performed or not. |
| isKYB | boolean¦null | false | none | Identifies that Know Your Business scan is performed or not. |
| scanService | string | false | none | Type of service for scan. |
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| matches | integer(int32) | false | none | Number of matches found for the company. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| companyName | string¦null | false | none | The company name scanned. |
| idNumber | string¦null | false | none | The company registration/ID number scanned. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| entityNumber | string¦null | false | none | The company entity number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The company client id scanned. |
| monitor | boolean¦null | false | none | Indicates if the company is being actively monitored. This property is returned for request pageSize of 100 and less. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
CorpScanHistoryLog0
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
Represents the scan history data scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| matches | integer(int32) | false | none | Number of matches found for the company. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| companyName | string¦null | false | none | The company name scanned. |
| idNumber | string¦null | false | none | The company registration/ID number scanned. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| entityNumber | string¦null | false | none | The company entity number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The company client id scanned. |
| monitor | boolean¦null | false | none | Indicates if the company is being actively monitored. This property is returned for request pageSize of 100 and less. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
CorpScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
}
Scan parameters, which include match type and policy options, applicable to each scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| idNumber | string¦null | false | Length: 0 - 100 | Company ID Number - such as ABN, ACN or equivalent. If you enter an ID Number it will be used in the matching process and Company Name matches will be returned if the ID Number is 'contained' in the watchlist record. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| registrationNumber | string¦null | false | Length: 0 - 100 | Company Registration Number - such as ABN, ACN or equivalent. If you enter a Registration Number it will be used in the matching process and Company Name matches will be returned if the Registration Number is 'contained' in the watchlist record. |
| entityNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. |
| address | string¦null | false | Length: 0 - 255 | Company Address - you can enter the ISO 3166-1 2-letter country code, or the country name. You can also enter the full address (there are no restrictions imposed on the address format). Only the country component will be used for comparing country of operation or registration when the Country of Operation policy (addressPolicy) is applied. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the company to the Monitoring List if clientId/entityNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing company with the same clientId/entityNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| kybParam | KYBInputParam¦null | false | none | KYB Input Parameters. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
CorpScanInputParamHistory
{
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanType | string | false | none | Type of scan. |
| scanService | string | false | none | Type of scan service. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User who performed the scan. |
| date | string(date-time) | false | none | Date of scan. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| watchLists | [string]¦null | false | none | Scan against selected watchlists. This selection can be changed by the Compliance Officer in Administration > Organisations > List Access tab. |
| watchlistsNote | string¦null | false | none | none |
| kybCountryCode | string¦null | false | none | Country Code. |
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| idNumber | string¦null | false | Length: 0 - 100 | Company ID Number - such as ABN, ACN or equivalent. If you enter an ID Number it will be used in the matching process and Company Name matches will be returned if the ID Number is 'contained' in the watchlist record. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| registrationNumber | string¦null | false | Length: 0 - 100 | Company Registration Number - such as ABN, ACN or equivalent. If you enter a Registration Number it will be used in the matching process and Company Name matches will be returned if the Registration Number is 'contained' in the watchlist record. |
| entityNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. |
| address | string¦null | false | Length: 0 - 255 | Company Address - you can enter the ISO 3166-1 2-letter country code, or the country name. You can also enter the full address (there are no restrictions imposed on the address format). Only the country component will be used for comparing country of operation or registration when the Country of Operation policy (addressPolicy) is applied. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the company to the Monitoring List if clientId/entityNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing company with the same clientId/entityNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| kybParam | KYBInputParam¦null | false | none | KYB Input Parameters. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | KYB |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
CorpScanResult
{
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"kybScanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
}
Lists the scan match results of the Company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The matada about result. |
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| resultUrl | string¦null | false | none | This URL provides a link to view the scan information and details of the matched companies. Valid credentials are required as well as authorisation to view the scan results. |
| matchedNumber | integer(int32) | false | none | Number of matched entities found. 0 means no matches found. |
| matchedEntities | [CorpScanEntity]¦null | false | none | List of matched entities. |
| webSearchResults | [WebSearchResult]¦null | false | none | List of adverse media results on the web using Google search engine. |
| fatfJurisdictionRiskResult | [FATFJurisdictionRiskInfo]¦null | false | none | List of jurisdiction risk results. |
| kybScanResult | KYBScanResult¦null | false | none | List of companies and products history of Know Your Business scans. |
| monitoringReviewStatus | boolean¦null | false | none | Monitoring Review Status. |
| monitoringReviewSummary | string¦null | false | none | Monitoring Review Summary message. |
Country
{
"countryType": "string",
"countryValue": "string"
}
For individuals, this represents the country of nationality or citizenship. For entities, this represents the country where the entity is registered.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryType | string¦null | false | none | Relationship of the entity to the country. |
| countryValue | string¦null | false | none | Country name. |
DataBreachCheckInputParam
{
"emailAddress": "string"
}
Data Breach Check parameter.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Used for compromised email checks. Enter the member’s email address to run a check on compromised information in known data breaches. |
DataBreachCheckResult
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
Data Breach Check result, list results for data breaches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | Name of site where email breached. |
| domain | string¦null | false | none | Domain link of email breach. |
| breachDate | string¦null | false | none | Breach date of email breach |
| description | string¦null | false | none | Description of email breach |
| logoPath | string¦null | false | none | Logo path of email breach company |
| dataClasses | [string]¦null | false | none | List of data breached which includes email address, passwords etc. |
Date
{
"dateType": "string",
"dateValue": "string"
}
Represents different type of entity's date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateType | string¦null | false | none | Type of date. |
| dateValue | string¦null | false | none | Value of date. |
DecisionDetail
{
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Returns the due diligence decision, match decision and assessed risk of a member or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| text | string¦null | false | none | Description of the due diligence decision. |
| matchDecision | string | false | none | Due diligence match decision. The options are: Match, NoMatch, NotSure or NotReviewed (NotReviewed can be applicable until a decision is made). |
| assessedRisk | string | false | none | Allocate an assessed risk. This only applies if matchDecision is set to Match or NotSure. The options available are Unallocated (default), High, Medium or Low. |
| comment | string¦null | false | Length: 0 - 200 | Optional - additional comment or reason for the decision. |
Enumerated Values
| Property | Value |
|---|---|
| matchDecision | Match |
| matchDecision | NoMatch |
| matchDecision | NotSure |
| matchDecision | NotReviewed |
| matchDecision | Unknown |
| assessedRisk | Unallocated |
| assessedRisk | Low |
| assessedRisk | Med |
| assessedRisk | High |
DecisionHistory
{
"username": "string",
"date": "2019-08-24T14:15:22Z",
"decision": "string",
"comment": "string"
}
Returns the due diligence decisions for a person or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| username | string¦null | false | none | The user who recorded the decision. |
| date | string(date-time) | false | none | The date and time of decision. |
| decision | string¦null | false | none | The status and risk of decision. |
| comment | string¦null | false | none | Additional comment entered with the decision. |
DecisionInfo
{
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
Contains scan due diligence decisions count and risk information.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| match | integer(int32) | false | none | Number of Match decisions. |
| noMatch | integer(int32) | false | none | Number of No Match decisions. |
| notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
DecisionParam
{
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Record due diligence decision, match decision and assessed risk of a member or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchDecision | string | false | none | Due diligence match decision. The options are: Match, NoMatch, NotSure or NotReviewed (NotReviewed can be applicable until a decision is made). |
| assessedRisk | string | false | none | Allocate an assessed risk. This only applies if matchDecision is set to Match or NotSure. The options available are Unallocated (default), High, Medium or Low. |
| comment | string¦null | false | Length: 0 - 200 | Optional - additional comment or reason for the decision. |
Enumerated Values
| Property | Value |
|---|---|
| matchDecision | Match |
| matchDecision | NoMatch |
| matchDecision | NotSure |
| matchDecision | NotReviewed |
| matchDecision | Unknown |
| assessedRisk | Unallocated |
| assessedRisk | Low |
| assessedRisk | Med |
| assessedRisk | High |
DecisionResult
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Returns brief information of added decision and decisions count of main scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information of main scan. |
| decisionDetail | DecisionDetail¦null | false | none | The applied due diligence decision. |
Description
{
"description1": "string",
"description2": "string",
"description3": "string"
}
Represents the master list of classification.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description1 | string¦null | false | none | Contains the major watchlist category description. |
| description2 | string¦null | false | none | Contains the minor watchlist category description. |
| description3 | string¦null | false | none | Contains other additional watchlist category description.Note: Decommissioned on 1 July 2020. |
DirectorShip
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
Represents the detail hierarchy of directorship.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | The identifier of the directorship. |
| parentId | string¦null | false | none | The parent identifier of the directorship. This refers identifier of the directorship i.e. DirectorShip.ID. |
| role | string¦null | false | none | The role of the director. |
| name | string¦null | false | none | The name of the director. |
| type | string¦null | false | none | Provides the type of the directorship. |
| holdings | string¦null | false | none | Provides holdings of the director. |
| address | string¦null | false | none | Address of the director. |
| appointDate | string¦null | false | none | Appointed date of the director. |
DisqualifiedDirector
{
"caseReference": "string",
"company": "string",
"reason": "string",
"from": "string",
"to": "string"
}
Represents details of the disqualifications. This is applicable to UK only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseReference | string¦null | false | none | The unique Companies House identification number of the disqualification. |
| company | string¦null | false | none | The name of the company that the person was acting for. |
| reason | string¦null | false | none | The reason for the disqualification. |
| from | string¦null | false | none | Start date of the disqualification. |
| to | string¦null | false | none | End date of the disqualificaiton. |
Entity
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Details of the person to help determine whether an identified match is true and the likelihood of the member being a risk under your organisation's AML/CTF obligations.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | integer(int32) | false | none | Unique identifier of the person. |
| dataSource | string¦null | false | none | Specifies the data source of the profile. |
| category | string¦null | false | none | Category of the person. |
| categories | string¦null | false | none | Full descriptive categories of the person. |
| subcategory | string¦null | false | none | Subcategory of the person.Note: Decommissioned on 1 July 2020. |
| gender | string¦null | false | none | Gender of the person. |
| deceased | string¦null | false | none | Deceased status of the person, if applicable. |
| primaryFirstName | string¦null | false | none | Primary first name of the person. |
| primaryMiddleName | string¦null | false | none | Primary middle name of the person. |
| primaryLastName | string¦null | false | none | Primary last name of the person. |
| title | string¦null | false | none | Title of the person, if available. |
| position | string¦null | false | none | Position of the person, if available.Note: Decommissioned on 1 July 2020. |
| dateOfBirth | string¦null | false | none | Date of birth of the person. |
| deceasedDate | string¦null | false | none | Deceased date of the person, if applicable. |
| placeOfBirth | string¦null | false | none | Birth place of the person. Note: New in v9.3 |
| primaryLocation | string¦null | false | none | Person's primary location. |
| image | string¦null | false | none | URL link to the picture of the person, if available.Note: In release v9.3, this has been deprecated and will be decommissioned in the future. Please use 'images' instead. |
| images | [string]¦null | false | none | List of URL links to the pictures of the person, if available. Note: New in v9.3 |
| generalInfo | object¦null | false | none | Person's general information. |
| » additionalProperties | string¦null | false | none | none |
| furtherInformation | string¦null | false | none | Further information of the person. |
| xmlFurtherInformation | [any]¦null | false | none | XML object of further information of the person.Note: In release v9.3, values will not be returned (i.e. null). This has been deprecated and will be decommissioned in the future. |
| enterDate | string¦null | false | none | Date the profile was initially created in data source.Note: In release v9.3, values will not be returned (i.e. null). This has been deprecated and will be decommissioned in the future. |
| lastReviewed | string¦null | false | none | Last reviewed date of the record. Note: New in v9.3 |
| descriptions | [Description]¦null | false | none | Person's description list. |
| nameDetails | [NameDetail]¦null | false | none | Person's name detail list. |
| originalScriptNames | [string]¦null | false | none | List of original script names of the person.Note: In release v9.3, this has been deprecated and will be decommissioned in the future. Please use 'nameDetails' and check for 'nameType' instead. |
| roles | [Role]¦null | false | none | List of roles of the PEP profile. |
| importantDates | [Date]¦null | false | none | List of important dates for the person. |
| nationalities | [string]¦null | false | none | List of nationalities for the person. Note: New in v9.3 |
| nationalitiesCodes | [string]¦null | false | none | List of nationalities country codes for the person. Note: New in v9.4.2 |
| locations | [Location]¦null | false | none | List of locations for the person. |
| countries | [Country]¦null | false | none | List of countries where the person has been located.Note: Decommissioned on 1 July 2020. |
| officialLists | [OfficialList]¦null | false | none | List of official lists where the person is found. |
| idNumbers | [IDNumber]¦null | false | none | List of registration/ID number of the person.Note: Decommissioned on 1 July 2020. |
| identifiers | [Identifier]¦null | false | none | List of registration/ID number of the person. Note: New in v9.3 |
| disqualifiedDirectors | [DisqualifiedDirector]¦null | false | none | List of disqualifications for the person. Note: New in v9.3 |
| profileOfInterests | [ProfileOfInterest]¦null | false | none | List of Profile of Interest (POI) related details for the person. Note: New in v9.3 |
| sources | [Source]¦null | false | none | List of all public sources, including both government and media sources, used to build the full profile. |
| linkedIndividuals | [AssociatePerson]¦null | false | none | List of individuals associated with the person. |
| linkedCompanies | [AssociateCorp]¦null | false | none | List of companies associated with the person. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and nationalities. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and nationalities. |
EntityCorp
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Details of the company entity to help determine whether an identified match is true.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | integer(int32) | false | none | Unique identifier of the company. |
| dataSource | string¦null | false | none | Specifies the data source of the profile. |
| category | string¦null | false | none | Category of the company. |
| categories | string¦null | false | none | Full descriptive categories of the company. |
| subcategory | string¦null | false | none | Subcategory of the company.Note: Decommissioned on 1 July 2020. |
| primaryName | string¦null | false | none | Company primary name. |
| primaryLocation | string¦null | false | none | Company primary location. |
| images | [string]¦null | false | none | List of URL links to the pictures of the company, if available. Note: New in v9.3 |
| generalInfo | object¦null | false | none | Company general information. |
| » additionalProperties | string¦null | false | none | none |
| furtherInformation | string¦null | false | none | Additional information of the company. |
| xmlFurtherInformation | [any]¦null | false | none | XML object of additional information of the company.Note: In release v9.3, values will not be returned (i.e. null). This has been deprecated and will be decommissioned in the future. |
| enterDate | string¦null | false | none | Date the profile was initially created in data source.Note: In release v9.3, values will not be returned (i.e. null). This has been deprecated and will be decommissioned in the future. |
| lastReviewed | string¦null | false | none | Last reviewed date of the profile record. Note: New in v9.3 |
| descriptions | [Description]¦null | false | none | Company description list. |
| nameDetails | [CorpNameDetail]¦null | false | none | Detailed list of company name. |
| originalScriptNames | [string]¦null | false | none | List of original script names of the company entity.Note: In release v9.3, this has been deprecated and will be decommissioned in the future. Please use 'nameDetails' and check for 'nameType' instead. |
| locations | [Location]¦null | false | none | List of locations the company is associated with. |
| countries | [Country]¦null | false | none | List of countries the company is located in.Note: Decommissioned on 1 July 2020. |
| officialLists | [OfficialList]¦null | false | none | List of official lists the company is found in. |
| idNumbers | [IDNumber]¦null | false | none | List of registration/ID number of the company.Note: Decommissioned on 1 July 2020. |
| identifiers | [Identifier]¦null | false | none | List of registration/ID number of the company. Note: New in v9.3 |
| profileOfInterests | [ProfileOfInterest]¦null | false | none | List of Profile of Interest (POI) related details for the company. Note: New in v9.3 |
| sources | [Source]¦null | false | none | List of all public sources, including both government and media sources, used to build the full profile. |
| linkedIndividuals | [AssociatePerson]¦null | false | none | List of individuals associated with the company. |
| linkedCompanies | [AssociateCorp]¦null | false | none | List of companies associated with the company. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and locations. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and locations. |
FATFJurisdictionRiskInfo
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
List of the person's jurisdiction risk information based on country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| jurisdiction | string¦null | false | none | Represents risk country name. |
| effectivenessScore | number(double) | false | none | Indicates Effectiveness Score of risk. |
| effectivenessLevel | integer(int32) | false | none | Indicates Effectiveness Level of risk. |
| complianceScore | number(double) | false | none | Indicates Effectiveness Level of risk. |
| complianceLevel | integer(int32) | false | none | Indicates Compliance Level of risk. |
| comments | string¦null | false | none | Overall comments of risk. |
| fatfCompliance | string¦null | false | none | Represents the type of FATF Compliance risk. |
| fatfComplianceNotes | string¦null | false | none | Indicates FATF Compliance risk notes. |
| fatfEffectiveness | string¦null | false | none | Represents the type of FATF Effectiveness risk. |
| fatfEffectivenessNotes | string¦null | false | none | Indicates FATF Effectiveness risk notes. |
| fatfEffectivenessSubtitles | string¦null | false | none | Indicates FATF Effectiveness risk Subtitles. |
| countryCode | string¦null | false | none | Represents country code of risk. |
GroupActivityReportParam
{
"fundIDs": "string",
"from": "string",
"to": "string",
"format": "PDF"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | none | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| format | string | false | none | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Property | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
IDNumber
{
"type": "string",
"idNotes": "string",
"number": "string"
}
Identification or registration numbers from national and international authorities.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Type of ID/registration number. |
| idNotes | string¦null | false | none | Notes for the ID/registration number. |
| number | string¦null | false | none | Value of the ID/registration number. |
IDVCountry0
{
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | Supported country codes are AU, AT, BR, CA, CH, CN, DE, DK, ES, FI, FR, GB, IN, IT, MX, NL, NZ, NO, SE, US, ZA. |
IDVFaceMatchResultRa
{
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identityDocumentResult | string¦null | false | none | none |
| dataComparisonResult | string¦null | false | none | none |
| documentExpiryResult | string¦null | false | none | none |
| antiTamperResult | string¦null | false | none | none |
| photoLivelinessResult | string¦null | false | none | none |
| faceComparisonResult | string¦null | false | none | none |
| overallResult | string¦null | false | none | none |
| facematchMRZResult | string¦null | false | none | none |
| facematchPortraitAgeResult | string¦null | false | none | none |
| facematchPublicFigureResult | string¦null | false | none | none |
| facematchIDDocLivelinessResult | string¦null | false | none | none |
| facematchOCRData | IDVResultVerificationOCRDataRa¦null | false | none | none |
| firstNameOCRResult | boolean | false | none | none |
| lastNameOCRResult | boolean | false | none | none |
| birthDateOCRResult | boolean | false | none | none |
| idCountry | string¦null | false | none | none |
| idExpiry | string¦null | false | none | none |
| idFrontCompressed | string¦null | false | none | none |
| idBackCompressed | string¦null | false | none | none |
| livenessCompressed | string¦null | false | none | none |
| livenessProbability | string¦null | false | none | none |
| isLivenessVideo1Available | boolean | false | none | none |
| faceMatchCompletedAt | string(date-time)¦null | false | none | none |
IDVHistoryDetail
{
"idvParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"birthDate": "DD/MM/YYYY",
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"idvResult": {
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "string",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z"
},
"idvFaceMatchStatus": "Pass",
"signatureKey": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"idvStatus": "NotVerified"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| idvParam | IDVInputParam¦null | false | none | ID Verification scan parameters. |
| idvResult | IDVResultRa¦null | false | none | none |
| idvFaceMatchStatus | string¦null | false | none | none |
| signatureKey | string¦null | false | none | none |
| organisation | string¦null | false | none | none |
| user | string¦null | false | none | none |
| date | string(date-time) | false | none | none |
| idvStatus | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
IDVInputParam
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"birthDate": "DD/MM/YYYY",
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
}
ID Verification scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | Length: 0 - 255 | Person's first or given name - this field is mandatory (unless you are entering an Original Script Name). |
| middleName | string¦null | false | Length: 0 - 255 | Person's middle or second name - if available. |
| lastName | string¦null | false | Length: 0 - 255 | Person's surname or last name - this field is mandatory (unless you are entering an Original Script Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | Person's original script name - this can only be used where the country code is CN (China). This field is required unless you are entering a First and Last Name. |
| birthDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Person's birth date, if available, using the format DD/MM/YYYY. |
| mobileNumber | string¦null | false | none | Person's mobile number to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Person's email address to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| country | IDVCountry0¦null | false | none | Country of source for document and biometric facial matching to be verified against. Refer to IDVCountry0.code for details of supported country codes. |
| idvType | string | true | none | Type of verification for the person i.e. IDCheck for documentation verification, FaceMatch for biometric facial matching, or both. |
| idvSubType | string | false | none | Specify the execution or delivery method of the idvType i.e. email or SMS. If this is not defined, the default SMS option will be used. Ensure you enter the mobileNumber or emailAddress depending on the idvSubType. Please only select from the following values IDCheck_Sms, IDCheck_Email, IDCheck_FaceMatch_Sms, IDCheck_FaceMatch_Email, FaceMatch_Sms, FaceMatch_Email. |
| allowDuplicateIDVScan | boolean | false | none | Allow any detected duplicate scans with the same details such as name, date of birth and country of verification which was run within the last 24 hours to proceed. |
Enumerated Values
| Property | Value |
|---|---|
| idvType | IDCheck |
| idvType | IDCheck_FaceMatch |
| idvType | FaceMatch |
| idvSubType | IDCheck_Sms |
| idvSubType | IDCheck_Email |
| idvSubType | IDCheck_FaceMatch_Sms |
| idvSubType | IDCheck_FaceMatch_Email |
| idvSubType | FaceMatch_Sms |
| idvSubType | FaceMatch_Email |
IDVResultRa
{
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "string",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| signatureKey | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| fullName | string¦null | false | none | none |
| birthDate | string¦null | false | none | none |
| phone | string¦null | false | none | none |
| string¦null | false | none | none | |
| country | string¦null | false | none | none |
| unitNo | string¦null | false | none | none |
| addressLine1 | string¦null | false | none | none |
| addressLine2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postalCode | string¦null | false | none | none |
| latitude | string¦null | false | none | none |
| longitude | string¦null | false | none | none |
| nationalId | string¦null | false | none | none |
| nationalIdSecondary | string¦null | false | none | none |
| nationalIdType | string¦null | false | none | none |
| nationalIdSecondaryType | string¦null | false | none | none |
| verificationSourceResults | [IDVResultVerificationSourceRa]¦null | false | none | none |
| nameResult | string¦null | false | none | none |
| birthDateResult | string¦null | false | none | none |
| addressResult | string¦null | false | none | none |
| quickIdOverallResult | string¦null | false | none | none |
| overallResult | string¦null | false | none | none |
| faceMatchResult | IDVFaceMatchResultRa¦null | false | none | none |
| quickIDCompletedAt | string(date-time)¦null | false | none | none |
IDVResultVerificationOCRDataRa
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "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 |
| fullName | string¦null | false | none | none |
| expiryDate | string¦null | false | none | none |
| birthDate | string¦null | false | none | none |
| issueDate | string¦null | false | none | none |
| issuingAuthority | string¦null | false | none | none |
| unitNo | string¦null | false | none | none |
| addressLine1 | string¦null | false | none | none |
| addressLine2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postalCode | string¦null | false | none | none |
| countryName | string¦null | false | none | none |
| countryCode | string¦null | false | none | none |
| nationalId | string¦null | false | none | none |
| nationalIdSecondary | string¦null | false | none | none |
| nationalIdTertiary | string¦null | false | none | none |
| nationalIdCountryCode | string¦null | false | none | none |
| nationalIdType | string¦null | false | none | none |
| nationalIdSecondaryType | string¦null | false | none | none |
| nationalIdTertiaryType | string¦null | false | none | none |
IDVResultVerificationSourceRa
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string¦null | false | none | none |
| nameResult | string¦null | false | none | none |
| birthDateResult | string¦null | false | none | none |
| addressResult | string¦null | false | none | none |
IDVScanInputParam
{
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
}
ID Verification scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mobileNumber | string¦null | false | none | Person's mobile number to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Person's email address to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| country | IDVCountry0¦null | false | none | Country of source for document and biometric facial matching to be verified against. Refer to IDVCountry0.code for details of supported country codes. |
| idvType | string | true | none | Type of verification for the person i.e. IDCheck for documentation verification, FaceMatch for biometric facial matching, or both. |
| idvSubType | string | false | none | Specify the execution or delivery method of the idvType i.e. email or SMS. If this is not defined, the default SMS option will be used. Ensure you enter the mobileNumber or emailAddress depending on the idvSubType. Please only select from the following values IDCheck_Sms, IDCheck_Email, IDCheck_FaceMatch_Sms, IDCheck_FaceMatch_Email, FaceMatch_Sms, FaceMatch_Email. |
| allowDuplicateIDVScan | boolean | false | none | Allow any detected duplicate scans with the same details such as name, date of birth and country of verification which was run within the last 24 hours to proceed. |
Enumerated Values
| Property | Value |
|---|---|
| idvType | IDCheck |
| idvType | IDCheck_FaceMatch |
| idvType | FaceMatch |
| idvSubType | IDCheck_Sms |
| idvSubType | IDCheck_Email |
| idvSubType | IDCheck_FaceMatch_Sms |
| idvSubType | IDCheck_FaceMatch_Email |
| idvSubType | FaceMatch_Sms |
| idvSubType | FaceMatch_Email |
Identifier
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
Identification or registration numbers from national and international authorities.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Type of identity including registration number, registration date and status e.g. Business Registration Number, Business Registration Date, Business Registration Status, OFAC Unique ID, SIC Number, DUNS number, Corporate Identification Number, VAT/Tax Number etc. |
| country | string¦null | false | none | Country where identity was issued, if available. |
| value | string¦null | false | none | Value of the associated identity. |
| issuer | string¦null | false | none | The agency that issued the identity, if available. Note: New in v9.6 |
| issueDate | string¦null | false | none | The date that the identity was issued, if available. Note: New in v9.6 |
| expirationDate | string¦null | false | none | The date that the identity expires, if available. Note: New in v9.6 |
KYBActivity
{
"description": "string"
}
Represents the activity of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | none | Description of the activity. |
KYBAddresses
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
Represents the address of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | The country of the company address. |
| type | string¦null | false | none | Type of the company address. |
| addressInOneLine | string¦null | false | none | Full address of the company. |
| postCode | string¦null | false | none | PostCode of the company address. |
| cityTown | string¦null | false | none | Provides the city name. |
KYBCompanyInputParam
{
"countryCode": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"allowDuplicateKYBScan": true
}
KYB company search input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryCode | string | true | Length: 2 - 6 | The country code or subdivision code if the country has state registries. |
| companyName | string¦null | false | Length: 0 - 255 | The company name you want to search. |
| registrationNumber | string¦null | false | Length: 0 - 100 | The business registration number, if supported by the registry. If both companyName and registrationNumber are provided, the companyName will be used for searching. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the entity. This is not used in KYB scanning. |
| allowDuplicateKYBScan | boolean | false | none | Allow any detected duplicate scans with the same details such as country, company name or company registration number which was run within the last 24 hours to proceed. |
KYBCompanyProfileInputParam
{
"companyCode": "string"
}
KYB company enhanced profile input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | none | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBCompanyScanHistory
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "string",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
Details of company information and enahnced profile and list of documents.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| completedProductCount | integer(int32) | false | none | Provides count of the completed products of the company. |
| totalProductCount | integer(int32) | false | none | Provides count of all requested products of the company. |
| productResults | [KYBProductHistoryResult]¦null | false | none | List of the company products. |
| companyProfile | KYBEnhancedProfileResult¦null | false | none | Provides details of the company-enhanced profile including UBO, shareholder and directorship information. |
| companyCode | string¦null | false | none | A unique code for that entity that will be used for ordering a company profile or retrieving product documents. |
| companyNumber | string¦null | false | none | The registration number of the company. |
| date | string¦null | false | none | The date of the company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| legalStatusDescription | string¦null | false | none | Additional information on the legal status of the company. |
| address | string¦null | false | none | The address of the company. |
KYBCountryResult
{
"code": "string",
"name": "string",
"hasStates": true,
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true
}
KYB Country information elements.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The ISO 3166 2-letter country code. |
| name | string¦null | false | none | Name of the country. |
| hasStates | boolean | false | none | Indicates whether the country has registry subdivisions such as states or provinces. |
| supportsRegistrationNumber | boolean | false | none | Denotes whether the country registry supports searching by business registration number. |
| companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
KYBEnhancedProfileCreditChargeResult
{
"enhancedProfilePrice": 0,
"basicInformation": true,
"representatives": true,
"shareholders": true,
"uboDeclaration": true
}
Represents the credit charge result data of company enhanced profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enhancedProfilePrice | number(double) | false | none | Provides the price of the enhanced profile. |
| basicInformation | boolean | false | none | Indicates if basic information of the company is available. |
| representatives | boolean | false | none | Indicates if representatives of the company are available. |
| shareholders | boolean | false | none | Indicates if shareholders of the company are available. |
| uboDeclaration | boolean | false | none | Indicates if UBO declarations of the company are available. |
KYBEnhancedProfileResult
{
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "string",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
}
Represents the result data of the company enhanced profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| activity | [KYBActivity]¦null | false | none | List of activities of the company. |
| addresses | [KYBAddresses]¦null | false | none | List of addresses of the company. |
| directorShips | [DirectorShip]¦null | false | none | List of directorShips of the company. |
| code | string¦null | false | none | Code of the company. |
| date | string¦null | false | none | Date of the company. |
| foundationDate | string¦null | false | none | Foundation date of the company. |
| legalForm | string¦null | false | none | Provides legal form of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| name | string¦null | false | none | This provides full name of the company. |
| mailingAddress | string¦null | false | none | This provides mailing address of the company. |
| telephoneNumber | string¦null | false | none | Telephone number of the company. |
| faxNumber | string¦null | false | none | Fax number of the company. |
| string¦null | false | none | Email of the company. | |
| websiteURL | string¦null | false | none | Website URL of the company. |
| registrationNumber | string¦null | false | none | Registration number of company. |
| registrationAuthority | string¦null | false | none | Registration authority of the company. |
| legalFormDetails | string¦null | false | none | Provides legal form details of the company. |
| legalFormDeclaration | string¦null | false | none | Provides legal form declaration of the company. |
| registrationDate | string¦null | false | none | Registration date of the company. |
| vatNumber | string¦null | false | none | VAT number of the company. |
| agentName | string¦null | false | none | Provides the agent name of the company. |
| agentAddress | string¦null | false | none | Provides the address of the agent. |
| enhancedProfilePrice | number(double) | false | none | Provides the price of the company enhanced profile. |
| personsOfSignificantControl | [KYBPersonsOfSignificantControl]¦null | false | none | Lists the person having control over a company. |
KYBInputInfo
{
"country": "string",
"state": "string"
}
Details of the Know Your Business input fields.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | Provides name of the Country provided at the time of scan. |
| state | string¦null | false | none | Provides name of the State provided at the time of scan. |
KYBInputParam
{
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
KYB input scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryCode | string¦null | false | Length: 0 - 6 | The country code or subdivision code if the country has state registries. |
| registrationNumberSearch | boolean | false | none | The business registration number, if supported by the registry. If both companyName and registrationNumber are provided, the companyName will be used for searching. |
| allowDuplicateKYBScan | boolean | false | none | Allow any detected duplicate scans with the same details such as country, company name or company registration number which was run within the last 24 hours to proceed. |
KYBPersonsOfSignificantControl
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
Represents the details of the significant control persons/UBO of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| natureOfControl | [string]¦null | false | none | Provides details of ownership shares, voting rights and right to appoint the person. |
| name | string¦null | false | none | Provides name of the person. |
| nationality | string¦null | false | none | Provides the nationality of the person. |
| countryOfResidence | string¦null | false | none | The residence country of the person. |
| address | string¦null | false | none | The address of the person. |
| notifiedOn | string¦null | false | none | The notified date of the person. |
| birthDate | string¦null | false | read-only | The birth date of the person. |
KYBPricingParam
{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 0
}
KYB pricing parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | none | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| productStatus | string | false | none | Indicates document product order status. It may contains Requested, Pending, Completed, Failed and Cancelled statuses. |
| includeEnhancedProfile | string | false | none | Indicates enhanced profile includes or not. |
| pageIndex | integer(int32) | false | none | The page index of results. |
| pageSize | integer(int32) | false | none | The number of items or results per page or request. |
Enumerated Values
| Property | Value |
|---|---|
| productStatus | Requested |
| productStatus | Pending |
| productStatus | Completed |
| productStatus | Failed |
| productStatus | Cancelled |
| productStatus | All |
| includeEnhancedProfile | No |
| includeEnhancedProfile | Yes |
KYBPricingReportParam
{
"fundIDs": "string",
"from": "string",
"to": "string",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}
KYB pricing report parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | none | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| productStatus | string | false | none | Indicates document product order status. It may contains Requested, Pending, Completed, Failed and Cancelled statuses. |
| includeEnhancedProfile | string | false | none | Indicates enhanced profile includes or not. |
Enumerated Values
| Property | Value |
|---|---|
| productStatus | Requested |
| productStatus | Pending |
| productStatus | Completed |
| productStatus | Failed |
| productStatus | Cancelled |
| productStatus | All |
| includeEnhancedProfile | No |
| includeEnhancedProfile | Yes |
KYBPricingReportResult
{
"scanDate": "string",
"orgNameWithFundID": "string",
"countryCode": "string",
"companyName": "string",
"productTitle": "string",
"orderId": "string",
"creditCharge": 0,
"creditCostPrice": "string",
"price": "string",
"requestedDate": "string",
"downloadedDate": "string",
"status": "string",
"enhancedProfileRequested": true
}
Represents details of the KYB pricing report.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanDate | string¦null | false | none | Provides the scan date. |
| orgNameWithFundID | string¦null | false | none | Provides the organisation name and org id. |
| countryCode | string¦null | false | none | Provides the code of the country. |
| companyName | string¦null | false | none | Provides the full name of the company. |
| productTitle | string¦null | false | none | The title of the document product. |
| orderId | string¦null | false | none | The order reference of the document product. |
| creditCharge | number(double) | false | none | Provides the credit charge of the document or enhanced profile. |
| creditCostPrice | string¦null | false | none | Provides the credit cost price of the document or enhanced profile. |
| price | string¦null | false | none | Provides the price of the document or enhanced profile. |
| requestedDate | string¦null | false | none | Provides the requested date of the document or enhanced profile. |
| downloadedDate | string¦null | false | none | Provides the downloaded date of the document or enhanced profile. |
| status | string¦null | false | none | Provides the status of the document product. |
| enhancedProfileRequested | boolean | false | none | Identifies enhanced profile is requested or not. |
KYBProductHistoryResult
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
Represents details of product information.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productId | integer(int32) | false | none | The identifier of a specific product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
| companyNumber | string¦null | false | none | Provides the registration number of company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| creationDate | string(date-time) | false | none | Identifies the creation date of the product. |
| status | string | false | none | Identifies the status of the product. |
| completionDate | string(date-time)¦null | false | none | The completion date of the product. |
| productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| currency | string¦null | false | none | The currency of the document product. |
| productFormat | string¦null | false | none | The format of the document product. |
| productTitle | string¦null | false | none | The title of the document product. |
| deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| productInfo | string¦null | false | none | Provides the document product information. |
| price | number(double) | false | none | The price of the document product. |
| isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
KYBProductInputParam
{
"companyCode": "string"
}
KYB product search input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | Length: 0 - 1024 | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBProductOrderInputParam
{
"companyCode": "string",
"productEntityId": "string"
}
Specify document products for purchase.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | Length: 0 - 1024 | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
| productEntityId | string | true | Length: 0 - 1024 | The unique product key used to order a document product. The POST /kyb/{scanId}/products API method response class returns this identifier in productResults.productEntityId. |
KYBProductOrderResult
{
"companyId": 0,
"productId": 0,
"message": "string",
"status": "Requested"
}
Results of the document product order.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| productId | integer(int32) | false | none | The identifier of the specific document product. The kyb/{scanId}/products/order API method response class returns this identifier in productid. |
| message | string¦null | false | none | Acknowledgement of the document order. This may indicate successful receipt of the request or cancellation or failure in the order due to registry and document availability. |
| status | string | false | none | Indicates document product order status. It contains Requested, Pending, Completed, Failed and Cancelled statuses. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
KYBProductResult
{
"productResults": [
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyCode": "string"
}
Lists the document products available for the company profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productResults | [ProductResult]¦null | false | none | Lists the document products available for the company profile. |
| companyCode | string¦null | false | none | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"idNumber": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
},
"companyResults": [
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "string",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
],
"documentResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"kybParam": {
"country": "string",
"state": "string"
}
}
Details of the scan settings applied and a list of companies where documents or UBO enhanced-profiles were purchased.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | CorpScanInputParamHistory¦null | false | none | Scan parameters and company information used to scan. |
| companyResults | [KYBCompanyScanHistory]¦null | false | none | List of company results. |
| documentResults | [KYBProductHistoryResult]¦null | false | none | List of product results. |
| kybParam | KYBInputInfo¦null | false | none | Scan parameters and company information used to scan. |
KYBScanResult
{
"metadata": {
"message": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
}
Lists of company profiles found for the company search.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The metadata about result. |
| scanId | integer(int32) | false | none | The identifier of the scan. It should be used when requesting the GET /kyb/{scanId} API methods to get details of this company scan. |
| enhancedProfilePrice | number(double) | false | none | Cost of the Enhanced Profile information for the company. Prices are in USD. |
| companyResults | [CompanyResult]¦null | false | none | List of company details. |
KYBStateResult
{
"code": "string",
"name": "string",
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true
}
Lists the KYB state results.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The code for the registry subdivision. This is a combination of the ISO 3166 country and state codes. |
| name | string¦null | false | none | Name of the subdivision (state or province). |
| supportsRegistrationNumber | boolean | false | none | Denotes whether the subdivision registry supports searching by business Registration Number. |
| companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
Location
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
Represents Country, Region (State/Province), City, and address where information is available.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | Location country. |
| countryCode | string¦null | false | none | The ISO 3166-2 country code (alpha-2 code) of the location. Note: New in v9.3 |
| city | string¦null | false | none | Location city. |
| address | string¦null | false | none | Location address. |
| type | string¦null | false | none | Location type. Note: New in v9.3 |
MailConfig
{
"fromEmail": "string",
"supportEmail": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fromEmail | string¦null | false | none | none |
| supportEmail | string¦null | false | none | none |
Metadata
{
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string¦null | false | none | A message that describe result of operation. |
MonitoringItems
{
"clientIds": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| clientIds | [string] | true | none | none |
MonitoringListCorpItem
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"entityNumber": "string",
"clientId": "string",
"companyName": "string",
"address": "string",
"idNumber": "string",
"registrationNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier for the company assigned by the system within the monitoring list. |
| monitor | boolean | false | none | Status of monitoring for the company i.e. actively monitored (true) or disabled from monitoring (false). |
| addedBy | string¦null | false | none | User who added the company to the monitoring list during a scan. |
| dateAdded | string(date-time) | false | none | Date the company was first added to the monitoring list. |
| entityNumber | string¦null | false | none | The unique Entity Number for the company entered during scans. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The unique Client ID for the company entered during scans. |
| companyName | string¦null | false | none | The name scanned for the company. |
| address | string¦null | false | none | The address scanned for the company. |
| idNumber | string¦null | false | none | The ID Number scanned for the company. This property has been superseded and will be deprecated in the future. Please use registrationNumber instead. |
| registrationNumber | string¦null | false | none | The Registration Number scanned for the company. |
MonitoringListMemberItem
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"gender": "string",
"idNumber": "string",
"address": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier for the member assigned by the system within the monitoring list. |
| monitor | boolean | false | none | Status of monitoring for the member i.e. actively monitored (true) or disabled from monitoring (false). |
| addedBy | string¦null | false | none | User who added the member to the monitoring list during a scan. |
| dateAdded | string(date-time) | false | none | Date the member was first added to the monitoring list. |
| memberNumber | string¦null | false | none | The unique Member Number entered for the member during scans. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The unique Client ID entered for the member during scans. |
| firstName | string¦null | false | none | The first name scanned for the member. |
| middleName | string¦null | false | none | The middle name scanned for the member. |
| lastName | string¦null | false | none | The last name scanned for the member. |
| scriptNameFullName | string¦null | false | none | The original script / full name scanned for the member. |
| dob | string¦null | false | none | The date of birth scanned for the member. |
| gender | string¦null | false | none | The gender scanned for the member. |
| idNumber | string¦null | false | none | The ID Number scanned for the member. |
| address | string¦null | false | none | The address scanned for the member. |
MonitoringScanHistoryLog
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalMembersMonitored": 0,
"membersChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0
}
Represents details of the automated member monitoring scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string | false | none | Monitoring Scan or Rescan. |
| totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| membersChecked | integer(int32) | false | none | Number of members in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the member. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the member which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the member. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Reviewed status for a monitoring scan. |
| membersReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
MonitoringScanResults
{
"organisation": "string",
"user": "string",
"scanType": "Single",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"totalMembersMonitored": 0,
"membersChecked": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0
}
Represents member batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the scan. |
| user | string¦null | false | none | The User performing the scan. |
| scanType | string | false | none | Monitoring Scan or Rescan. |
| matchType | string | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string | false | none | Whitelist policy scanned. |
| residence | string | false | none | Address policy scanned. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| blankAddress | string | false | none | Blank address policy scanned. |
| pepJurisdiction | string | false | none | PEP jurisdiction scanned. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| excludeDeceasedPersons | string | false | none | Exclude deceased persons policy used for scan. |
| categoryResults | [CategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| entities | [ScanHistoryLog0]¦null | false | none | List of matched entities. |
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| membersChecked | integer(int32) | false | none | Number of members in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.Note: This has been deprecated and will be decommissioned in the future. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the member. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the member which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the member. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Reviewed status for a monitoring scan. |
| membersReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
MyProfile
{
"passwordExpiryDays": 0,
"agreementRequiredOrganisations": [
"string"
],
"acceptedAgreementFileName": "string",
"appLogo": "string",
"appLogoMini": "string",
"userRoles": [
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
],
"userStatuses": [
"Inactive"
],
"rights": [
"string"
],
"notifications": [
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
],
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| passwordExpiryDays | integer(int32)¦null | false | none | none |
| agreementRequiredOrganisations | [string]¦null | false | none | none |
| acceptedAgreementFileName | string¦null | false | none | none |
| appLogo | string¦null | false | none | none |
| appLogoMini | string¦null | false | none | none |
| userRoles | [UserRole]¦null | false | none | none |
| userStatuses | [string]¦null | false | none | none |
| rights | [string]¦null | false | none | none |
| notifications | [UserNotification]¦null | false | none | none |
| apiKey | string¦null | false | none | none |
| address | string¦null | false | none | none |
| postalAddress | string¦null | false | none | none |
| phoneNumber | string¦null | false | none | none |
| faxNumber | string¦null | false | none | none |
| failedLoginDate | string(date-time)¦null | false | none | none |
| mfaType | string | false | none | none |
| accessRights | [UserAccessRight]¦null | false | none | none |
| assignedOrganisations | [UserOrganisation]¦null | false | none | none |
| isSSOEnabled | boolean | false | none | none |
| userSsoSettings | [UserSsoSettings]¦null | false | none | none |
| id | integer(int32) | false | none | none |
| username | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| role | UserRole¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| status | string | false | none | none |
| creationDate | string(date-time)¦null | false | none | none |
| lastLoginDate | string(date-time)¦null | false | none | none |
| lastActiveDate | string(date-time)¦null | false | none | none |
| dateTimeZone | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
MyProfileMfaSetupCode
{
"tokenExpiry": 0,
"manualEntryKey": "string",
"qrCodeSetupImageUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokenExpiry | integer(int32) | false | none | none |
| manualEntryKey | string¦null | false | none | none |
| qrCodeSetupImageUrl | string¦null | false | none | none |
MyProfileSecurity
{
"currentPassword": "string",
"newPassword": "string",
"mfaType": "Disabled",
"mfaVerificationCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentPassword | string¦null | false | none | none |
| newPassword | string¦null | false | Length: 0 - 100 Pattern: ^(?=.&#... |
none |
| mfaType | string¦null | false | none | none |
| mfaVerificationCode | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
NameDetail
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
Represents details of the person's name including original script name, spelling variations and aliases.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | Type of name e.g. Original Script Name, Name Spelling Variation, Nickname etc. |
| firstName | string¦null | false | none | First name of the person. |
| middleName | string¦null | false | none | Middle name of the person. |
| lastName | string¦null | false | none | Last name of the person. |
| title | string¦null | false | none | Title of the person, if available.Note: In release v9.3, this property will not be returned. This has been deprecated and will be decommissioned in the future. |
OfficialList
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
Information of the official list entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| keyword | string¦null | false | none | Name of the official list. |
| category | string¦null | false | none | Watchlist category of the official list. Note: New in v9.3 |
| description | string¦null | false | none | Name of the official list. |
| country | string¦null | false | none | Country of the official list.Note: Decommissioned on 1 July 2020. |
| origin | string¦null | false | none | The country or region of the official list. Note: New in v9.3 |
| measures | string¦null | false | none | List of measures enforced by the official sanctioning body, if available. Note: New in v9.3 |
| types | string¦null | false | none | Types of sanction classified by the official list, if available. Examples include: Counter Narcotics, Human Rights, Non-Proliferation, Territorial Violation, Terrorism.Note: New in v9.3 |
| isCurrent | boolean | false | none | Indicates if the Official List is still current (true) or outdated (false). |
OrgAgreementSetting
{
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayAgreement | boolean | false | none | none |
| acceptedBy | string¦null | false | none | none |
| acceptedOn | string¦null | false | none | none |
| fileName | string¦null | false | none | none |
OrgCorporateAutoScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string | false | none | none |
| addressPolicy | string | false | none | none |
| blankAddressPolicy | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddressPolicy | ApplyDefaultCountry |
| blankAddressPolicy | Ignore |
OrgCorporateScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| stopwords | string¦null | false | Length: 0 - 1000 | none |
| whitelistPolicy | string¦null | false | none | none |
| addressPolicy | string¦null | false | none | none |
| defaultCountry | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
| maxExactScanResult | integer(int32) | false | none | none |
| maxCloseScanResult | integer(int32) | false | none | none |
| watchlists | [string]¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddressPolicy | ApplyDefaultCountry |
| blankAddressPolicy | Ignore |
OrgCountry
{
"timeZoneId": "string",
"name": "string",
"code": "strin"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| timeZoneId | string¦null | false | none | none |
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
OrgCountry0
{
"name": "string",
"code": "strin"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
OrgCustomList
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| description | string¦null | false | none | none |
| dataType | string | false | none | none |
| updateType | string | false | none | none |
| status | string¦null | false | none | none |
| selected | boolean | false | none | none |
| inherited | boolean | false | none | none |
| lastUpdate | string(date-time)¦null | false | none | none |
| files | [OrgCustomListFile]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dataType | Individual |
| dataType | Corporate |
| updateType | Full |
| updateType | Incremental |
OrgCustomListFile
{
"id": "string",
"name": "string",
"type": "Individual"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| name | string¦null | false | none | none |
| type | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | Individual |
| type | Corporate |
OrgDetails
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"scanEmailsSendToCO": true,
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "string",
"renewalDate": "string",
"terminationDate": "string"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"isIgnoreBlankDobActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
]
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankDobActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin"
}
],
"defaultCountry": {
"name": "string",
"code": "strin"
}
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "string",
"creationDate": "2019-08-24T14:15:22Z",
"isIdvActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address | string¦null | false | none | none |
| phoneNumber | string¦null | false | none | none |
| faxNumber | string¦null | false | none | none |
| scanEmailsSendToCO | boolean¦null | false | none | none |
| logoImage | string¦null | false | none | Image data as a Base64 string. |
| appLogoImage | string¦null | false | none | App image data as a Base64 string. |
| appLogoMiniImage | string¦null | false | none | App mini image data as a Base64 string. |
| isBatchValidationActive | boolean¦null | false | none | none |
| subscriptionSettings | OrgSubscriptionSetting¦null | false | none | none |
| agreementSettings | OrgAgreementSetting¦null | false | none | none |
| memberScanSettings | OrgMemberScanSetting¦null | false | none | none |
| corporateScanSettings | OrgCorporateScanSetting¦null | false | none | none |
| monitoringSettings | OrgMonitoringSetting¦null | false | none | none |
| idvSettings | OrgIDVSetting¦null | false | none | none |
| assignedUsers | [OrgUser]¦null | false | none | none |
| allowListAccesses | [integer]¦null | false | none | Watchlists access assigned to organisation. Refer to /api/v2/organisations/allListAccesses for access list data. |
| customLists | [OrgCustomList]¦null | false | none | none |
| riskLevels | [OrgRiskLevel]¦null | false | none | none |
| name | string¦null | false | none | none |
| displayName | string¦null | false | none | none |
| parentOrg | OrgInfo0¦null | false | none | none |
| country | OrgCountry¦null | false | none | none |
| complianceOfficers | [OrgUser]¦null | false | none | none |
| accountManager | OrgUser¦null | false | none | none |
| string¦null | false | none | none | |
| creationDate | string(date-time)¦null | false | none | none |
| isIdvActive | boolean¦null | false | none | none |
| isMonitoringActive | boolean¦null | false | none | none |
| isApiActive | boolean¦null | false | none | none |
| status | string | false | none | none |
| isAIAnalysisActive | boolean¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
OrgIDVCountry
{
"selected": true,
"name": "string",
"code": "strin"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| selected | boolean¦null | false | none | none |
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
OrgIDVSetting
{
"countries": [
{
"selected": true,
"name": "string",
"code": "strin"
}
],
"defaultCountry": {
"name": "string",
"code": "strin"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countries | [OrgIDVCountry]¦null | false | none | none |
| defaultCountry | OrgCountry0¦null | false | none | none |
OrgInfo
{
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "string",
"creationDate": "2019-08-24T14:15:22Z",
"isIdvActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| displayName | string¦null | false | none | none |
| parentOrg | OrgInfo0¦null | false | none | none |
| country | OrgCountry¦null | false | none | none |
| complianceOfficers | [OrgUser]¦null | false | none | none |
| accountManager | OrgUser¦null | false | none | none |
| string¦null | false | none | none | |
| creationDate | string(date-time)¦null | false | none | none |
| isIdvActive | boolean¦null | false | none | none |
| isMonitoringActive | boolean¦null | false | none | none |
| isApiActive | boolean¦null | false | none | none |
| status | string | false | none | none |
| isAIAnalysisActive | boolean¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
OrgInfo0
{
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
OrgListAccess
{
"id": 0,
"name": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| subLists | [OrgSubList]¦null | false | none | none |
OrgMemberAutoScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankDobActive": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string | false | none | none |
| residencePolicy | string | false | none | none |
| blankAddressPolicy | string | false | none | none |
| pepJurisdictionPolicy | string | false | none | none |
| excludeDeceasedPersons | string | false | none | none |
| isIgnoreBlankDobActive | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| residencePolicy | Ignore |
| residencePolicy | ApplyPEP |
| residencePolicy | ApplySIP |
| residencePolicy | ApplyRCA |
| residencePolicy | ApplyPOI |
| residencePolicy | ApplyAll |
| blankAddressPolicy | ApplyResidenceCountry |
| blankAddressPolicy | Ignore |
| pepJurisdictionPolicy | Apply |
| pepJurisdictionPolicy | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
OrgMemberScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"isIgnoreBlankDobActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string¦null | false | none | none |
| residencePolicy | string¦null | false | none | none |
| defaultCountryOfResidence | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
| pepJurisdictionPolicy | string¦null | false | none | none |
| pepJurisdictionCountries | string¦null | false | none | none |
| isPepJurisdictionExclude | boolean¦null | false | none | none |
| excludeDeceasedPersons | string¦null | false | none | none |
| isScriptNameFullNameSearchActive | boolean | false | none | none |
| isIgnoreBlankDobActive | boolean | false | none | none |
| dobTolerance | integer(int32)¦null | false | none | none |
| maxExactScanResult | integer(int32) | false | none | none |
| maxCloseScanResult | integer(int32) | false | none | none |
| watchlists | [string]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| residencePolicy | Ignore |
| residencePolicy | ApplyPEP |
| residencePolicy | ApplySIP |
| residencePolicy | ApplyRCA |
| residencePolicy | ApplyPOI |
| residencePolicy | ApplyAll |
| blankAddressPolicy | ApplyResidenceCountry |
| blankAddressPolicy | Ignore |
| pepJurisdictionPolicy | Apply |
| pepJurisdictionPolicy | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
OrgMonitoringSetting
{
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankDobActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isEmailNotificationActive | boolean¦null | false | none | none |
| isCallbackUrlNotificationActive | boolean¦null | false | none | none |
| notificationCallbackUrl | string¦null | false | none | none |
| isClearOnRenewalActive | boolean¦null | false | none | none |
| updateMemberMonitoringListPolicy | string | false | none | none |
| updateCorporateMonitoringListPolicy | string | false | none | none |
| interval | string¦null | false | none | none |
| lastMemberMonitoredDate | string(date-time)¦null | false | none | none |
| lastCorporateMonitoredDate | string(date-time)¦null | false | none | none |
| monitoringReviewEnabled | boolean¦null | false | none | none |
| memberScanSettings | OrgMemberAutoScanSetting¦null | false | none | none |
| corporateScanSettings | OrgCorporateAutoScanSetting¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| updateMemberMonitoringListPolicy | UserDefined_No |
| updateMemberMonitoringListPolicy | UserDefined_Yes |
| updateMemberMonitoringListPolicy | No |
| updateMemberMonitoringListPolicy | Yes |
| updateCorporateMonitoringListPolicy | UserDefined_No |
| updateCorporateMonitoringListPolicy | UserDefined_Yes |
| updateCorporateMonitoringListPolicy | No |
| updateCorporateMonitoringListPolicy | Yes |
| interval | Daily |
| interval | Weekly |
| interval | Fortnightly |
| interval | Monthly |
| interval | Quarterly |
| interval | SemiAnnual |
OrgRiskLevel
{
"categoryId": 0,
"risk": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryId | integer(int32) | false | none | none |
| risk | integer(int32) | false | none | none |
OrgSubList
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": []
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| description | string¦null | false | none | none |
| subLists | [OrgSubList]¦null | false | none | none |
OrgSubscriptionSetting
{
"startDate": "string",
"renewalDate": "string",
"terminationDate": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
| renewalDate | string¦null | false | none | none |
| terminationDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
OrgTimeZone
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| name | string¦null | false | none | none |
OrgUser
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| username | string¦null | false | none | none |
| role | UserRole¦null | false | none | none |
| status | string¦null | false | none | none |
| singleOrgAssigned | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
ProductResult
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
Represents the result data of the product.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| currency | string¦null | false | none | The currency of the document product. |
| productFormat | string¦null | false | none | The format of the document product. |
| productTitle | string¦null | false | none | The title of the document product. |
| deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| productInfo | string¦null | false | none | Provides the document product information. |
| price | number(double) | false | none | The price of the document product. |
| isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
ProfileOfInterest
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
Represents details of the Profile of Interest (POI).
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | The category of the POI. |
| positions | [ProfileOfInterestPosition]¦null | false | none | The positions held by the POI, if available. |
ProfileOfInterestPosition
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
Represents the position details of the Profile of Interest (POI).
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| position | string¦null | false | none | The job or role of the POI. |
| segment | string¦null | false | none | The category of in scope positions of the POI. |
| country | string¦null | false | none | Country of the term of office for the particular position. |
| from | string¦null | false | none | The Start date of the term of office for the particular position. |
| to | string¦null | false | none | The End date of the term of office in the particular position. |
ReCaptchaConfig
{
"globalUrl": "string",
"publicKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| globalUrl | string¦null | false | none | none |
| publicKey | string¦null | false | none | none |
RiskResult
{
"categoryRisks": [
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
],
"overAllRisk": "Unallocated"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryRisks | [CategoryRisk]¦null | false | none | none |
| overAllRisk | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| overAllRisk | Unallocated |
| overAllRisk | Low |
| overAllRisk | Med |
| overAllRisk | High |
Role
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
Represents the details of the PEP roles.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | Represents the Job/Role of the PEP in the particular PEP Position. |
| segment | string¦null | false | none | The category of in scope positions of the PEP for a particular country. Note: New in v9.3 |
| type | string¦null | false | none | Represents the standard PEP Position held by the PEP.Note: Decommissioned on 1 July 2020. |
| status | string¦null | false | none | Represent whether the particular role is Current or Former. There can be more than one Current and Former roles held by the PEP.Note: New in v9.3 |
| country | string¦null | false | none | Country of the term of office for the particular role. |
| from | string¦null | false | none | The Start date of the term of office for the particular role. |
| to | string¦null | false | none | The End date of the term of office in the particular role. |
SanctionedCountryResult
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
Details of the Sanctioned country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isPrimaryLocation | boolean¦null | false | none | Indicates whether the sanctioned country is primary location of the entity. |
| countryCode | string¦null | false | none | Indicates 2-letter country code. |
| comment | string¦null | false | none | Description of sanctioned country. |
| url | string¦null | false | none | The reference link for sanctioned country. |
| isBlackList | boolean | false | none | Identifies whether the country is in BlackList or not. |
| isGreyList | boolean | false | none | Identifies whether the country is in GreyList or not. |
ScanEntity
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Represents the results data of the member scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resultId | integer(int32) | true | none | The identifier of each matched entity. It should be used when requesting the GET /member-scans/single/results/{id} API method to get the entity profile information. |
| uniqueId | integer(int32) | false | none | The unique identifier of matched entity. |
| resultEntity | Entity¦null | false | none | Represents detail profile of matched entiry. |
| monitoredOldEntity | Entity¦null | false | none | Represents old detail profile of monitored entity. This only available if monitoringStatus is UpdatedMatches. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| matchedFields | string¦null | false | none | Indicates matched fields. Contains combination of AKA, PrimaryName, FullPrimaryName, ScriptName, Gender, DOB, YOB and Country values. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string | true | none | The first name of the matched entity. |
| middleName | string | true | none | The middle name of the matched entity. |
| lastName | string | true | none | The last name of the matched entity. |
| matchRate | integer(int32)¦null | false | none | For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close). |
| dob | string¦null | false | none | The date of birth of the matched entity. |
| primaryLocation | string¦null | false | none | The primary location of the matched entity. |
| decisionDetail | DecisionDetail¦null | false | none | List of due diligence decision, match decision and assessed risk of a member or corporate entity. (If clientId was not included in the scan, decision will not available). |
| aiAnalysisQuestionCount | integer(int32)¦null | false | none | Number of AIAnalysis questions asked for matched entity. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and nationalities. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and nationalities. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
ScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"watchLists": [
"string"
],
"watchlistsNote": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
},
"scanResult": {
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"dataBreachCheckResults": [
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
],
"fatfJurisdictionRiskResults": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Represents details of the scan parameters and member information scanned, and list of Found Entities identified from the Watchlists as possible matches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | ScanInputParamHistory¦null | false | none | Scan parameters and member information that were scanned. |
| scanResult | ScanResult¦null | false | none | Lists of Found Entities identified from the Watchlists as possible matches. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
ScanHistoryLog
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"scanService": "PepAndSanction",
"idvStatus": "NotVerified",
"idvFaceMatchStatus": "Pass",
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
Represents member scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | true | none | Date of scan. |
| scanType | string¦null | false | none | Scan type. |
| matchType | string¦null | false | none | Match type scanned. |
| whitelist | string¦null | false | none | Whitelist policy used for scan. |
| residence | string¦null | false | none | Address policy used for scan. |
| blankAddress | string¦null | false | none | Blank address policy used for scan. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction used for scan. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| scanService | string | false | none | none |
| idvStatus | string¦null | false | none | ID Check result status of ID Verification scans. Only applicable for IDVerification scanService. |
| idvFaceMatchStatus | string¦null | false | none | FaceMatch result status of ID Verification scans. Only applicable for IDVerification scanService. |
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string¦null | false | none | The member first name scanned. |
| middleName | string¦null | false | none | The member middle name scanned (if available). |
| lastName | string¦null | false | none | The member last name scanned. |
| scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| dob | string¦null | false | none | The member date of birth scanned. |
| idNumber | string¦null | false | none | The member ID number scanned. |
| memberNumber | string¦null | false | none | The member number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The client id scanned. |
| monitor | boolean¦null | false | none | Indicates if the member is being actively monitored. This property is returned for request pageSize of 100 and less. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| scanService | PepAndSanction |
| scanService | IDVerification |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
ScanHistoryLog0
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"idNumber": "string",
"memberNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true
}
Represents the scan history data scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string¦null | false | none | The member first name scanned. |
| middleName | string¦null | false | none | The member middle name scanned (if available). |
| lastName | string¦null | false | none | The member last name scanned. |
| scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| dob | string¦null | false | none | The member date of birth scanned. |
| idNumber | string¦null | false | none | The member ID number scanned. |
| memberNumber | string¦null | false | none | The member number scanned. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | none | The client id scanned. |
| monitor | boolean¦null | false | none | Indicates if the member is being actively monitored. This property is returned for request pageSize of 100 and less. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| monitoringReviewStatus | boolean¦null | false | none | Indicates monitoring review status (if available). |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
ScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
}
Scan parameters, which include match type and policy options, to be applied to each scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. This is optional if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| memberNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. |
| firstName | string¦null | false | Length: 0 - 255 | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). To specify a mononym (single name), enter a dash (-) in this parameter and the mononym in lastName. |
| middleName | string¦null | false | Length: 0 - 255 | Member's Middle Name - if available. |
| lastName | string¦null | false | Length: 0 - 255 | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This parameter has multiple uses and supports either the individual's full name in original script text (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. This field is mandatory, unless you are entering a First and Last Name. |
| gender | string¦null | false | Length: 0 - 15 | Member's gender - if available. Male, Female and blank are acceptable values. |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Member's Date of Birth - if available, using the format DD/MM/YYYY or YYYY. Matching is performed on date of birth, for exact matches, if it is entered. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| idNumber | string¦null | false | Length: 0 - 100 | Member identifier - such as National ID, Passport Number, Professional Registration ID, VAT/Tax Number, Insolvency ID or equivalent. If you enter an ID Number, it will be used in the matching process and matches will only be returned if the ID Number is 'contained' in the watchlist record. Profiles that do not have any registered identifiers will not be returned as a match. This should be used with care and is useful for filtering potentially large number of results when screening popular and commonly used names. |
| address | string¦null | false | Length: 0 - 255 | Member's Address - there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the member to the Monitoring List if clientId/memberNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing member with the same clientId/memberNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| dataBreachCheckParam | DataBreachCheckInputParam¦null | false | none | Data Breach Check parameter - includes Email Address. |
| idvParam | IDVScanInputParam¦null | false | none | Member's ID Verification parameters - if required, which includes mobile number and the country which member is verified for. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
ScanInputParamHistory
{
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"watchLists": [
"string"
],
"watchlistsNote": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"memberNumber": "string",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"gender": "string",
"dob": "DD/MM/YYYY",
"dobTolerance": 0,
"idNumber": "string",
"address": "string",
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true
},
"includeJurisdictionRisk": "No"
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanType | string | false | none | Type of scan. |
| scanService | string | false | none | Type of scan service. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | Date of scan. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| watchLists | [string]¦null | false | none | Scan against selected watchlists. This selection can be changed by the Compliance Officer in Administration > Organisations > List Access tab. |
| watchlistsNote | string¦null | false | none | none |
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. This is optional if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| memberNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. |
| firstName | string¦null | false | Length: 0 - 255 | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). To specify a mononym (single name), enter a dash (-) in this parameter and the mononym in lastName. |
| middleName | string¦null | false | Length: 0 - 255 | Member's Middle Name - if available. |
| lastName | string¦null | false | Length: 0 - 255 | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This parameter has multiple uses and supports either the individual's full name in original script text (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. This field is mandatory, unless you are entering a First and Last Name. |
| gender | string¦null | false | Length: 0 - 15 | Member's gender - if available. Male, Female and blank are acceptable values. |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Member's Date of Birth - if available, using the format DD/MM/YYYY or YYYY. Matching is performed on date of birth, for exact matches, if it is entered. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| idNumber | string¦null | false | Length: 0 - 100 | Member identifier - such as National ID, Passport Number, Professional Registration ID, VAT/Tax Number, Insolvency ID or equivalent. If you enter an ID Number, it will be used in the matching process and matches will only be returned if the ID Number is 'contained' in the watchlist record. Profiles that do not have any registered identifiers will not be returned as a match. This should be used with care and is useful for filtering potentially large number of results when screening popular and commonly used names. |
| address | string¦null | false | Length: 0 - 255 | Member's Address - there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the member to the Monitoring List if clientId/memberNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing member with the same clientId/memberNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| dataBreachCheckParam | DataBreachCheckInputParam¦null | false | none | Data Breach Check parameter - includes Email Address. |
| idvParam | IDVScanInputParam¦null | false | none | Member's ID Verification parameters - if required, which includes mobile number and the country which member is verified for. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | IDVerification |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
ScanResult
{
"metadata": {
"message": "string"
},
"scanId": 0,
"resultUrl": "string",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoredOldEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
],
"webSearchResults": [
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
],
"dataBreachCheckResults": [
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
],
"fatfJurisdictionRiskResults": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
}
Lists the scan match results for the member's details.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The matada about result. |
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| resultUrl | string | true | none | This URL provides a link to view the scan information and details of the matched companies. Valid credentials are required as well as authorisation to view the scan results. |
| matchedNumber | integer(int32) | true | none | Number of matched entities found. 0 means no matches found. |
| matchedEntities | [ScanEntity] | true | none | List of matched entities. |
| webSearchResults | [WebSearchResult]¦null | false | none | List of adverse media results on the web using Google search engine. |
| dataBreachCheckResults | [DataBreachCheckResult]¦null | false | none | List of email breaches found. |
| fatfJurisdictionRiskResults | [FATFJurisdictionRiskInfo]¦null | false | none | List of jurisdiction risk results. |
| monitoringReviewStatus | boolean¦null | false | none | Monitoring Review Status. |
| monitoringReviewSummary | string¦null | false | none | Monitoring Review Summary message. |
SingleScanCorpResultDetail
{
"id": 0,
"entity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "string"
}
],
"originalScriptNames": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
],
"profileOfInterests": [
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Represents details of a single corporate scan result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier of the single corporate scan result. |
| entity | EntityCorp¦null | false | none | The details of the identified matching company. |
SingleScanResultDetail
{
"id": 0,
"person": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"title": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"image": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"xmlFurtherInformation": [
null
],
"enterDate": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"title": "string"
}
],
"originalScriptNames": [
"string"
],
"roles": [
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
],
"importantDates": [
{
"dateType": "string",
"dateValue": "string"
}
],
"nationalities": [
"string"
],
"nationalitiesCodes": [
"string"
],
"locations": [
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
],
"countries": [
{
"countryType": "string",
"countryValue": "string"
}
],
"officialLists": [
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
],
"idNumbers": [
{
"type": "string",
"idNotes": "string",
"number": "string"
}
],
"identifiers": [
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "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"
}
]
}
],
"sources": [
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Represents a single member scan result details.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier of the single member scan result. |
| person | Entity¦null | false | none | The details of the matched person. |
Source
{
"url": "string",
"categories": "string",
"dates_Urls": {
"property1": "string",
"property2": "string"
},
"details": [
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
],
"type": "string"
}
Details of public sources used to build the full profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string¦null | false | none | Link to original source or website. |
| categories | string¦null | false | none | List of source categories. Possible values are: PEP, PEP by Association, Profile Of Interest, Sanctions, Regulatory Enforcement List, Disqualified Director, Insolvency, Reputational Risk Exposure, Identity, Gambling Risk Intelligence, Corporate/Business, State-Owned Enterprise. |
| dates_Urls | object¦null | false | none | List of dates the source was recorded or captured, and link to cached PDF of URL, if available.Note: In release v9.3, this has been deprecated and will be decommissioned in the future. Please use 'details' instead. |
| » additionalProperties | string¦null | false | none | none |
| details | [SourceDetails]¦null | false | none | List of details for the dates the source was recorded or captured. Note: New in v9.3 |
| type | string¦null | false | none | Type of the source. |
SourceDetails
{
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string"
}
Details of each date the source was recorded or captured.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categories | string¦null | false | none | List of source categories. Possible values are: PEP, PEP by Association, Profile Of Interest, Sanctions, Regulatory Enforcement List, Disqualified Director, Insolvency, Reputational Risk Exposure, Identity, Gambling Risk Intelligence, Corporate/Business, State-Owned Enterprise. |
| originalUrl | string¦null | false | none | Link to original source or website. |
| title | string¦null | false | none | The title captured from the source. |
| credibility | string¦null | false | none | The credibility of the source. |
| language | string¦null | false | none | The ISO 639-3 code for the language of the source. |
| summary | string¦null | false | none | A text snippet from the source, if available |
| keywords | string¦null | false | none | The keywords associated with the source. |
| captureDate | string¦null | false | none | The date that the source was recorded or captured. |
| publicationDate | string¦null | false | none | The date that the source was originally published. |
| assetUrl | string¦null | false | none | The URL link to the PDF version of the source, if available. |
SsoSettings
{
"callbackUrl": "string",
"signOutUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callbackUrl | string¦null | false | none | none |
| signOutUrl | string¦null | false | none | none |
SystemPublicSettings
{
"reCaptchaSettings": {
"globalUrl": "string",
"publicKey": "string"
},
"mailSettings": {
"fromEmail": "string",
"supportEmail": "string"
},
"serverTimezone": "string",
"isSSOEnabled": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reCaptchaSettings | ReCaptchaConfig¦null | false | none | none |
| mailSettings | MailConfig¦null | false | none | none |
| serverTimezone | string¦null | false | none | none |
| isSSOEnabled | boolean | false | none | none |
TaxHavenCountryResult
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
Details of the TaxHaven country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isPrimaryLocation | boolean¦null | false | none | Indicates whether the tax haven country is primary location of the entity. |
| countryCode | string¦null | false | none | Indicates 2-letter country code. |
| comment | string¦null | false | none | Description of tax haven country. |
| url | string¦null | false | none | The reference link for tax haven country. |
UserAccessRight
{
"id": 0,
"name": "string",
"allow": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| allow | boolean | false | none | none |
UserDetails
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| apiKey | string¦null | false | none | none |
| address | string¦null | false | none | none |
| postalAddress | string¦null | false | none | none |
| phoneNumber | string¦null | false | none | none |
| faxNumber | string¦null | false | none | none |
| failedLoginDate | string(date-time)¦null | false | none | none |
| mfaType | string | false | none | none |
| accessRights | [UserAccessRight]¦null | false | none | none |
| assignedOrganisations | [UserOrganisation]¦null | false | none | none |
| isSSOEnabled | boolean | false | none | none |
| userSsoSettings | [UserSsoSettings]¦null | false | none | none |
| id | integer(int32) | false | none | none |
| username | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| role | UserRole¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| status | string | false | none | none |
| creationDate | string(date-time)¦null | false | none | none |
| lastLoginDate | string(date-time)¦null | false | none | none |
| lastActiveDate | string(date-time)¦null | false | none | none |
| dateTimeZone | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
UserInfo
{
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "string",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| username | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| role | UserRole¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| status | string | false | none | none |
| creationDate | string(date-time)¦null | false | none | none |
| lastLoginDate | string(date-time)¦null | false | none | none |
| lastActiveDate | string(date-time)¦null | false | none | none |
| dateTimeZone | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
UserNotification
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| value | string¦null | false | none | none |
| type | string | false | none | none |
| mode | string | false | none | none |
| creationDate | string(date-time)¦null | false | none | none |
| expiryDate | string(date-time)¦null | false | none | none |
| status | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | System |
| type | User |
| mode | Note |
| mode | Alert |
| status | New |
| status | Read |
| status | Deleted |
UserOrganisation
{
"name": "string",
"id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| id | string¦null | false | none | none |
UserRole
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| label | string¦null | false | none | none |
| accessRights | [UserAccessRight]¦null | false | none | none |
UserSsoSettings
{
"identity": "string",
"clientId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identity | string¦null | false | none | none |
| clientId | string¦null | false | none | none |
WebSearchResult
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| snippet | string¦null | false | none | none |
| mime | string¦null | false | none | none |
| link | string¦null | false | none | none |
| kind | string¦null | false | none | none |
| htmlTitle | string¦null | false | none | none |
| htmlSnippet | string¦null | false | none | none |
| htmlFormattedUrl | string¦null | false | none | none |
| formattedUrl | string¦null | false | none | none |
| fileFormat | string¦null | false | none | none |
| displayLink | string¦null | false | none | none |