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.3 Updated: Sunday December 01, 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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"nationality": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"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",
"watchlists": [
"string"
]
}';
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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"nationality": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"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",
"watchlists": [
"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 | 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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"nationality": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"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",
"watchlists": [
"string"
]
},
"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",
"watchlists": [
"string"
]
},
"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
watchlists:
- string
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. |
| »» watchlists | body | [string]¦null | false | Used for matching watchlist for scan profiles. The acceptable values are PEP, POI, RCA, SIP, Official Lists and Custom Watchlists. If watchlist is not passed or is NULL, the setting configured in the organization's list access will be used as default. |
| » 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 |
Enable Member Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{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/batch/{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/batch/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{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/batch/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/batch/{id}/monitor/enable
Enables all scanned members of a batch to be actively monitored and adds them to the Monitoring List.
Member Scan - Batch Scan Results - Batch Scan Details Enables all scanned members to be actively monitored and added to the Monitoring List. If the same Client Id of each members of batch scan, already exists in the Monitoring List, this will replace the existing members 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 batch scan. The GET /member-scans/batch or POST /member-scans/batch API methods 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 |
| 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 |
Disable Member Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v2/member-scans/batch/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v2/member-scans/batch/{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/batch/{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/batch/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v2/member-scans/batch/{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/batch/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v2/member-scans/batch/{id}/monitor/disable
Disables all scanned members of a batch from being monitored.
Member Scan - Batch Scan Results - Batch Scan Details Disables all scanned members 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 batch scan. The GET /member-scans/batch or POST /member-scans/batch API methods 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 |
| 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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"watchlists": [
"string"
]
}';
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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"watchlists": [
"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 | 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",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"watchlists": [
"string"
]
},
"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"