MemberCheck API Reference v3.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.5 Updated: Sunday July 26, 2026.
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/v3
Demo URL: https://demo.api.membercheck.com/api/v3
Old API References
This document is related to API 3.0. You can find old versions documents if you use previous versions.
| MemberCheck API Reference 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/v3/member-scans/single?pageIndex=1&pageSize=10
GET https://demo.api.membercheck.com/api/v3/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
Individual/person screening against PEP, Sanctions, and watchlists. Single scans, batch scans, monitoring, rescan.
New Member Single Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/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/v3/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": "ApplyAll",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "Yes",
"clientId": "CLIENT-001",
"firstName": "Anthony",
"middleName": "",
"lastName": "Albanese",
"scriptNameFullName": "",
"gender": "Male",
"dob": "02/03/1963",
"dobTolerance": 2,
"idNumber": "",
"address": "123 Example St, Sydney NSW 2000",
"country": [
"AU"
],
"nationality": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "john.smith@example.com"
},
"idvParam": {
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "ABCXYZ",
"parentOrigin": "https://example.com"
},
"includeJurisdictionRisk": "No",
"watchlists": [],
"dataSources": "Acuris",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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": "ApplyAll",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "Yes",
"clientId": "CLIENT-001",
"firstName": "Anthony",
"middleName": "",
"lastName": "Albanese",
"scriptNameFullName": "",
"gender": "Male",
"dob": "02/03/1963",
"dobTolerance": 2,
"idNumber": "",
"address": "123 Example St, Sydney NSW 2000",
"country": [
"AU"
],
"nationality": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "john.smith@example.com"
},
"idvParam": {
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "ABCXYZ",
"parentOrigin": "https://example.com"
},
"includeJurisdictionRisk": "No",
"watchlists": [],
"dataSources": "Acuris",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
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",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"idvUrl": "string",
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"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",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| clientId | query | string | false | All or part of 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. |
| includeAdvancedMedia | query | array[string] | false | Advanced Media 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. |
| dataSources | query | array[string] | false | Data Sources of scan. 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 |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | 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 | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
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",
"supportingDocumentNames": [
"string"
],
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
]
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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¦null | 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. |
| » supportingDocumentNames | [string]¦null | false | none | List of supporting document names of a specific scan. |
| » 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. |
| » 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). |
| » amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
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 |
| scanService | RiskAssessment |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
Member Single Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| clientId | query | string | false | All or part of 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. |
| includeAdvancedMedia | query | array[string] | false | Advanced Media 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. |
| dataSources | query | array[string] | false | Data Sources of scan. 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | IDVerification |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | 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 | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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",
"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",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "AuGovtVerification",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "string",
"parentOrigin": "string"
},
"includeJurisdictionRisk": "No",
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "DOB"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"idvUrl": "string",
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"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",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
},
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Rescan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/rescan", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/single/{id}/rescan
Performs member rescan based on previously scanned data.
Member Scan - Scan History - Rescan allows you to rescan members based on previously scanned data.
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. |
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",
"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",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "AuGovtVerification",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "string",
"parentOrigin": "string"
},
"includeJurisdictionRisk": "No",
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "DOB"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"idvUrl": "string",
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"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",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ScanHistoryDetail |
| 201 | Created | ScanHistoryDetail; details of the Scan Parameters used and member information that was rescanned 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. |
None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scan Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/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-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/{id}/report
Downloads report file of Full Profile Information of the scanned entity.
Member Scan - Scan History - Report Downloads report file of information on the scanned entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The scan id of a specific scanned entity. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scan Result Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scan Result Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scan No Result Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/no-results-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/no-results-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/no-results-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/no-results-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/no-results-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Member Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/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/v3/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": "ApplyAll",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "Yes",
"dobTolerance": 2,
"updateMonitoringList": false,
"allowDuplicateFileName": false,
"includeJurisdictionRisk": "No",
"includeAdvancedMedia": "No",
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
},
"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/v3/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/v3/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/v3/member-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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: ApplyAll
blankAddress: ApplyResidenceCountry
pepJurisdiction: Apply
excludeDeceasedPersons: Yes
dobTolerance: 2
updateMonitoringList: false
allowDuplicateFileName: false
includeJurisdictionRisk: No
includeAdvancedMedia: No
watchlists: ""
includeRiskAssessment: No
ignoreBlankPolicy: ""
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 | 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. |
| »» 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. |
| »» dataSources | body | string¦null | false | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| »» 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 organisation's list access will be used as default. |
| »» includeRiskAssessment | body | string¦null | false | Indicates whether a risk assessment check is included. |
| »» ignoreBlankPolicy | body | string¦null | false | Used for filtering result profiles with blank related entries. |
| » 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 |
| »» dataSources | MemberCheck |
| »» dataSources | Acuris |
| »» dataSources | LexisNexis |
| »» includeRiskAssessment | No |
| »» includeRiskAssessment | Yes |
| »» ignoreBlankPolicy | DOB |
| »» ignoreBlankPolicy | Gender |
| »» ignoreBlankPolicy | IDNumber |
| »» ignoreBlankPolicy | Nationality |
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | 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 | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"ignoreBlankPolicy": "DOB"
}
]
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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. |
| » matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » residence | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| » excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| » dobTolerance | integer(int32)¦null | false | none | DOB Tolerance used for scan. |
| » ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
Member Batch Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/batch/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/batch/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/batch/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/batch/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/batch/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| 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",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"ignoreBlankPolicy": "DOB"
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scan Exception Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/exception-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/exception-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/exception-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/exception-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/exception-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scan Full Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/full-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/full-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/full-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/full-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/full-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Batch Scan Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/batch/{id}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch/{id}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/batch/{id}/status
Gets member 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; member batch scan status detail. | BatchScanStatus |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Cancel Member Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/cancel \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/cancel HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/batch/{id}/cancel', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch/{id}/cancel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/batch/{id}/cancel
Cancel a scheduled member batch scan.
Member Scan - Batch Scan History - Scheduled Cancel Cancel a scheduled member 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 | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Monitoring History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No"
}
]
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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¦null | false | none | Monitoring Scan or Rescan. |
| » totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| » 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. |
| » matchType | string¦null | false | none | Match type scanned. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » residence | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| » excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
Member Monitoring History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/monitoring/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/monitoring/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/monitoring/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Monitoring Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/monitoring/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/monitoring/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| 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",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalMembersMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No"
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Monitoring Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/monitoring/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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). |
| 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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 | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 409 | Conflict | The requested resource conflicted with an existing member with the same clientId in the Monitoring List. |
None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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 | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Review Member Monitoring Results
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/review \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/monitor/review HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/{id}/monitor/review', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/{id}/monitor/review", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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 | OK | 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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Bulk Enable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-enable \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-enable HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"forceUpdate": true,
"ids": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-enable',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-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{
"Content-Type": []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/v3/member-scans/single/monitor/bulk-enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/single/monitor/bulk-enable
Bulk enables scanned members to be actively monitored and adds them to the Monitoring List.
Member Scan - Scan History Bulk enables scanned members to be actively monitored and added to the Monitoring List. If any Client Id already exists as an active entry in the Monitoring List, a 409 is returned with the conflicting Scan/Client Ids. Pass forceUpdate=true to force-replace all conflicts.
Body parameter
{
"forceUpdate": true,
"ids": [
0
]
}
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 | BulkEnableInputParam | false | Bulk enable parameters, comma-separated list of scan identifiers (scanId) to be enabled for monitoring. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of items enabled. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 409 | Conflict | One or more Client Ids already exist as active entries in the Monitoring List. Response body contains the conflicting Scan/Client Ids. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Bulk Disable Member Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-disable \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-disable HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"ids": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-disable',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/monitor/bulk-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{
"Content-Type": []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/v3/member-scans/single/monitor/bulk-disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/single/monitor/bulk-disable
Bulk disables scanned members from being monitored.
Member Scan - Scan History Bulk disables scanned members from being actively monitored. The members remain in the Monitoring List but are no longer actively monitored.
Body parameter
{
"ids": [
0
]
}
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 | BulkDisableInputParam | false | Comma-separated list of scan identifiers (scanId) to be disabled from monitoring. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of items disabled. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Member Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/batch/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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 | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Member Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/batch/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/batch/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/batch/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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 | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Compromised Information Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/compromised-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/compromised-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/compromised-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/compromised-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/compromised-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Individual Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}/linked-individuals/{individualId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/linked-individuals/{individualId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Individual Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/{individualId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Company Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}/linked-companies/{companyId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/linked-companies/{companyId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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 = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Scan Result Evidence
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/results/{id}/sources/{sourceId}/asset-url
Get the file URL of a specific source of the matched member where cached PDFs are not available for copyrighted media.
Member Scan - Scan History - Found Entities - Sources and Adverse Media Returns the copyrighted asset file URL of a specific source in PDF format. The link is valid for up to 15 minutes.
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. |
| sourceId | path | integer(int32) | true | The Source ID of the profile or the linked entity. The GET /member-scans/single/results/{id} API method response class returns this identifier in scanResult.matchedEntities.resultEntity.sources.details.id. |
| linkedEntityId | query | integer(int32) | false | The identifier of a specific linked individual or company associated with a matched member. If this optional parameter is provided, the sourceId must correspond to the identifier of a specific source for this linked entity. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The file URL of a specific source. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Members Due Diligence Decisions
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/results/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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": "High",
"comment": "Confirmed true match."
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Member Due Diligence Decision
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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": "High",
"comment": "Confirmed true match."
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Due Diligence History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/decisions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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/v3/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/v3/member-scans/single/results/{id}/questions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"question": "Is this person politically exposed?",
"helperText": "Consider their country of residence, nationality, and any prominent positions they may hold."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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": "Is this person politically exposed?",
"helperText": "Consider their country of residence, nationality, and any prominent positions they may hold."
}
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member AI Analysis Question History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/questions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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/v3/member-scans/single/results/{id}/questions/{questionId} \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/questions/{questionId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/member-scans/single/results/{id}/questions/{questionId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/questions/{questionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Single Scan Category Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/category-risks \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/member-scans/single/results/{id}/category-risks', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/member-scans/single/results/{id}/category-risks", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents',
{
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/v3/member-scans/single/{id}/documents',
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/v3/member-scans/single/{id}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents");
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/v3/member-scans/single/{id}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/{id}/documents
Returns supporting documents of a specific member scan.
Member Scan - Supporting Documents provides all supporting documents of a specific member 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. |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentResult; lists of the supporting documents for a person selected in the scan results or scan history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
New Member Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"Documents": [
{
"file": "string",
"comment": "string",
"documentTypeId": 0
}
],
"IsOverwrite": true,
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/single/{id}/documents
Upload supporting documents for a specific member scan.
Member Scan - Supporting Documents - Upload Documents allows you to upload supporting documents for a specific member scan. Supported File Types: PDF, JPG, JPEG, PNG, GIF, TIF, TIFF, ZIP
Body parameter
Documents:
- file: string
comment: string
documentTypeId: 0
IsOverwrite: true
File: string
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. |
| body | body | object | false | none |
| » Documents | body | [SupportingDocumentFile] | false | A list of supporting documents, including files, comments, and document types. |
| »» file | body | string(binary) | true | The uploaded supporting document file. |
| »» comment | body | string¦null | false | Comments associated with the supporting document. |
| »» documentTypeId | body | integer(int32) | false | The identifier of the selected document type for the supporting document. |
| » IsOverwrite | body | boolean | false | Indicates whether an existing supporting document should be overwritten (true if overwrite is enabled). |
| » File | body | string(binary) | false | Supporting document files to be uploaded. |
Example responses
201 Response
{
"uploadedFileResult": [
{
"fileName": "string",
"supportingDocumentId": 0
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | SupportingDocumentResponse; contains information of uploaded supporting documents. | SupportingDocumentResponse |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Pin Member Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/pin \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/pin HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/pin',
{
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/v3/member-scans/single/{id}/documents/{documentId}/pin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/pin', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/pin");
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/v3/member-scans/single/{id}/documents/{documentId}/pin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/single/{id}/documents/{documentId}/pin
Toggles the pin status of a specific supporting document.
Member Scan - Supporting Documents - Pin/Unpin Document allows you to pin or unpin supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /member-scans/single/{id}/documents or POST /member-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Download Member Scan Supporting Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/download \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/download HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/download',
{
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/v3/member-scans/single/{id}/documents/{documentId}/download',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/download', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}/download");
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/v3/member-scans/single/{id}/documents/{documentId}/download", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/{id}/documents/{documentId}/download
Downloads a specific supporting document.
Member Scan - Supporting Documents - Download Document allows you to download a specific supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /member-scans/single/{id}/documents or POST /member-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the file content for the requested document. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Member Scan Supporting Document
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/{documentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/member-scans/single/{id}/documents/{documentId}
Deletes a specific supporting document.
Member Scan - Supporting Documents - Delete Document allows you to delete a specific supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /member-scans/single/{id}/documents or POST /member-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Scan Supporting Documents History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/history \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/history HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/history',
{
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/v3/member-scans/single/{id}/documents/history',
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/v3/member-scans/single/{id}/documents/history', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/{id}/documents/history");
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/v3/member-scans/single/{id}/documents/history", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/{id}/documents/history
Returns the supporting document history of a specific member scan.
Member Scan - Supporting Documents - Documents History provides a history of all uploaded, overwritten, downloded and deleted supporting documents.
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. |
Example responses
200 Response
[
{
"fileName": "string",
"date": "2019-08-24T14:15:22Z",
"uploadedBy": "string",
"action": "Uploaded"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentHistoryResult, lists the supporting document history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentHistoryResult] | false | none | [Represents the history of actions performed on a supporting document.] |
| » fileName | string¦null | false | none | The name of the supporting document. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » action | string¦null | false | none | The action performed on the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| action | Uploaded |
| action | Downloaded |
| action | Overwritten |
| action | Deleted |
Bookmark Member Scan Advanced Media
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"scanInputId": 0,
"articleId": 0,
"siteId": 0
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/advanced-media/bookmark");
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"},
"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/v3/member-scans/advanced-media/bookmark", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/member-scans/advanced-media/bookmark
Toggles the bookmark status of a specific article.
Member Scan - Advanced Media Bookmark - Add/Remove Bookmark allows you to add or remove bookmarks from advanced media articles.
Body parameter
{
"scanInputId": 0,
"articleId": 0,
"siteId": 0
}
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 | AdvancedMediaBookmarkParam | false | Bookmark parameters, which include ScanInputId, ArticleId and SiteId of bookmarked article. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Individuals Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/risk-levels \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/risk-levels HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/risk-levels',
{
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/v3/member-scans/single/results/{id}/linked-individuals/risk-levels',
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/v3/member-scans/single/results/{id}/linked-individuals/risk-levels', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-individuals/risk-levels");
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/v3/member-scans/single/results/{id}/linked-individuals/risk-levels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/results/{id}/linked-individuals/risk-levels
Returns the linked individual profiles with suggested risks of a specific member scan.
Member Scan - Scan History - Found Entities - Linked Individuals Returns the linked individual profiles with suggested risks of a specific member scan.
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
{
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedIndividualsOld": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of linked individuals of specific member scan including Individual Id, Name, Category, Description and Calculated Risks. | LinkedProfiles |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Linked Companies Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/risk-levels \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/risk-levels HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/risk-levels',
{
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/v3/member-scans/single/results/{id}/linked-companies/risk-levels',
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/v3/member-scans/single/results/{id}/linked-companies/risk-levels', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/member-scans/single/results/{id}/linked-companies/risk-levels");
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/v3/member-scans/single/results/{id}/linked-companies/risk-levels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/member-scans/single/results/{id}/linked-companies/risk-levels
Returns the linked company profiles with suggested risks of a specific member scan.
Member Scan - Scan History - Found Entities - Linked Companies Returns the linked company profiles with suggested risks of a specific member scan.
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
{
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompaniesOld": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of linked companies of specific member scan including Company Id, Name, Category, Description and Calculated Risks. | CorpLinkedProfiles |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Scans
Corporate/entity screening against corporate watchlists. Single scans, batch scans, monitoring, rescan.
New Corporate Single Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/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/v3/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": "ApplyAll",
"blankAddress": "Ignore",
"companyName": "Example Corporation Pty Ltd",
"idNumber": "12345678",
"registrationNumber": "12345678",
"clientId": "CORP-001",
"address": "123 Corporate Ave, Sydney NSW 2000",
"country": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "AU",
"registrationNumberSearch": false,
"allowDuplicateKYBScan": false
},
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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/v3/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/v3/corp-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/corp-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/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": "ApplyAll",
"blankAddress": "Ignore",
"companyName": "Example Corporation Pty Ltd",
"idNumber": "12345678",
"registrationNumber": "12345678",
"clientId": "CORP-001",
"address": "123 Corporate Ave, Sydney NSW 2000",
"country": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "AU",
"registrationNumberSearch": false,
"allowDuplicateKYBScan": false
},
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
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",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"kybScanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/corp-scans/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/corp-scans/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| 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. |
| includeAdvancedMedia | query | array[string] | false | Advanced Media 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). |
| dataSources | query | array[string] | false | Data Sources of scan. 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 | KYB |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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 |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
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,
"isRiskAssessment": true,
"scanService": "PepAndSanction",
"supportingDocumentNames": [
"string"
],
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
]
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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¦null | false | none | Scan type. See supported values below. |
| » matchType | string¦null | false | none | Match type scanned. See supported values below. |
| » whitelist | string¦null | 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. |
| » isRiskAssessment | boolean¦null | false | none | Identifies that Risk Assessment is performed or not. |
| » scanService | string¦null | false | none | Type of service for scan. |
| » supportingDocumentNames | [string]¦null | false | none | List of supporting document names associated with a specific 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. |
| » registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| » 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). |
| » amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| scanService | RiskAssessment |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
Corporate Single Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/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',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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. |
| 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. |
| includeAdvancedMedia | query | array[string] | false | Advanced Media 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). |
| dataSources | query | array[string] | false | Data Sources of scan. 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | KYB |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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 |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/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/v3/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/v3/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/v3/corp-scans/single/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/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/v3/corp-scans/single/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/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 | EntityType |
| 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",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"kybScanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpScanHistoryDetail; details of the Company information that was scanned and lists Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. |
CorpScanHistoryDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Rescan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/rescan", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/rescan
Performs corporate rescan based on previously scanned data.
Corporate Scan - Scan History - Rescan allows you to scan companies based on previously scanned data.
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. |
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",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"kybScanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CorpScanHistoryDetail |
| 201 | Created | CorpScanHistoryDetail; details of the Company information that was rescanned and lists Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. |
None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scan Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/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-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{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{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/{id}/report
Downloads report file of Full Profile Information of the scanned entity.
Corp Scan - Scan History - Report Downloads report file of information on the scanned entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The scan id of a specific scanned entity. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scan Result Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}
Gets the Profile Information of the Entity (all available information from the watchlists).
Corporate Scan - Scan History - Found Entities Returns the Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"id": 0,
"entity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SingleScanCorpResultDetail; Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. | SingleScanCorpResultDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scan Result Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/report
Downloads report file of Profile Information of the Entity.
Corporate Scan - Scan History - Found Entities - Report Downloads report file of all available information in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scan No Result Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/no-results-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/{id}/no-results-report
Downloads report file of no matches found scan.
Corporate Scan - Scan History - No Matches Entities - Report Downloads report file of no matches found scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Corporate Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/batch \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/batch HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"param": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "ApplyAll",
"blankAddress": "ApplyDefaultCountry",
"updateMonitoringList": false,
"allowDuplicateFileName": false,
"includeJurisdictionRisk": "No",
"includeAdvancedMedia": "No",
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
},
"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/v3/corp-scans/batch',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/batch
Performs new corporate batch scan.
Corporate Scan - Batch Scan allows you to scan uploaded batch files of Company data against the lists and Watchlists to which your organisation has access.
Body parameter
param:
matchType: Close
closeMatchRateThreshold: 80
whitelist: Apply
addressPolicy: ApplyAll
blankAddress: ApplyDefaultCountry
updateMonitoringList: false
allowDuplicateFileName: false
includeJurisdictionRisk: No
includeAdvancedMedia: No
watchlists: ""
includeRiskAssessment: No
ignoreBlankPolicy: ""
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | object | false | none |
| » param | body | CorpBatchScanInputParam | false | Scan parameters, which include match type and whitelist policy, are applied to each scan. |
| »» matchType | body | string¦null | false | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. |
| »» closeMatchRateThreshold | body | integer(int32)¦null | false | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| »» whitelist | body | string¦null | false | Used for eliminating match results previously determined to not be a true match. |
| »» addressPolicy | body | string¦null | false | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| »» blankAddress | body | string¦null | false | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| »» updateMonitoringList | body | boolean | false | Used for adding the companies to Monitoring List for all records in the batch file with clientId/entityNumber, if the Monitoring setting is On. |
| »» allowDuplicateFileName | body | boolean | false | Used for allowing scan of files with duplicate name. |
| »» includeJurisdictionRisk | body | string¦null | false | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| »» dataSources | body | string¦null | false | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| »» watchlists | body | [string]¦null | false | Used for matching watchlist for scan profiles. The acceptable values are POI, SIE, Official Lists, SOE, Entity Type and Custom Watchlists. If watchlist is not passed or is NULL, the setting configured in the organisation's list access will be used as default. |
| »» includeRiskAssessment | body | string¦null | false | Indicates whether a risk assessment check is included. |
| »» ignoreBlankPolicy | body | string¦null | false | Used for filtering result profiles with blank related entries. |
| » File | body | string(binary) | false | Batch file containing companies |
Enumerated Values
| Parameter | Value |
|---|---|
| »» matchType | Close |
| »» matchType | Exact |
| »» whitelist | Apply |
| »» whitelist | Ignore |
| »» addressPolicy | Ignore |
| »» addressPolicy | ApplyAll |
| »» blankAddress | ApplyDefaultCountry |
| »» blankAddress | Ignore |
| »» includeJurisdictionRisk | No |
| »» includeJurisdictionRisk | Yes |
| »» dataSources | MemberCheck |
| »» dataSources | Acuris |
| »» dataSources | LexisNexis |
| »» includeRiskAssessment | No |
| »» includeRiskAssessment | Yes |
| »» ignoreBlankPolicy | RegistrationNumber |
Example responses
201 Response
{
"batchScanId": 0,
"status": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | BatchScanResult: contains batch scan identifier. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of this batch scan. |
BatchScanResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | 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 | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch
Returns corporate batch scan history.
Corporate Scan - Batch Scan History provides a record of all batch scans performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"ignoreBlankPolicy": "RegistrationNumber"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpBatchScanHistoryLog; lists the batch files that have been uploaded and includes Date and time, File name, Number of Companies Scanned, Number of Matched Companies, Total Number of Matches and Status of the scan. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of each batch scan. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpBatchScanHistoryLog] | false | none | [Represents details of the batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| » matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
| » matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » addressPolicy | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| ignoreBlankPolicy | RegistrationNumber |
Corporate Batch Scans History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/report
Downloads a list of corporate batch scan history report in Excel, Word or PDF.
Corporate Scan - Batch Scan History - Report Download a report file of all batch scans based on specified filters for the selected organisation. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/{id}
Returns details of a specific batch scan.
Corporate Scan - Batch Scan History - View Exception Report shows the batch scan results and a list of matched companies.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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",
"defaultCountry": "string",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"ignoreBlankPolicy": "RegistrationNumber"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpBatchScanResults; lists the batch scan results and a list of matched companies. The returned matchedEntities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each company scan of this batch. |
CorpBatchScanResults |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/{id}/report
Downloads the report file for a corporate batch scan.
Corporate Scan - Batch Scan History - Download Exception Report Downloads a report of corporate batch scan results and a list of matched corporates if any, in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scan Exception Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/exception-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/{id}/exception-report
Downloads the exception report file (csv) of corporate batch scan.
Corporate Scan - Batch Scan History - Download Exception Report (csv) Downloads exception report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| includeResultsSummary | query | boolean | false | Include matched result entities information or not. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scan Full Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/full-report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/{id}/full-report
Downloads the full report file (csv) of corporate batch scan.
Corporate Scan - Batch Scan History - Download Full Report (csv) Downloads full report file (csv) of batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Batch Scan Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/batch/{id}/status
Gets corporate batch scan status detail.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
Example responses
200 Response
{
"batchScanId": 0,
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpBatchScanStatus; corporate batch scan status detail. | CorpBatchScanStatus |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Cancel Corporate Batch Scan
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/cancel", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/batch/{id}/cancel
Cancel a scheduled corporate batch scan.
Corporate Scan - Batch Scan History - Scheduled Cancel Cancel a scheduled corporate batch scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Monitoring History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/monitoring',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/monitoring");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/monitoring
Returns the monitoring history actvities for companies.
Corporate Scan - Monitoring History provides a record of all auto scan activities performed for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return company monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return company monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | MonitoringWithUpdates |
| scanResult | AllMonitoringScans |
| reviewStatus | NotReviewed |
| reviewStatus | InProgress |
| reviewStatus | Reviewed |
| reviewStatus | All |
Example responses
200 Response
[
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpMonitoringScanHistoryLog; lists the monitoring scans that have been done and includes Date, Total Companies Monitored, Companies Checked, New Matches, Updated Entities, Removed Matches and Status of the scan. The returned monitoringScanId should be used in GET /corp-scans/monitoring/{id} API method to obtain details of each monitoring scan. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpMonitoringScanHistoryLog] | false | none | [Represents details of the automated corporate monitoring scan.] |
| » monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| » date | string(date-time) | false | none | Date the monitoring scan was run. |
| » scanType | string¦null | false | none | Monitoring Scan or Rescan. |
| » totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| » newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| » updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| » removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| » status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| » reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| » companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
| » matchType | string¦null | false | none | Match type scanned. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » addressPolicy | string¦null | false | none | Address policy scanned. |
| » defaultCountry | string¦null | false | none | Default country of operation of scan. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
Corporate Monitoring History Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/monitoring/report
Downloads a list of corporate monitoring activities in Excel, Word or PDF.
Corporate Scan - Monitoring History - Report Downloads a report of all auto scan activities based on specified filters for the selected organisation in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| from | query | string | false | The date from when the monitoring scan was run (DD/MM/YYYY). |
| to | query | string | false | The date to when the monitoring scan was run (DD/MM/YYYY). |
| scanResult | query | string | false | Option to return company monitoring history activities with updates only (MonitoringWithUpdates) or return all monitoring activities regardless of whether there were any updates (AllMonitoringScans). If not defined, it defaults to MonitoringWithUpdates. |
| reviewStatus | query | string | false | Option to return company monitoring history activities with a specific review status: (Reviewed; In Progress; Not Reviewed) |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Monitoring Scan Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/monitoring/{id}
Returns details of a specific monitoring scan.
Corporate Scan - Monitoring History shows the monitoring scan results and a list of companies with detected changes or matches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpMonitoringScanResults; lists the monitoring scan results and a list of matched corporates. The returned entities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each corporate scan of this monitoring scan. |
CorpMonitoringScanResults |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Monitoring Scan Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/monitoring/{id}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/monitoring/{id}/report
Downloads a report of a specific monitoring scan in Excel, Word or PDF.
Corporate Scan - Monitoring History - View Exception Report - Download Report Downloads a report of monitoring scan results and a list of corporates with detected changes and new matches in Excel, Word or PDF. Returns up to 10,000 records.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| registrationNumber | query | string | false | All or part of Registration Number. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| category | query | array[string] | false | Category of entity in scan result. See supported values below. |
| subCategory | query | array[string] | false | SIE subcategories of entity in scan result. See supported values below. |
| decision | query | array[string] | false | Due diligence decision of scan result. See supported values below. |
| risk | query | array[string] | false | Assessed risk level of scan result. See supported values below. |
| monitoringStatus | query | array[string] | false | Outcome of the monitoring status of the scan result. See supported values below. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
| category | TER |
| category | SIE |
| category | POI |
| category | SOE |
| category | EntityType |
| 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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/monitor/enable
Enables a scanned company to be actively monitored and adds them to the Monitoring List.
Corporate Scan - Scan History - Monitor column Enables the company to be actively monitored and added to the Monitoring List. If the same Client Id already exists in the Monitoring List, this will replace the existing company in the Monitoring List. Client Ids for companies must be unique as this will replace any existing company with the same Client Id in the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| forceUpdate | query | boolean | false | Used to ignore check existing company with the same scan history clientId in the Monitoring List. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 409 | Conflict | The requested resource conflicted with an existing company with the same clientId in the Monitoring List. |
None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/monitor/disable
Disables a scanned company from being monitored.
Corporate Scan - Scan History - Monitor column Disables the company in the Monitoring List from being actively monitored. The scanned company remains in the Monitoring List but is not actively monitored. To remove the company entirely from the Monitoring List, refer to Delete Company Monitoring.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Review Corporate Monitoring Results
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/monitor/review", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/monitor/review
Set review status of corporate monitoring scan and return review summary with "date;username" format.
Corporate Scan - Scan History - Review column Set review status of corporate monitoring scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| status | query | boolean | false | Specifies is corporate scan reviewed by the client. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | 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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Bulk Enable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-enable \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-enable HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"forceUpdate": true,
"ids": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-enable',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-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{
"Content-Type": []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/v3/corp-scans/single/monitor/bulk-enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/monitor/bulk-enable
Bulk enables scanned companies to be actively monitored and adds them to the Monitoring List.
Corporate Scan - Scan History Bulk enables scanned companies to be actively monitored and added to the Monitoring List. If any Client Id already exists as an active entry in the Monitoring List, a 409 is returned with the conflicting Scan/Client Ids. Pass forceUpdate=true to force-replace all conflicts.
Body parameter
{
"forceUpdate": true,
"ids": [
0
]
}
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 | BulkEnableInputParam | false | Bulk enable parameters, comma-separated list of scan identifiers (scanId) to be enabled for monitoring. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of items enabled. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 409 | Conflict | One or more Client Ids already exist as active entries in the Monitoring List. Response body contains the conflicting Scan/Client Ids. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Bulk Disable Corporate Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-disable \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-disable HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"ids": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-disable',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/monitor/bulk-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{
"Content-Type": []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/v3/corp-scans/single/monitor/bulk-disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/monitor/bulk-disable
Bulk disables scanned companies from being monitored.
Corporate Scan - Scan History Bulk disables scanned companies from being actively monitored. The members remain in the Monitoring List but are no longer actively monitored.
Body parameter
{
"ids": [
0
]
}
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 | BulkDisableInputParam | false | Comma-separated list of scan identifiers (scanId) to be disabled from monitoring. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of items disabled. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Corporate Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/monitor/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/monitor/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-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/v3/corp-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/v3/corp-scans/batch/{id}/monitor/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-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/v3/corp-scans/batch/{id}/monitor/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/batch/{id}/monitor/enable
Enables all scanned companies of a batch to be actively monitored and adds them to the Monitoring List.
Corporate Scan - Batch Scan Results - Batch Scan Details Enables all scanned companies to be actively monitored and added to the Monitoring List. If the same Client Id of each companies of batch scan, already exists in the Monitoring List, this will replace the existing companies in the Monitoring List. Client Ids for companies must be unique as this will replace any existing company with the same Client Id in the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API methods response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Corporate Batch Scan Monitoring
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/monitor/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/batch/{id}/monitor/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-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/v3/corp-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/v3/corp-scans/batch/{id}/monitor/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-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/v3/corp-scans/batch/{id}/monitor/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/batch/{id}/monitor/disable
Disables all scanned companies of a batch from being monitored.
Corporate Scan - Batch Scan Results - Batch Scan Details Disables all scanned companies in the Monitoring List from being actively monitored. The scanned company remains in the Monitoring List but is not actively monitored. To remove the member entirely from the Monitoring List, refer to Delete Corporate Monitoring.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corp batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API methods response class returns this identifier in batchScanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Individual Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}
Gets the Profile Information of the linked individual entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Individuals Returns all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedIndividuals.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Individual Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-individuals/{individualId}/report
Downloads report file of Profile Information of the linked individual entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Individuals - Report Downloads report file of all available information on the Entity including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| individualId | path | integer(int32) | true | The identifier of a specific linked individual of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedIndividuals.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Company Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}
Gets the Profile Information of the linked company entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Companies Returns the Entity's Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedCompanies.id. |
Example responses
200 Response
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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 | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-companies/{companyId}/report
Downloads report file of Profile Information of the linked company entity of a matched company.
Corporate Scan - Scan History - Found Entities - Linked Companies - Report Downloads report file of all available information in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| companyId | path | integer(int32) | true | The identifier of a specific linked company of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedCompanies.id. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Scan Result Evidence
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/sources/{sourceId}/asset-url
Get the file URL of a specific source of the matched company where cached PDFs are not available for copyrighted media.
Corporate Scan - Scan History - Found Entities - Sources and Adverse Media Returns the copyrighted asset file URL of a specific source in PDF format. The link is valid for up to 15 minutes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The Result ID of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| sourceId | path | integer(int32) | true | The Source ID of the profile or the linked entity. The GET /corp-scans/single/results/{id} API method response class returns this identifier in scanResult.matchedEntities.resultEntity.sources.details.id. |
| linkedEntityId | query | integer(int32) | false | The identifier of a specific linked individual or company associated with a matched company. If this optional parameter is provided, the sourceId must correspond to the identifier of a specific source for this linked entity. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The file URL of a specific source. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Corporates Due Diligence Decisions
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/results/decisions
Adds a due diligence decision for matched corporates.
Corporate Scan - Due Diligence Decision You are able to input due diligence decisions for a corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ids | query | string | false | The result ids of matched corporates. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New Corporate Due Diligence Decision
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/results/{id}/decisions
Adds a due diligence decision for a matched corporate.
Corporate Scan - Due Diligence Decision You are able to input due diligence decisions for a corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Body parameter
{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched corporate. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | DecisionParam | false | Due Diligence Decision parameters, which include decision, risk and comment. |
Example responses
201 Response
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | DecisionResult: contains brief information of added decision and decisions count of main scan. | DecisionResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Due Diligence History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/decisions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/decisions
Gets due diligence decision history.
Corporate Scan - Due Diligence Decision provides due diligence decision history of Entity selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched corporate. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"username": "string",
"date": "2019-08-24T14:15:22Z",
"decision": "string",
"comment": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of DecisionHistory; lists the due diligence decisions for a corporate selected in the scan results or scan history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DecisionHistory] | false | none | [Returns the due diligence decisions for a person or corporate entity.] |
| » username | string¦null | false | none | The user who recorded the decision. |
| » date | string(date-time) | false | none | The date and time of decision. |
| » decision | string¦null | false | none | The status and risk of decision. |
| » comment | string¦null | false | none | Additional comment entered with the decision. |
New Corporate AI Analysis Question
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"question": "Is this person politically exposed?",
"helperText": "Consider their country of residence, nationality, and any prominent positions they may hold."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/results/{id}/questions
Provides answer according to user's question.
AI Analysis Allows you to ask questions and returns the answer details.
Body parameter
{
"question": "Is this person politically exposed?",
"helperText": "Consider their country of residence, nationality, and any prominent positions they may hold."
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| body | body | AIAnalysisInputParam | false | AIAnalysis param, which includes Question and HelperText. |
Example responses
201 Response
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | AIAnalysisResultInfo: returns answer details of asked question. The returned scanResultId should be used as id in GET /corp-scans/single/results/{id}/questions API method to obtain details of the record. |
AIAnalysisResultInfo |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate AI Analysis Question History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/questions
Returns the answer details of an entity.
AI Analysis Returns AI Analysis records including question and answer details.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
[
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of AIAnalysisResultInfo; Returns AI Analysis records for an entity. The returned id should be used as questionId in PUT /corp-scans/results/{id}/questions/{questionId} API method to perform strike/unstrike operation on record. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AIAnalysisResultInfo] | false | none | [Represents AIAnalysisResultInfo for entity.] |
| » id | integer(int32) | false | none | Identifier of AI Analysis record. This should be used in PUT /ai-analysis/question/{id} API method to Perform strike/unstrike operation on record. |
| » scanResultId | integer(int32) | false | none | The identifier of matched entity. The GET /member-scans/single/{id} or GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| » question | string¦null | false | none | Question to be asked for AI Analysis. |
| » answer | string¦null | false | none | Provides answer to the question. |
| » isStrikedOut | boolean | false | none | Identifies AI Analysis record is striked out or not. |
Update Corporate AI Analysis Question
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId} \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/questions/{questionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/corp-scans/single/results/{id}/questions/{questionId}
Performs strike/unstrike operation.
AI Analysis allows user to strike/unstrike records if they want to suspend the answer information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of matched entity. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| questionId | path | integer(int32) | true | Identifier of AI Analysis record. The POST /corp-scans/single/results/{id}/questions or GET /corp-scans/single/results/{id}/questions API method response class returns this identifier in id. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Single Scan Category Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/category-risks", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/category-risks
Returns category wise risks and overall risk level.
Corporate Scan - Due Diligence Decision provides category wise risks and overall risk level of corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"categoryRisks": [
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
],
"overAllRisk": "Unallocated"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of RiskResult; lists of the category wise risks and overall risk level for a corporate selected in the scan results or scan history. | RiskResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents',
{
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/v3/corp-scans/single/{id}/documents',
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/v3/corp-scans/single/{id}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents");
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/v3/corp-scans/single/{id}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/{id}/documents
Returns supporting documents of a specific corporate scan.
Corporate Scan - Supporting Documents provides all supporting documents of a specific corporate scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentResult; lists of the supporting documents for a corporate selected in the scan results or scan history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
New Corporate Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"Documents": [
{
"file": "string",
"comment": "string",
"documentTypeId": 0
}
],
"IsOverwrite": true,
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/documents
Upload supporting documents for a specific corporate scan.
Corporate Scan - Supporting Documents - Upload Documents allows to upload supporting documents for a specific corporate scan. Supported File Types: PDF, JPG, JPEG, PNG, GIF, TIF, TIFF, ZIP
Body parameter
Documents:
- file: string
comment: string
documentTypeId: 0
IsOverwrite: true
File: string
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. |
| body | body | object | false | none |
| » Documents | body | [SupportingDocumentFile] | false | A list of supporting documents, including files, comments, and document types. |
| »» file | body | string(binary) | true | The uploaded supporting document file. |
| »» comment | body | string¦null | false | Comments associated with the supporting document. |
| »» documentTypeId | body | integer(int32) | false | The identifier of the selected document type for the supporting document. |
| » IsOverwrite | body | boolean | false | Indicates whether an existing supporting document should be overwritten (true if overwrite is enabled). |
| » File | body | string(binary) | false | Supporting document files to be uploaded. |
Example responses
201 Response
{
"uploadedFileResult": [
{
"fileName": "string",
"supportingDocumentId": 0
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | SupportingDocumentResponse; contains information of uploaded supporting documents. | SupportingDocumentResponse |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Pin Corporate Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/pin \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/pin HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/pin',
{
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/v3/corp-scans/single/{id}/documents/{documentId}/pin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/pin', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/pin");
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/v3/corp-scans/single/{id}/documents/{documentId}/pin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/single/{id}/documents/{documentId}/pin
Toggles the pin status of a specific supporting document.
Corporate Scan - Supporting Documents - Pin/Unpin Document allows you to pin or unpin supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /corp-scans/single/{id}/documents or POST /corp-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Download Corporate Scan Supporting Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/download \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/download HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/download',
{
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/v3/corp-scans/single/{id}/documents/{documentId}/download',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/download', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}/download");
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/v3/corp-scans/single/{id}/documents/{documentId}/download", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/{id}/documents/{documentId}/download
Downloads a specific supporting document.
Corporate Scan - Supporting Documents - Download Document allows you to download a specific supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /corp-scans/single/{id}/documents or POST /corp-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the file content for the requested document. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Corporate Scan Supporting Document
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/{documentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/corp-scans/single/{id}/documents/{documentId}
Deletes a specific supporting document.
Corporate Scan - Supporting Documents - Delete Document allows you to delete a specific supporting document.
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. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /corp-scans/single/{id}/documents or POST /corp-scans/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Scan Supporting Documents History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/history \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/history HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/history',
{
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/v3/corp-scans/single/{id}/documents/history',
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/v3/corp-scans/single/{id}/documents/history', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/{id}/documents/history");
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/v3/corp-scans/single/{id}/documents/history", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/{id}/documents/history
Returns the supporting document history of a specific Corporate scan.
Corporate Scan - Supporting Documents - Documents History provides a history of all uploaded, overwritten, downloded and deleted supporting documents.
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. |
Example responses
200 Response
[
{
"fileName": "string",
"date": "2019-08-24T14:15:22Z",
"uploadedBy": "string",
"action": "Uploaded"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentHistoryResult, lists the supporting document history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentHistoryResult] | false | none | [Represents the history of actions performed on a supporting document.] |
| » fileName | string¦null | false | none | The name of the supporting document. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » action | string¦null | false | none | The action performed on the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| action | Uploaded |
| action | Downloaded |
| action | Overwritten |
| action | Deleted |
Bookmark Corporate Scan Advanced Media
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"scanInputId": 0,
"articleId": 0,
"siteId": 0
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark',
{
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',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/advanced-media/bookmark");
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"},
"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/v3/corp-scans/advanced-media/bookmark", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/corp-scans/advanced-media/bookmark
Toggles the bookmark status of a specific article.
Corporate Scan - Advanced Media Bookmark - Add/Remove Bookmark allows you to add or remove bookmarks from advanced media articles.
Body parameter
{
"scanInputId": 0,
"articleId": 0,
"siteId": 0
}
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 | AdvancedMediaBookmarkParam | false | Bookmark parameters, which include ScanInputId, ArticleId and SiteId of bookmarked article. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Individuals Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels',
{
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/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels',
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/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels");
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/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-individuals/risk-levels
Returns the linked individual profiles with suggested risks of a specific corporate scan.
Corporate Scan - Scan History - Found Entities - Linked Individuals Returns the linked individual profiles with suggested risks of a specific corporate scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedIndividualsOld": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of linked individuals of specific corporate scan including Individual Id, Name, Category, Description and Calculated Risks. | LinkedProfiles |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Linked Companies Risks
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/risk-levels \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/risk-levels HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/risk-levels',
{
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/v3/corp-scans/single/results/{id}/linked-companies/risk-levels',
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/v3/corp-scans/single/results/{id}/linked-companies/risk-levels', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/corp-scans/single/results/{id}/linked-companies/risk-levels");
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/v3/corp-scans/single/results/{id}/linked-companies/risk-levels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/corp-scans/single/results/{id}/linked-companies/risk-levels
Returns the linked company profiles with suggested risks of a specific corporate scan.
Corporate Scan - Scan History - Found Entities - Linked Companies Returns the linked company profiles with suggested risks of a specific corporate scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
Example responses
200 Response
{
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompaniesOld": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of linked companies of specific corporate scan including Company Id, Name, Category, Description and Calculated Risks. | CorpLinkedProfiles |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Risk-Check
Individual/person screening against risk assessment.
Member Risk Check List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/member-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/member-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/member-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/member-scans
Returns the list of risk assessment details including questions and answers.
Individual Scan - Risk Assessment provides a list of questions with their available options/answers and associated categories, used to perform a member risk assessment.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"id": "string",
"question": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"category": "string",
"controlType": "Text",
"isRequired": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of RiskAssessmentDetail; returns a list of risk assessment questions and answers. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [RiskAssessmentDetail] | false | none | [Represents a risk assessment detail, including its category, available options, control type, and required status.] |
| » id | string¦null | false | none | Unique identifier of the risk assessment question. |
| » question | string¦null | false | none | Provides risk assessment question. |
| » options | [RiskAssessmentOption]¦null | false | none | List of options associated with the risk assessment question. |
| »» value | string¦null | false | none | The value associated with risk assessment option. |
| »» label | string¦null | false | none | The label associated with risk assessment option. |
| » category | string¦null | false | none | Specifies the category of the risk assessment question. |
| » controlType | string¦null | false | none | Specifies the input control type for the question. |
| » isRequired | boolean | false | none | Indicates whether answering the question is mandatory. If true, the question must be answered; otherwise, it is optional. |
Enumerated Values
| Property | Value |
|---|---|
| controlType | Text |
| controlType | Radio |
| controlType | Select |
| controlType | MultiSelect |
New Member Risk Check
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/aml-risk/member-scans \
-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/v3/aml-risk/member-scans HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"clientId": "CLIENT-001",
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans',
{
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/v3/aml-risk/member-scans',
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/v3/aml-risk/member-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/member-scans");
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/v3/aml-risk/member-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/aml-risk/member-scans
Performs a member risk assessment check.
Individual Scan - Risk Assessment - Scan New allows you to perform a member risk assessment check by submitting the required information in the provided fields.
Body parameter
{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"clientId": "CLIENT-001",
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}
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 | RiskAssessmentInputParam | false | Risk assessment parameters, used to perform the risk assessment check for the member. |
Example responses
200 Response
{
"scanId": 0,
"riskAssessmentParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"riskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | RiskAssessmentScanResult |
| 201 | Created | RiskAssessmentScanResult: contains the risk assessment scan params and overall risk assessment results. The returned scanId should be used in GET /aml-risk/member-scans/{scanId} API method to obtain details of risk assessment information. |
None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Risk Check Update
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}',
{
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/v3/aml-risk/member-scans/{scanId}',
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/v3/aml-risk/member-scans/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}");
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/v3/aml-risk/member-scans/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/aml-risk/member-scans/{scanId}
Performs a member risk assessment recheck.
Individual Scan - Risk Assessment - Recheck/Rescan allows you to re-evaluate or update a member risk assessment by providing the necessary input parameters.
Body parameter
{
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The POST /aml-risk/member-scans API method response class returns this identifier in scanId. |
| body | body | RiskAssessmentUpdateParam | false | Risk assessment parameters, used to perform the risk assessment check for the member. |
Example responses
200 Response
{
"scanId": 0,
"riskAssessmentParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"riskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | RiskAssessmentScanResult |
| 201 | Created | RiskAssessmentScanResult: contains the risk assessment scan params and overall risk assessment results. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Risk Check Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/member-scans/{scanId}
Returns details of a specific member risk assessment.
Individual Scan - Scan History - Risk Assessment - Detail of Scan History returns the overall risk assessment results, risk assessment scan params.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /aml-risk/member-scans or POST /aml-risk/member-scans/{scanId} API method response class returns this identifier in scanId. |
| includeSupportingDocument | query | array[string] | false | Specifies whether to include the supporting document in the response. Refer to the supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| includeSupportingDocument | No |
| includeSupportingDocument | Yes |
Example responses
200 Response
{
"riskAssessmentParam": {
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"residentStatusId": 0,
"clientVisitId": 0,
"professionId": 0,
"subProfessionId": 0,
"sourceofFundsId": "string",
"nationalityCode": "string",
"domicileCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"isPEP": true,
"isSanctioned": true,
"hasAdverseMedia": true
},
"riskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"riskAssessmentServiceEnabled": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | RiskAssessmentHistoryDetail: details of the Scan Parameters used, risk assessment information which includes risk type, risk score. | RiskAssessmentHistoryDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Risk Check Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/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-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/member-scans/{scanId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/member-scans/{scanId}/report
Downloads report file of risk assessment information of a specific member.
Individual Scan - Scan History - Risk Assessment - Report Downloads report file of all available risk assessment information of a specific member including Category, Questions and Answers, Risk Type, Risk Score and Overall Risk Assessment result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single or POST /aml-risk/member-scans or POST /aml-risk/member-scans/{scanId} 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Risk-Check
Corporate/entity screening against risk assessment.
Corporate Risk Check List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/corp-scans
Returns the list of risk assessment details including questions and answers.
Corporate Scan - Risk Assessment provides a list of questions with their available options/answers and associated categories, used to perform a corporate risk assessment.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"id": "string",
"question": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"category": "string",
"controlType": "Text",
"isRequired": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of RiskAssessmentDetail; returns a list of risk assessment questions and answers. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [RiskAssessmentDetail] | false | none | [Represents a risk assessment detail, including its category, available options, control type, and required status.] |
| » id | string¦null | false | none | Unique identifier of the risk assessment question. |
| » question | string¦null | false | none | Provides risk assessment question. |
| » options | [RiskAssessmentOption]¦null | false | none | List of options associated with the risk assessment question. |
| »» value | string¦null | false | none | The value associated with risk assessment option. |
| »» label | string¦null | false | none | The label associated with risk assessment option. |
| » category | string¦null | false | none | Specifies the category of the risk assessment question. |
| » controlType | string¦null | false | none | Specifies the input control type for the question. |
| » isRequired | boolean | false | none | Indicates whether answering the question is mandatory. If true, the question must be answered; otherwise, it is optional. |
Enumerated Values
| Property | Value |
|---|---|
| controlType | Text |
| controlType | Radio |
| controlType | Select |
| controlType | MultiSelect |
New Corporate Risk Check
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans \
-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/v3/aml-risk/corp-scans HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"companyName": "Example Corporation Pty Ltd",
"clientId": "CORP-001",
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans',
{
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/v3/aml-risk/corp-scans',
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/v3/aml-risk/corp-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans");
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/v3/aml-risk/corp-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/aml-risk/corp-scans
Performs a corporate risk assessment check.
Corporate Scan - Risk Assessment - Scan New allows you to perform a corporate risk assessment check by submitting the required information in the provided fields.
Body parameter
{
"companyName": "Example Corporation Pty Ltd",
"clientId": "CORP-001",
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}
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 | CorpRiskAssessmentInputParam | false | Risk assessment parameters, used to perform the risk assessment check for the corporate. |
Example responses
200 Response
{
"scanId": 0,
"corpRiskAssessmentParam": {
"companyName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"corpRiskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CorpRiskAssessmentScanResult |
| 201 | Created | CorpRiskAssessmentScanResult: contains the risk assessment scan params and overall risk assessment results. The returned scanId should be used in GET /aml-risk/corp-scans/{scanId} API method to obtain details of risk assessment information. |
None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Risk Check Update
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}',
{
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/v3/aml-risk/corp-scans/{scanId}',
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/v3/aml-risk/corp-scans/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}");
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/v3/aml-risk/corp-scans/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/aml-risk/corp-scans/{scanId}
Performs a corporate risk assessment recheck.
Corporate Scan - Risk Assessment - Recheck/Rescan allows you to re-evaluate or update a corporate risk assessment by providing the necessary input parameters.
Body parameter
{
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single/{id} or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | CorpRiskAssessmentUpdateParam | false | Risk assessment parameters, used to perform the risk assessment check for the corporate. |
Example responses
200 Response
{
"scanId": 0,
"corpRiskAssessmentParam": {
"companyName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"corpRiskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | CorpRiskAssessmentScanResult |
| 201 | Created | CorpRiskAssessmentScanResult: contains the risk assessment scan params and overall risk assessment results. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Risk Check Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/corp-scans/{scanId}
Returns details of a specific corporate risk assessment.
Corporate Scan - Scan History - Risk Assessment - Detail of Scan History returns the overall risk assessment results, risk assessment scan params.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corp-scans/single or POST /aml-risk/corp-scans or POST /aml-risk/corp-scans/{scanId} API method response class returns this identifier in scanId. |
| includeSupportingDocument | query | array[string] | false | Specifies whether to include the supporting document in the response. Refer to the supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| includeSupportingDocument | No |
| includeSupportingDocument | Yes |
Example responses
200 Response
{
"corpRiskAssessmentParam": {
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"companyName": "string",
"clientId": "string",
"legalStatusId": 0,
"otherLegalStatus": "string",
"clientVisitId": 0,
"industryTypeId": 0,
"incorporationCountryCode": "string",
"highRiskCountriesCode": "string",
"fatfCountriesCode": "string",
"shareholderCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"hasPEP": true,
"isSanctioned": true,
"hasSanctions": true,
"hasAdverseMedia": true
},
"corpRiskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"riskAssessmentServiceEnabled": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CorpRiskAssessmentHistoryDetail: details of the Scan Parameters used, risk assessment information which includes risk type, risk score. | CorpRiskAssessmentHistoryDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Risk Check Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/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-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/aml-risk/corp-scans/{scanId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/aml-risk/corp-scans/{scanId}/report
Downloads report file of risk assessment information of a specific corporate.
Corporate Scan - Scan History - Risk Assessment - Report Downloads report file of all available risk assessment information of a specific corporate including Category, Questions and Answers, Risk Type, Risk Score and Overall Risk Assessment result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific corporate scan. The GET /corporate-scans/single or POST /aml-risk/corporate-scans or POST /aml-risk/corporate-scans/{scanId} 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Users
User management. Create, activate, deactivate users and manage API keys and profiles.
Users List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/users \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/users HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/users', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/users
Returns list of users.
Administration - User displays all users, for the organisations to which you are assigned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| username | query | string | false | All or part of username. |
| firstName | query | string | false | All or part of user first name. |
| lastName | query | string | false | All or part of user last name. |
| query | string | false | All or part of user email. | |
| orgId | query | string | false | User's organisation ID. |
| roleId | query | integer(int32) | false | User role id. |
| accessRightId | query | integer(int32) | false | User access right id. |
| isMfaActive | query | boolean | false | If MFA is activated for user. |
| status | query | string | false | User status. |
| fullResult | query | boolean | false | If true, returns full data result including email, lastLoginDate, lastActiveDate. Default is false. |
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
Example responses
200 Response
[
{
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of UserInfo; lists all the users that you have searched for. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [UserInfo] | false | none | none |
| » id | integer(int32) | false | none | The unique identifier for the user account. |
| » username | string¦null | false | none | The unique username for the user account. |
| » firstName | string¦null | false | none | The user's first name. |
| » lastName | string¦null | false | none | The user's last name. |
| » role | UserRole¦null | false | none | The role assigned to the user. |
| »» id | integer(int32) | false | none | none |
| »» name | string¦null | false | none | none |
| »» label | string¦null | false | none | none |
| »» accessRights | [UserAccessRight]¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» allow | boolean | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| » status | string¦null | false | none | The current status of the user account. |
| » creationDate | string(date-time)¦null | false | none | The date and time when the user account was created. |
| » lastLoginDate | string(date-time)¦null | false | none | The date and time of the user's last successful login. |
| » lastActiveDate | string(date-time)¦null | false | none | The date and time when the user was last active. |
| » dateTimeZone | string¦null | false | none | The preferred datetime timezone for the user. |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
New User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "j@exfund.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 1,
"allow": true
},
{
"id": 2,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users
Creates a new user.
Administration - User - Add User creates a new user.
Body parameter
{
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "j@exfund.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 1,
"allow": true
},
{
"id": 2,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | UserNewDetails | false | User information including user details, access rights and assigned organisations. |
Example responses
201 Response
0
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The user has been created and ID of newly created user returned. | integer |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
User Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/users/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/users/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/users/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/users/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/users/{id}
Returns details of a specific user.
Administration - User - User Details displays the user detail information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Example responses
200 Response
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | UserDetails; the user's detail. | UserDetails |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Update User
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/users/{id} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v3/users/{id} HTTP/1.1
Content-Type: application/json
const inputBody = '{
"apiKey": "API-KEY-123456789",
"mfaType": "Email",
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 0,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/users/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/users/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/users/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/users/{id}
Updates the information for the specified user.
Administration - User - Edit User updates a user information.
Body parameter
{
"apiKey": "API-KEY-123456789",
"mfaType": "Email",
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 0,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
| body | body | UserEditDetails | false | User information including user details, access rights and assigned organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Users Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/users/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/users/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/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-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/users/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/users/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/users/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/users/report
Downloads the report file (csv) of users.
Administration - User - Download CSV downloads the report file (csv) of users.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| username | query | string | false | All or part of username. |
| firstName | query | string | false | All or part of user first name. |
| lastName | query | string | false | All or part of user last name. |
| query | string | false | All or part of user email. | |
| orgId | query | string | false | User's organisation ID. |
| roleId | query | integer(int32) | false | User role id. |
| accessRightId | query | integer(int32) | false | User access right id. |
| isMfaActive | query | boolean | false | If MFA is activated for user. |
| status | query | string | false | User status. |
| sort | query | string | false | Return results sorted by this parameter. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
My Profile
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/users/myprofile \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/users/myprofile HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/myprofile',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/users/myprofile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/users/myprofile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/myprofile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/users/myprofile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/users/myprofile
Returns logon user profile detail.
Example responses
200 Response
{
"passwordExpiryDays": 0,
"agreementRequiredOrganisations": [
"string"
],
"acceptedAgreementFileName": "string",
"appLogo": "string",
"appLogoMini": "string",
"userRoles": [
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
],
"userStatuses": [
"Inactive"
],
"rights": [
"string"
],
"notifications": [
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
],
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | MyProfile; the logon user's profile detail. | MyProfile |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Update My Profile
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/users/myprofile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
PUT https://demo.api.membercheck.com/api/v3/users/myprofile HTTP/1.1
Content-Type: application/json
const inputBody = '{
"currentPassword": "Current@Password123",
"newPassword": "NewSecure@Password123",
"mfaType": "Disabled",
"mfaVerificationCode": ""
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/myprofile',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/users/myprofile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/users/myprofile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/myprofile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/users/myprofile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/users/myprofile
Updates logon user security details.
User profile updates logon user security details.
Body parameter
{
"currentPassword": "Current@Password123",
"newPassword": "NewSecure@Password123",
"mfaType": "Disabled",
"mfaVerificationCode": ""
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | MyProfileSecurity | false | Logon user security information including password details and MFA details. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Update My Profile MFA
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/myprofile/reset-mfa", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/myprofile/reset-mfa
Initiates MFA token for logon user.
User Profile Email: A verification code will be sent to logon user email. VirtualMfaDevice: Virtual authenticator token will be returned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| mfaType | query | string | false | New MFA type for logon user to be set. |
Enumerated Values
| Parameter | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
Example responses
200 Response
{
"tokenExpiry": 0,
"manualEntryKey": "string",
"qrCodeSetupImageUrl": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Logon user MFA token initiated. | MyProfileMfaSetupCode |
| 204 | No Content | Indicates success but nothing is in the response body (when mfaType value is Disabled). | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Reset User Password
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/{id}/reset-password \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/{id}/reset-password HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}/reset-password',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/{id}/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/{id}/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}/reset-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/{id}/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/{id}/reset-password
Resets password for the specified user.
Administration - User - Reset Passord resets password for a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Activate User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/{id}/activate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/{id}/activate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}/activate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/{id}/activate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/{id}/activate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/{id}/activate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/{id}/activate
Activates the specified user.
Administration - User - Activate User enables a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Deactivate User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/{id}/deactivate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/{id}/deactivate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}/deactivate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/{id}/deactivate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/{id}/deactivate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}/deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/{id}/deactivate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/{id}/deactivate
Deactivates the specified user.
Administration - User - Deactivate User disables a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Unlock User
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/{id}/unlock \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/{id}/unlock HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}/unlock',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/{id}/unlock',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/{id}/unlock', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}/unlock");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/{id}/unlock", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/{id}/unlock
Unlocks the specified user.
Administration - User - Unlock User unlocks a user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Reset API Key
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/users/{id}/reset-api-key", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/users/{id}/reset-api-key
Generates a new API access key for the specified user.
Administration - User - Reset API Access Key generates a new API access key for the specified user. It is valid for only 10 minutes. To apply this new key for the specified user, you must call for PUT /users/{id}.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The identifier of a specific user. |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | string |
| 202 | Accepted | New API access key. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Organisations
Organisation administration, scan settings, list access, custom watchlist management, webhook connectivity.
Organisations List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations
Returns list of organisations.
Administration - Organisation Displays all organisations to which the user account with the API Key is assigned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
Example responses
200 Response
[
{
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"isResellerCO": true,
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "user@example.com",
"creationDate": "2019-08-24T14:15:22Z",
"dataSources": "MemberCheck",
"isDataSourceEditable": true,
"isIdvActive": true,
"isFaceMatchActive": true,
"isIDCheckActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"isWatchlistActive": true,
"isRiskAssessmentActive": true,
"riskAssessmentEnabled": "UserDefined",
"isBatchAMSActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgInfo; lists all the organisations that you have searched for. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgInfo] | false | none | none |
| » name | string¦null | false | none | none |
| » displayName | string¦null | false | none | none |
| » parentOrg | OrgInfo0¦null | false | none | none |
| »» id | string¦null | false | none | none |
| »» fullPath | string¦null | false | none | none |
| »» isReseller | boolean¦null | false | none | none |
| » isResellerCO | boolean¦null | false | none | none |
| » country | OrgCountry¦null | false | none | none |
| »» timeZoneId | string¦null | false | none | none |
| »» name | string¦null | false | none | none |
| »» code | string¦null | false | Length: 0 - 5 | none |
| »» nationality | string¦null | false | none | none |
| » complianceOfficers | [OrgUser]¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» firstName | string¦null | false | none | none |
| »» lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| »» username | string¦null | false | none | none |
| »» role | UserRole¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» label | string¦null | false | none | none |
| »»» accessRights | [UserAccessRight]¦null | false | none | none |
| »»»» id | integer(int32) | false | none | none |
| »»»» name | string¦null | false | none | none |
| »»»» allow | boolean | false | none | none |
| »» status | string¦null | false | none | none |
| »» singleOrgAssigned | boolean¦null | false | none | none |
| » accountManager | OrgUser¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» firstName | string¦null | false | none | none |
| »» lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| »» username | string¦null | false | none | none |
| »» role | UserRole¦null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» name | string¦null | false | none | none |
| »»» label | string¦null | false | none | none |
| »»» accessRights | [UserAccessRight]¦null | false | none | none |
| »» status | string¦null | false | none | none |
| »» singleOrgAssigned | boolean¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| » creationDate | string(date-time)¦null | false | none | none |
| » dataSources | string¦null | false | none | none |
| » isDataSourceEditable | boolean¦null | false | none | none |
| » isIdvActive | boolean¦null | false | none | none |
| » isFaceMatchActive | boolean¦null | false | none | none |
| » isIDCheckActive | boolean¦null | false | none | none |
| » isMonitoringActive | boolean¦null | false | none | none |
| » isApiActive | boolean¦null | false | none | none |
| » status | string¦null | false | none | none |
| » isAIAnalysisActive | boolean¦null | false | none | none |
| » isKybActive | boolean¦null | false | none | none |
| » isWatchlistActive | boolean¦null | false | none | none |
| » isRiskAssessmentActive | boolean¦null | false | none | none |
| » riskAssessmentEnabled | string¦null | false | none | none |
| » isBatchAMSActive | boolean¦null | false | none | none |
| » id | string¦null | false | none | none |
| » fullPath | string¦null | false | none | none |
| » isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| status | Inactive |
| status | Active |
| status | Deleted |
| riskAssessmentEnabled | UserDefined |
| riskAssessmentEnabled | No |
| riskAssessmentEnabled | Yes |
Organisation Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/{id} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/{id}
Returns details of a specific organisation.
Administration - Organisation - Organisation Details displays the organisation detail information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Example responses
200 Response
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"enableEmailNotification": true,
"scanEmailsSendToCO": true,
"emailNotificationAddress": "string",
"webhookNotification": {
"enable": true,
"url": "string",
"service": "None",
"channelName": "string"
},
"emailPreferences": "None",
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "DD/MM/YYYY",
"renewalDate": "string",
"terminationDate": "DD/MM/YYYY"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"DOB": "No",
"Gender": "No",
"IDNumber": "No",
"Nationality": "No"
}
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true,
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"RegistrationNumber": "No"
}
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankNationalityActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"defaultCountry": {
"name": "string",
"code": "strin",
"nationality": "string"
},
"idVerificationProcess": "StepByStep",
"idvCountriesType": "All",
"subscriberCodes": [
{
"code": "string"
}
],
"idvDataSource": "AuGovtVerification",
"idvCountries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"idvAssuranceLevel": "SingleSource"
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0,
"isCustomList": true
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"isResellerCO": true,
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "user@example.com",
"creationDate": "2019-08-24T14:15:22Z",
"dataSources": "MemberCheck",
"isDataSourceEditable": true,
"isIdvActive": true,
"isFaceMatchActive": true,
"isIDCheckActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"isWatchlistActive": true,
"isRiskAssessmentActive": true,
"riskAssessmentEnabled": "UserDefined",
"isBatchAMSActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OrgDetails; the organisation's detail. | OrgDetails |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Organisation Scan Settings
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations/{id}/scan-settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/{id}/scan-settings
Returns brief details of a specific organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Example responses
200 Response
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"enableEmailNotification": true,
"scanEmailsSendToCO": true,
"emailNotificationAddress": "string",
"webhookNotification": {
"enable": true,
"url": "string",
"service": "None",
"channelName": "string"
},
"emailPreferences": "None",
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "DD/MM/YYYY",
"renewalDate": "string",
"terminationDate": "DD/MM/YYYY"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"DOB": "No",
"Gender": "No",
"IDNumber": "No",
"Nationality": "No"
}
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true,
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"RegistrationNumber": "No"
}
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankNationalityActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"defaultCountry": {
"name": "string",
"code": "strin",
"nationality": "string"
},
"idVerificationProcess": "StepByStep",
"idvCountriesType": "All",
"subscriberCodes": [
{
"code": "string"
}
],
"idvDataSource": "AuGovtVerification",
"idvCountries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"idvAssuranceLevel": "SingleSource"
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0,
"isCustomList": true
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"isResellerCO": true,
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "user@example.com",
"creationDate": "2019-08-24T14:15:22Z",
"dataSources": "MemberCheck",
"isDataSourceEditable": true,
"isIdvActive": true,
"isFaceMatchActive": true,
"isIDCheckActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"isWatchlistActive": true,
"isRiskAssessmentActive": true,
"riskAssessmentEnabled": "UserDefined",
"isBatchAMSActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OrgDetails; the organisation's brief detail. | OrgDetails |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Activate Organisation
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/organisations/{id}/activate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/organisations/{id}/activate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/activate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/organisations/{id}/activate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/organisations/{id}/activate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/activate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/organisations/{id}/activate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/organisations/{id}/activate
Activates the specified organisation.
Administration - Organisation - Activate Organisation enables an organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Deactivate Organisation
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/organisations/{id}/deactivate", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/organisations/{id}/deactivate
Deactivates the specified organisation.
Administration - Organisation - Deactivate Organisation disables an organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
| reasonForDeactivation | query | string | false | The reason for deactivation of specified organisation. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Organisation List Accesses
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/allListAccesses \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/allListAccesses HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/allListAccesses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations/allListAccesses',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations/allListAccesses', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/allListAccesses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations/allListAccesses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/allListAccesses
Returns all List Accesses.
Administration - Organisation Organisation Detail - List Access.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{}
]
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgListAccess; returns all available List Access for data sources. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgListAccess] | false | none | none |
| » id | integer(int32) | false | none | none |
| » name | string¦null | false | none | none |
| » subLists | [OrgSubList]¦null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» name | string¦null | false | none | none |
| »» description | string¦null | false | none | none |
| »» subLists | [OrgSubList]¦null | false | none | none |
Organisation Countries
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/countries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/countries HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/countries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/countries
Returns list of organisation's countries.
Administration - Organisation Organisation List search - Country list.
Example responses
200 Response
[
{
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgCountry; lists countries of all organisations. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgCountry] | false | none | none |
| » timeZoneId | string¦null | false | none | none |
| » name | string¦null | false | none | none |
| » code | string¦null | false | Length: 0 - 5 | none |
| » nationality | string¦null | false | none | none |
New Organisation Custom Watchlists
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"fileType": "Individual",
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/organisations/{id}/custom-list
Uploads a custom list file for an organisation.
Administration - Organisation Organisation Detail - List Access.
Body parameter
fileType: Individual
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
| body | body | object | false | none |
| » fileType | body | string | false | The file type. See supported values below. |
| » File | body | string(binary) | false | Custom watchlist CSV file (ZIP compression of CSV format is also acceptable) containing profiles. |
Enumerated Values
| Parameter | Value |
|---|---|
| » fileType | Individual |
| » fileType | Corporate |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | string |
| 201 | Created | The file has been uploaded and ID of newly uploaded file returned. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Organisation Custom Watchlists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId} \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/organisations/{id}/custom-list/{fileId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/{id}/custom-list/{fileId}
Downloads the custom list file.
Administration - Organisation Organisation Detail - List Access.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
| fileId | path | string | true | The identifier of a specific custom list file. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Organisation Source Lists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/organisations/{id}/source-lists \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/organisations/{id}/source-lists HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/organisations/{id}/source-lists',
{
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/v3/organisations/{id}/source-lists',
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/v3/organisations/{id}/source-lists', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/organisations/{id}/source-lists");
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/v3/organisations/{id}/source-lists", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/organisations/{id}/source-lists
Access to the supporting documents for the organisation.
Administration - Organisation Organisation Detail - List Access.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | The identifier of a specific organisation. |
Example responses
200 Response
[
{
"name": "string",
"description": "string",
"url": "string",
"dataSource": "None",
"visible": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MbrChk.Common.SourceListDocument] | false | none | none |
| » name | string¦null | false | none | none |
| » description | string¦null | false | none | none |
| » url | string¦null | false | none | none |
| » dataSource | string¦null | false | none | none |
| » visible | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dataSource | None |
| dataSource | DowJones |
| dataSource | ThomsonReuters |
| dataSource | MemberCheck |
| dataSource | Acuris |
| dataSource | LexisNexis |
| dataSource | CustomList |
Account
User account password recovery and reset.
Reset Password Token
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/account/reset-password \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v3/account/reset-password HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/account/reset-password',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/account/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/account/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/account/reset-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/account/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/account/reset-password
Returns reset password token validity.
Checks reset password token validity and returns token type.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| token | query | string | false | none |
Example responses
200 Response
{
"tokenExpired": true,
"isNewAccountPassword": true,
"passwordHistoryLimit": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | AccountResetPasswordTokenInfo: contains reset password token information. | AccountResetPasswordTokenInfo |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Reset Password
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/account/reset-password \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v3/account/reset-password HTTP/1.1
Content-Type: application/json
const inputBody = '{
"token": "string",
"newPassword": "Str0ng!P@ss"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/account/reset-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/account/reset-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/account/reset-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/account/reset-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/account/reset-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/account/reset-password
Sets account new password.
Sets new password for specified account by token.
Body parameter
{
"token": "string",
"newPassword": "Str0ng!P@ss"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountResetPasswordData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Forgot Username
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/account/forgot-username \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v3/account/forgot-username HTTP/1.1
Content-Type: application/json
const inputBody = '{
"email": "user@example.com",
"recaptchaResponse": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/account/forgot-username',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/account/forgot-username',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/account/forgot-username', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/account/forgot-username");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/account/forgot-username", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/account/forgot-username
Sends username reminder to registered email address.
Triggers a username-reminder email to the address registered for the account. To prevent enumeration of registered accounts, the response is 204 whether or not the address is registered.
Body parameter
{
"email": "user@example.com",
"recaptchaResponse": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountForgotUsernameData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Forgot Password
Code samples
# You can also use wget
curl -X PUT https://demo.api.membercheck.com/api/v3/account/forgot-password \
-H 'Content-Type: application/json'
PUT https://demo.api.membercheck.com/api/v3/account/forgot-password HTTP/1.1
Content-Type: application/json
const inputBody = '{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}';
const headers = {
'Content-Type':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/account/forgot-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json'
}
result = RestClient.put 'https://demo.api.membercheck.com/api/v3/account/forgot-password',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json'
}
r = requests.put('https://demo.api.membercheck.com/api/v3/account/forgot-password', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/account/forgot-password");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "https://demo.api.membercheck.com/api/v3/account/forgot-password", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /api/v3/account/forgot-password
Resets password.
Resets user password and a link to reset password will be sent to registered email address.
Body parameter
{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountForgotPasswordData | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Data Management
Data lifecycle management. View, export, and bulk-delete scan data and supporting documents.
Member Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/data-management/member-batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/member-batch-scans
Returns member batch scan history.
Administration - Data Mgmt Data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"ignoreBlankPolicy": "DOB"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of BatchScanHistoryLog; lists all member batch files of current organisation. The returned batchScanId could be used in DELETE /data-management/batch-scans/ API method. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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. |
| » matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » residence | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| » excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| » dobTolerance | integer(int32)¦null | false | none | DOB Tolerance used for scan. |
| » ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
Corporate Batch Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/data-management/corp-batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/corp-batch-scans
Returns corporate batch scan history.
Administration - Data Mgmt Data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| sort | query | string | false | Return results sorted by this parameter. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"ignoreBlankPolicy": "RegistrationNumber"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpBatchScanHistoryLog; lists all corporate batch files of current organisation. The returned batchScanId could be used in DELETE /data-management/batch-scans/ API method. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CorpBatchScanHistoryLog] | false | none | [Represents details of the batch files, which have been uploaded and scanned.] |
| » batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| » date | string(date-time) | false | none | Date and time of the upload. |
| » fileName | string¦null | false | none | File name of the batch file. |
| » companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| » matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| » numberOfMatches | integer(int32) | false | none | Total number of matches. |
| » status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| » statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
| » matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| » closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| » whitelist | string¦null | false | none | Whitelist policy scanned. |
| » addressPolicy | string¦null | false | none | Address policy scanned. |
| » blankAddress | string¦null | false | none | Blank address policy scanned. |
| » ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| ignoreBlankPolicy | RegistrationNumber |
Member Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/member-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/member-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/member-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/data-management/member-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/data-management/member-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/member-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/data-management/member-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/member-scans
Returns member scan history.
Administration - Data Mgmt Data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| clientId | query | string | false | Full Client ID. |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| includeSupportingDocument | query | boolean | false | none |
| 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 |
| scanService | RiskAssessment |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"scanService": "PepAndSanction",
"idvStatus": "NotVerified",
"idvFaceMatchStatus": "Pass",
"supportingDocumentNames": [
"string"
],
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of ScanHistoryLog; lists all PEP & Sanctions and IDV member single scans of current organisation. The returned scanId could be used in DELETE /data-management/single-scans/ API method. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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¦null | 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. |
| » supportingDocumentNames | [string]¦null | false | none | List of supporting document names of a specific scan. |
| » 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. |
| » 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). |
| » amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
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 |
| scanService | RiskAssessment |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
Corporate Single Scans History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/corp-scans \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/corp-scans HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/corp-scans',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/data-management/corp-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/data-management/corp-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/corp-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/data-management/corp-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/corp-scans
Returns corporate scan history.
Administration - Data Mgmt Data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. See supported values below. |
| scanResult | query | array[string] | false | Scan Result Matched or Not Matched. |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| includeSupportingDocument | query | boolean | false | none |
| 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 |
| scanService | RiskAssessment |
| scanResult | NoMatchesFound |
| scanResult | MatchesFound |
Example responses
200 Response
[
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"kybProductsCount": 0,
"kybCompanyProfileCount": 0,
"isPaS": true,
"isKYB": true,
"isRiskAssessment": true,
"scanService": "PepAndSanction",
"supportingDocumentNames": [
"string"
],
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of CorpScanHistoryLog; lists all Sanctions corporate single scans of current organisation. The returned scanId could be used in DELETE /data-management/single-scans/ API method. |
Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | 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¦null | false | none | Scan type. See supported values below. |
| » matchType | string¦null | false | none | Match type scanned. See supported values below. |
| » whitelist | string¦null | 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. |
| » isRiskAssessment | boolean¦null | false | none | Identifies that Risk Assessment is performed or not. |
| » scanService | string¦null | false | none | Type of service for scan. |
| » supportingDocumentNames | [string]¦null | false | none | List of supporting document names associated with a specific 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. |
| » registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| » 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). |
| » amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| scanService | RiskAssessment |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
Delete Batches
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/data-management/batch-scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/data-management/batch-scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/batch-scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/data-management/batch-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/data-management/batch-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/batch-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/data-management/batch-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/data-management/batch-scans
Delete PEP and Sanctions batches.
Administration - Data Mgmt Deletes data from selected PEP & Sanctions batches.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| batchIds | query | string | false | ID of the selected batch files to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Scans Count
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/scans/count \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/scans/count HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/scans/count',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/data-management/scans/count',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/data-management/scans/count', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/scans/count");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/data-management/scans/count", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/scans/count
Returns scans count.
Administration - Data Mgmt
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanType | query | string | false | Scan Type. See supported values below. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Idv |
| scanType | Kyb |
| scanType | NoMatchFound |
| scanType | All |
| scanType | AllWithMonitoring |
| scanType | SupportingDocument |
| scanType | Rac |
Example responses
200 Response
0
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Indicates success but nothing is in the response body. | integer |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Scans
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/data-management/scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/data-management/scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/data-management/scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/data-management/scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/data-management/scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/data-management/scans
Delete Scans
Administration - Data Mgmt Deletes data in the specific organisation account. Idv - ID Verification scan data only; Kyb - KYB scan data only; NoMatchFound - All PEP and Sanctions scan data where No Matches were found (applies to Single and Batch Scans); All - All Single Scan, Batch Scan and whitelist data; AllWithMonitoring - All Single Scan, Batch Scan, whitelist and Monitoring List data.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanType | query | string | false | Scan Type. See supported values below. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| scanType | Idv |
| scanType | Kyb |
| scanType | NoMatchFound |
| scanType | All |
| scanType | AllWithMonitoring |
| scanType | SupportingDocument |
| scanType | Rac |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Single Scans
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/data-management/single-scans \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/data-management/single-scans HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/single-scans',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/data-management/single-scans',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/data-management/single-scans', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/single-scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/data-management/single-scans", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/data-management/single-scans
Delete PEP & Sanctions, Know Your Business (KYB) and IDV single scans.
Administration - Data Mgmt Deletes data from selected PEP & Sanctions, Know Your Business (KYB) and IDV single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanIds | query | string | false | ID of the selected scans to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/member-documents \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/member-documents 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/v3/data-management/member-documents',
{
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/v3/data-management/member-documents',
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/v3/data-management/member-documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/member-documents");
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/v3/data-management/member-documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/member-documents
Returns Supporting Documents associated with member scans.
Administration - Data Mgmt Supporting Documents data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| fileName | query | string | false | Document Name |
| userId | query | integer(int32) | false | Scan user id |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. 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 |
| scanService | RiskAssessment |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a presigned URL as a string that can be used to access the document. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
Corporate Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/data-management/corp-documents \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/data-management/corp-documents 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/v3/data-management/corp-documents',
{
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/v3/data-management/corp-documents',
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/v3/data-management/corp-documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/corp-documents");
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/v3/data-management/corp-documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/data-management/corp-documents
Returns Supporting Documents associated with corporate scans.
Administration - Data Mgmt Supporting Documents data from selected single scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| fileName | query | string | false | Document Name |
| userId | query | integer(int32) | false | Scan user id |
| scanType | query | array[string] | false | Scan Type. See supported values below. |
| scanService | query | array[string] | false | Scan Service type. 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 | KYB |
| scanService | RiskAssessment |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns a presigned URL as a string that can be used to access the document. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
Delete Scans Supporting Documents
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/data-management/single-scans/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/data-management/single-scans/documents
Delete Supporting Documents of selected scans.
Administration - Data Mgmt Deletes Supporting Documents associated with selected scans.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanIds | query | string | false | IDs of the selected scans whose associated supporting documents are to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Supporting Documents
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/data-management/documents \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/data-management/documents HTTP/1.1
X-Request-OrgId: string
const headers = {
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/data-management/documents',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/data-management/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/data-management/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/data-management/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/data-management/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/data-management/documents
Delete Selected Supporting Documents.
Administration - Data Mgmt Deletes Selected Supporting Documents.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| documentIds | query | string | false | IDs of the selected supporting documents to be deleted. It could be a single integer value or comma-separated of integer values. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
ID Verification
Identity verification. Document checks, biometric face matching, SMS and email verification.
ID Verification Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}
Returns result of a specific ID Verification scan.
Individual Scan - Scan Results - Detail of Scan History returns details of the IDV Parameters and verification result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| includeSupportingDocument | query | array[string] | false | Specifies whether to include the supporting document in the response. Refer to the supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| includeSupportingDocument | No |
| includeSupportingDocument | Yes |
Example responses
200 Response
{
"idvParam": {
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"birthDate": "15/03/1980",
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"clientId": "CLIENT-001",
"includeRiskAssessment": "No",
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "SUB-001",
"parentOrigin": "https://example.com"
},
"idvResult": {
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "user@example.com",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z",
"idvVerificationResult": {
"driverLicenceResult": {
"requestParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"passportResult": {
"requestParam": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"medicareResult": {
"requestParam": {
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"nationalIDResult": [
{
"transactionId": "string",
"reliability": "NotVerified",
"reliabilityCode": "string",
"errorMessage": "string",
"message": "string",
"nationalIdType": "string",
"country": "string",
"verificationResult": [
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "[",
"dataSource": "string",
"message": "string"
}
]
}
]
}
],
"idCheckCompletionTime": "2019-08-24T14:15:22Z",
"idVerificationSources": [
{
"code": "string",
"dataSource": "string"
}
]
},
"faceMatchVerificationResult": {
"processingTime": 0,
"transactionId": "string",
"statusDetails": {
"overallStatus": "ERROR",
"optical": "ERROR",
"rfid": "ERROR",
"detailsOptical": {
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
},
"portrait": "ERROR",
"stopList": "ERROR"
},
"graphicFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"fieldList": [
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": null,
"containerType": null,
"source": null,
"lightIndex": null,
"fieldRect": null,
"originalPageIndex": null,
"pageIndex": null
}
]
}
]
},
"textFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"comparisonStatus": "ERROR",
"dateFormat": "string",
"fieldList": [
{
"comparisonList": [
{
"sourceLeft": null,
"sourceRight": null,
"status": null
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": null,
"status": null
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": null,
"fieldRect": null,
"originalSymbols": null,
"originalValidity": null,
"pageIndex": null,
"probability": null,
"source": null,
"status": null,
"value": null
}
]
}
],
"status": "ERROR",
"validityStatus": "ERROR"
},
"documentTypeDetails": [
{
"authenticityNecessaryLights": 0,
"checkAuthenticity": 0,
"documentName": "string",
"fdsidList": {
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
},
"id": 0,
"necessaryLights": 0,
"oviExp": 0,
"p": 0,
"rfiD_Presence": 0,
"rotated180": true,
"uvExp": 0,
"pageIdx": 0
}
],
"imageQualityDetails": [
{
"count": 0,
"list": [
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
],
"result": "ERROR",
"pageIdx": 0
}
],
"portraitComparison": {
"code": "FACER_OK",
"detections": [
{
"faces": [
{
"faceIndex": null,
"rotationAngle": null,
"crop": null
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
],
"results": [
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
]
},
"securityChecks": [
{
"count": 0,
"list": [
{
"count": 0,
"list": [
{
"elementType": "[",
"elementResult": "[",
"elementDiagnose": "[",
"image": null,
"etalonImage": null,
"percentValue": 0,
"lightIndex": "[",
"sourceImage": null,
"resultImages": null
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
],
"pageIdx": 0
}
],
"livenessDetectionResult": {
"livenessDetectionStatus": 0,
"estimatedAge": 0,
"livenessDetectionTransactionId": "string",
"isLivenessVideoPresent": true
},
"originalImages": [
{
"pageIdx": 0,
"image": "string"
}
],
"faceMatchCompletionTime": "2019-08-24T14:15:22Z"
}
},
"idvFaceMatchStatus": "Pass",
"signatureKey": "string",
"idvUrl": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"idvStatus": "NotVerified",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | IDVHistoryDetail: contains verification result of specified IDV scan. | IDVHistoryDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
ID Verification Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/report
Downloads report file of ID Verification result.
Individual Scan - Scan Results - ID Verification - Report Downloads report file of ID Verification result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| isSingleScanReport | query | boolean | false | Indicates that request come from single scan or scan result report. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
New ID Verification
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/id-verification/single \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/id-verification/single HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"birthDate": "15/03/1980",
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"clientId": "CLIENT-001",
"includeRiskAssessment": "No",
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "SUB-001",
"parentOrigin": "https://example.com"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/id-verification/single',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/id-verification/single', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/id-verification/single", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/id-verification/single
Performs new ID Verification. Returns a verification URL.
Individual Scan - Single Scan - ID Verification allows you to run ID Verification for an individual. Enter required details of the individual including name. Specify the type of verification (document verification, biometric facial-matching, or both), and the mechanism for verification (SMS or Email).
Body parameter
{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"birthDate": "15/03/1980",
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"clientId": "CLIENT-001",
"includeRiskAssessment": "No",
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "SUB-001",
"parentOrigin": "https://example.com"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | IDVInputParam | false | Provide information of the individual, including name, date and birth and the country for source of verification. To send an email with the verification link for the individual to complete, enter an email address. To SMS the verification link, enter a mobile number. |
Example responses
201 Response
{
"scanId": 0,
"idvUrl": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A successful ID Verification request will return a unique identifier to be used as the scanId in GET /id-verification/single/{scanId} to obtain details of the verification result. |
IDVResponse |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/status
To check whether IDV Status is completed or not.
Notifies whether IDV Status is completed or not.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of ID Verification scan. |
Example responses
200 Response
true
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Boolean type | boolean |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
IDV File URL
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/file-url", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/file-url
Returns presigned URL of original file.
Individual Scan - Scan Results - ID Verification - Video URL Returns the URL of the biometric facial-matching video, if available.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of ID Verification scan. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | String type. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
IDV Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents',
{
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/v3/id-verification/single/{scanId}/documents',
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/v3/id-verification/single/{scanId}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents");
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/v3/id-verification/single/{scanId}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/documents
Returns supporting documents of a specific ID Verification scan.
Individual Scan - ID Verification - Supporting Documents provides all supporting documents of a specific ID Verification scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentResult; lists of the supporting documents for a ID Verification scan selected in the scan results or scan history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
New IDV Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"Documents": [
{
"file": "string",
"comment": "string",
"documentTypeId": 0
}
],
"IsOverwrite": true,
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/id-verification/single/{scanId}/documents
Upload supporting documents for a specific ID Verification scan.
Individual Scan - ID Verification - Supporting Documents - Upload Documents allows to upload supporting documents for a specific ID Verification scan. Supported File Types: PDF, JPG, JPEG, PNG, GIF, TIF, TIFF, ZIP
Body parameter
Documents:
- file: string
comment: string
documentTypeId: 0
IsOverwrite: true
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| body | body | object | false | none |
| » Documents | body | [SupportingDocumentFile] | false | A list of supporting documents, including files, comments, and document types. |
| »» file | body | string(binary) | true | The uploaded supporting document file. |
| »» comment | body | string¦null | false | Comments associated with the supporting document. |
| »» documentTypeId | body | integer(int32) | false | The identifier of the selected document type for the supporting document. |
| » IsOverwrite | body | boolean | false | Indicates whether an existing supporting document should be overwritten (true if overwrite is enabled). |
| » File | body | string(binary) | false | Supporting document files to be uploaded. |
Example responses
201 Response
{
"uploadedFileResult": [
{
"fileName": "string",
"supportingDocumentId": 0
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | SupportingDocumentResponse; contains information of uploaded supporting documents. | SupportingDocumentResponse |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Pin IDV Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/pin \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/pin HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/pin',
{
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/v3/id-verification/single/{scanId}/documents/{documentId}/pin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/pin', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/pin");
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/v3/id-verification/single/{scanId}/documents/{documentId}/pin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/id-verification/single/{scanId}/documents/{documentId}/pin
Toggles the pin status of a specific supporting document.
Individual Scan - ID Verification - Supporting Documents - Pin/Unpin Document allows you to pin or unpin supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /id-verification/single/{id}/documents or POST /id-verification/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Download IDV Scan Supporting Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/download \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/download HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/download',
{
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/v3/id-verification/single/{scanId}/documents/{documentId}/download',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/download', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}/download");
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/v3/id-verification/single/{scanId}/documents/{documentId}/download", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/documents/{documentId}/download
Downloads a specific supporting document.
Individual Scan - ID Verification - Supporting Documents - Download Document allows you to download a specific supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /id-verification/single/{id}/documents or POST /id-verification/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the file content for the requested document. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete IDV Scan Supporting Document
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/{documentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/id-verification/single/{scanId}/documents/{documentId}
Deletes a specific supporting document.
Individual Scan - ID Verification - Supporting Documents - Delete Document allows you to delete a specific supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /id-verification/single/{id}/documents or POST /id-verification/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
IDV Scan Supporting Documents History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/history \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/history HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/history',
{
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/v3/id-verification/single/{scanId}/documents/history',
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/v3/id-verification/single/{scanId}/documents/history', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/{scanId}/documents/history");
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/v3/id-verification/single/{scanId}/documents/history", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/{scanId}/documents/history
Returns the supporting document history of a specific ID Verification scan.
Individual Scan - ID Verification - Supporting Documents - Documents History provides a history of all uploaded, overwritten, downloded and deleted supporting documents.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific member scan. The GET /member-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"fileName": "string",
"date": "2019-08-24T14:15:22Z",
"uploadedBy": "string",
"action": "Uploaded"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentHistoryResult, lists the supporting document history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentHistoryResult] | false | none | [Represents the history of actions performed on a supporting document.] |
| » fileName | string¦null | false | none | The name of the supporting document. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » action | string¦null | false | none | The action performed on the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| action | Uploaded |
| action | Downloaded |
| action | Overwritten |
| action | Deleted |
Sms Enabled Country
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/id-verification/single/sms-enabled-countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/id-verification/single/sms-enabled-countries
Returns the list of supported countries with an indication of whether SMS-based identity verification is enabled for each.
Individual Scan - ID Verification - SMS-Enabled Countries Returns the list of supported countries with an indication of whether SMS-based identity verification is enabled for each.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
{
"countries": [
{
"countryCode": "string",
"isSmsServiceEnabled": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An array of IDVSMSEnabledCountry listing supported countries and their SMS-based identity verification status. | EVerification.IDVSMSEnabledCountriesDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Business Ubo-Check
Know Your Business (KYB) and Ultimate Beneficial Ownership (UBO) verification.
Country List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/countries \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/countries HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/countries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/countries
Returns the list of countries.
Corporate Scan - Scan New - Know Your Business - Countries provides a list of countries available to perform a Know Your Business (KYB) scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"code": "string",
"name": "string",
"hasStates": true,
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true,
"serviceAvailable": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of KYBCountryResult; lists the countries supported for the Know Your Business scans. Some countries contain State jurisdictions, and if the business Registration Number is supported for the Country. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBCountryResult] | false | none | [KYB Country information elements.] |
| » code | string¦null | false | none | The ISO 3166 2-letter country code. |
| » name | string¦null | false | none | Name of the country. |
| » hasStates | boolean | false | none | Indicates whether the country has registry subdivisions such as states or provinces. |
| » supportsRegistrationNumber | boolean | false | none | Denotes whether the country registry supports searching by business registration number. |
| » companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| » productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
| » serviceAvailable | boolean | false | none | Indicates whether the document products or enhanced profile service are available for the country. |
Country-State List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/countries/{countryCode}/states", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/countries/{countryCode}/states
Returns the registry subdivisions (states/provinces) for a country.
Corporate Scan - Scan New - Know Your Business - Country States. Returns the list of registry subdivisions — states or provinces, depending on the country — for the given country code. Where a country has subdivisions, callers must use the subdivision code (not the country code) when performing a Know Your Business scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| countryCode | path | string | true | The code of country. The GET /kyb/countries API method response class returns this identifier in CountryCode. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"code": "string",
"name": "string",
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true,
"serviceAvailable": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of KYBStateResult; lists the States for the specified country and if the business Registration Number is supported for the State. | Inline |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBStateResult] | false | none | [Lists the KYB state results.] |
| » code | string¦null | false | none | The code for the registry subdivision. This is a combination of the ISO 3166 country and state codes. |
| » name | string¦null | false | none | Name of the subdivision (state or province). |
| » supportsRegistrationNumber | boolean | false | none | Denotes whether the subdivision registry supports searching by business Registration Number. |
| » companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the state. |
| » productAvailable | boolean | false | none | Indicates whether the document products are available in the state. |
| » serviceAvailable | boolean | false | none | Indicates whether the document products or enhanced profile service are available for the state. |
Company List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/company \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/company HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string
const inputBody = '{
"countryCode": "AU",
"companyName": "Example Corporation Pty Ltd",
"registrationNumber": "",
"clientId": "CLIENT-001",
"allowDuplicateKYBScan": false,
"includeRiskAssessment": "No"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/company',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/kyb/company',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/company', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/kyb/company", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/company
Searches for a company in a country or state registry (Know Your Business — step 1).
Corporate Scan - Scan New - Know Your Business - Company Search. First step of a Know Your Business search. Searches the registry of the specified country (or state, where applicable) by company name or business registration number, and returns high-level information and a company code for each match. Use the returned company code with POST /kyb/{scanId}/company/profile to query the full profile.
Body parameter
{
"countryCode": "AU",
"companyName": "Example Corporation Pty Ltd",
"registrationNumber": "",
"clientId": "CLIENT-001",
"allowDuplicateKYBScan": false,
"includeRiskAssessment": "No"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | KYBCompanyInputParam | false | Search parameters, which include Country ISO Code, ClientID, Company Name or Company Business Number. |
Example responses
201 Response
{
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBScanResult; contains brief information of matched companies. The returned scanId should be used in GET /kyb/{scanId} API method to obtain details of this scan. |
KYBScanResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Company UBO
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/{scanId}/company/profile
Performs an enhanced-company profile search for ultimate beneficial ownership (UBO).
Corporate Scan - Scan New - Know Your Business - Company Profile. Returns the UBO and ownership chain for the company identified by the scan. Charges may apply for this enriched data; query GET /kyb/{scanId}/company/profile/charge first to retrieve the cost.
Body parameter
{
"companyCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBCompanyProfileInputParam | false | Company Profile parameters, which include Company Code and ScanId. |
Example responses
201 Response
{
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "user@example.com",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBEnhancedProfileResult; contains brief information of company profile. | KYBEnhancedProfileResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Company Product List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/{scanId}/products
Search for available document products on the selected company profile following the company search.
Corporate Scan - Scan New - Know Your Business - Product Search lists available company document products by entering the company scan identifier and the company code. Document products include current and historical company information and disclosure notices.
Body parameter
{
"companyCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBProductInputParam | false | Search parameters, which include Company Code |
Example responses
201 Response
{
"productResults": [
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyCode": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBProductResult; contains a list of available company document products for purchase. Information includes document title, cost charge, estimated delivery time, document summary and if a sample document report is available for preview before purchase. | KYBProductResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Product Order
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"companyCode": "string",
"productEntityId": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/order", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/{scanId}/products/order
Creates an order to purchase document products of the company.
Corporate Scan - Scan New - Know Your Business - Products Order allows you to purchase documents available for the company by specifying the company code and selected product entity identifiers.
Body parameter
{
"companyCode": "string",
"productEntityId": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | KYBProductOrderInputParam | false | Products Order parameters, which include company code and product entity identifier. |
Example responses
201 Response
{
"companyId": 0,
"productId": 0,
"message": "string",
"status": "Requested"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | KYBProductOrderResult; contains the status of the document product ordered. The returned productId should be used in GET /kyb/{scanId}/products/{productId} API method to obtain the product. | KYBProductOrderResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Products Status
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/status", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/products/status
Returns details of the document products from a specific Know Your Business scan.
Corporate Scan - Scan History - Know Your Business - Document Products returns details of the document products from a specific Know Your Business scan and which includes Company Name, Product Title, Creation Date, Completion Date, Price and Status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBProductHistoryResult; details of the document products from a specific Know Your Business scan. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBProductHistoryResult] | false | none | [Represents details of product information.] |
| » productId | integer(int32) | false | none | The identifier of a specific product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
| » companyNumber | string¦null | false | none | Provides the registration number of company. |
| » companyName | string¦null | false | none | This provides the full name of the company. |
| » creationDate | string(date-time) | false | none | Identifies the creation date of the product. |
| » status | string¦null | false | none | Identifies the status of the product. |
| » completionDate | string(date-time)¦null | false | none | The completion date of the product. |
| » productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| » currency | string¦null | false | none | The currency of the document product. |
| » productFormat | string¦null | false | none | The format of the document product. |
| » productTitle | string¦null | false | none | The title of the document product. |
| » deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| » productInfo | string¦null | false | none | Provides the document product information. |
| » price | number(double) | false | none | The price of the document product. |
| » isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
Product Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/{productId}/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/products/{productId}/file
Downloads the specific document product in PDF format.
Corporate Scan - Scan History - Know Your Business - Download Product Download the document product of the company based on the provided unique scan identifier and product identifier. Returns document in PDF format.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| productId | path | integer(int32) | true | The identifier of a specific document product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
KYB Details By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}
Returns details of the scan settings applied to a specific scan.
Corporate Scan - Scan History - Know Your Business - Detail of Know Your Business History returns details of the scan settings applied during scanning and may contain details from various screening services run during scanning. For KYB specific scan, this includes company information that was entered, the list of companies selected for enhanced profile UBO details, and document products that were requested at the time of the scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| includeSupportingDocument | query | array[string] | false | Specifies whether to include the supporting document in the response. Refer to the supported values below. |
Enumerated Values
| Parameter | Value |
|---|---|
| includeSupportingDocument | No |
| includeSupportingDocument | Yes |
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",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
},
"companyResults": [
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "user@example.com",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
],
"documentResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"kybParam": {
"country": "string",
"state": "string"
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBScanHistoryDetail; details of the Scan Parameters used, company information, list of companies with its enhanced profile and products that were requested at the time of scan. | KYBScanHistoryDetail |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Company Details Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/company/{companyId}/report
Downloads the company-scan report (PDF).
Corporate Scan - Scan History - Know Your Business - Company Report. Downloads a PDF report containing the company-scan results together with the document-product information for the specified company profile.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Products By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/products/file
Downloads all available purchased document products from a specific Know Your Business scan in a ZIP file format.
Corporate Scan - Scan History - Know Your Business - Companies Documents Download all available purchased document products from a specific Know Your Business scan in a ZIP file format. Only documents which have been fulfilled from the registry can be downloaded.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Products By CompanyId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/products/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/company/{companyId}/products/file
Downloads all purchased document products for a specific company.
Corporate Scan - Scan History - Know Your Business - Download Documents Downloads a ZIP file of all purchased documents for a specific company.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Document file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Sample Product
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/sample/{productTitle}/file", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/products/sample/{productTitle}/file
Download a sample company document product in PDF format.
Corporate Scan - Scan New - Know Your Business - Sample Document. Downloads a sample document product, identified by the scan identifier and product title, to preview before purchasing. Files are returned in PDF format.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| productTitle | path | string | true | Title of the product.The POST /kyb/{scanId}/products method response class returns this identifier in productResults.productTitle. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Company Profile Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/{companyId}/profile/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/company/{companyId}/profile/report
Downloads a PDF report file of a specific company profile details.
Corporate Scan - Scan History - Know Your Business - Report Downloads a PDF report file of all available information in the Company Profile including Basic Details, Representatives, Directors, Shareholders and UBO.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| companyId | path | integer(int32) | true | The unique identifier of the KYB company search. The POST /kyb/company/search API method response class returns this identifier in corpScanResult.kybSearchResults.Companies.code. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Company UBO Pricing Details
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/company/profile/charge", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/company/profile/charge
Returns the cost charge to access the enhanced-company profile (UBO).
Corporate Scan - Scan New - Know Your Business - Company Profile Charges returns the cost to access the enhanced-company profile. Results include the availability of the types of information from the registry which may include company registration details, representatives, shareholders and UBO information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
{
"enhancedProfilePrice": 0,
"basicInformation": true,
"representatives": true,
"shareholders": true,
"uboDeclaration": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBEnhancedProfileCreditChargeResult; details of Company Profile Credit Charge and the availability of the types of information including UBO information. | KYBEnhancedProfileCreditChargeResult |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Products Report By ScanId
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report HTTP/1.1
X-Request-Language: string
const headers = {
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/products/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/products/report
Downloads a PDF report file listing all company document products for a specific KYB scan.
Corporate Scan - Scan History - Know Your Business - Company documents - Report Download a PDF report file of all company documents requested for a specific KYB scan. Report includes Company Name, Registration Number, Document Title, Requested date, Downloaded date and Status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The GET /corp-scans/single or POST /corp-scans/single API method response class returns this identifier in scanId. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
KYB Scan Supporting Documents
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents',
{
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/v3/kyb/{scanId}/documents',
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/v3/kyb/{scanId}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents");
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/v3/kyb/{scanId}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/documents
Returns supporting documents of a specific Know Your Business scan.
Corporate Scan - Know Your Business - Supporting Documents provides all supporting documents of a specific Know Your Business scan.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentResult; lists of the supporting documents for a Know Your Business scan selected in the scan results or scan history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentResult] | false | none | [Represents the details of a supporting document.] |
| » id | integer(int32) | false | none | The unique identifier of the supporting document. |
| » fileName | string¦null | false | none | The file name of the supporting document. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » comment | string¦null | false | none | Any comments associated with the supporting document. |
| » isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| » documentType | string¦null | false | none | The type of the supporting document. |
| » documentTypeDescription | string¦null | false | none | The description of the document type. |
New KYB Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents HTTP/1.1
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"Documents": [
{
"file": "string",
"comment": "string",
"documentTypeId": 0
}
],
"IsOverwrite": true,
"File": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/{scanId}/documents
Upload supporting documents for a specific Know Your Business scan.
Corporate Scan - Know Your Business - Supporting Documents - Upload Documents allows to upload supporting documents for a specific Know Your Business scan. Supported File Types: PDF, JPG, JPEG, PNG, GIF, TIF, TIFF, ZIP
Body parameter
Documents:
- file: string
comment: string
documentTypeId: 0
IsOverwrite: true
File: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| body | body | object | false | none |
| » Documents | body | [SupportingDocumentFile] | false | A list of supporting documents, including files, comments, and document types. |
| »» file | body | string(binary) | true | The uploaded supporting document file. |
| »» comment | body | string¦null | false | Comments associated with the supporting document. |
| »» documentTypeId | body | integer(int32) | false | The identifier of the selected document type for the supporting document. |
| » IsOverwrite | body | boolean | false | Indicates whether an existing supporting document should be overwritten (true if overwrite is enabled). |
| » File | body | string(binary) | false | Supporting document files to be uploaded. |
Example responses
201 Response
{
"uploadedFileResult": [
{
"fileName": "string",
"supportingDocumentId": 0
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | SupportingDocumentResponse; contains information of uploaded supporting documents. | SupportingDocumentResponse |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Pin KYB Scan Supporting Document
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/pin \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/pin HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/pin',
{
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/v3/kyb/{scanId}/documents/{documentId}/pin',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/pin', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/pin");
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/v3/kyb/{scanId}/documents/{documentId}/pin", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/kyb/{scanId}/documents/{documentId}/pin
Toggles the pin status of a specific supporting document.
Corporate Scan - Know Your Business - Supporting Documents - Pin/Unpin Document allows you to pin or unpin supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /kyb/single/{id}/documents or POST /kyb/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Download KYB Scan Supporting Document
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/download \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/download HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/download',
{
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/v3/kyb/{scanId}/documents/{documentId}/download',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/download', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}/download");
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/v3/kyb/{scanId}/documents/{documentId}/download", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/documents/{documentId}/download
Downloads a specific supporting document.
Corporate Scan - Know Your Business - Supporting Documents - Download Document allows you to download a specific supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /kyb/single/{id}/documents or POST /kyb/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the file content for the requested document. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete KYB Scan Supporting Document
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/{documentId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/kyb/{scanId}/documents/{documentId}
Deletes a specific supporting document.
Corporate Scan - Know Your Business - Supporting Documents - Delete Document allows you to delete a specific supporting document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
| documentId | path | integer(int32) | true | The identifier of a specific supporting document. The GET /kyb/single/{id}/documents or POST /kyb/single/{id}/documents API method response class returns this identifier in id or supportingDocumentId. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
KYB Scan Supporting Documents History
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/history \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/history HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/history',
{
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/v3/kyb/{scanId}/documents/history',
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/v3/kyb/{scanId}/documents/history', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/{scanId}/documents/history");
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/v3/kyb/{scanId}/documents/history", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/{scanId}/documents/history
Returns the supporting document history of a specific Know Your Business scan.
Corporate Scan - Know Your Business - Supporting Documents - Documents History provides a history of all uploaded, overwritten, downloded and deleted supporting documents.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| scanId | path | integer(int32) | true | The identifier of a specific KYB scan. The POST /kyb/company or POST /corp-scans/single API method response class returns this identifier in scanId. |
Example responses
200 Response
[
{
"fileName": "string",
"date": "2019-08-24T14:15:22Z",
"uploadedBy": "string",
"action": "Uploaded"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentHistoryResult, lists the supporting document history. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentHistoryResult] | false | none | [Represents the history of actions performed on a supporting document.] |
| » fileName | string¦null | false | none | The name of the supporting document. |
| » date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| » uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| » action | string¦null | false | none | The action performed on the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| action | Uploaded |
| action | Downloaded |
| action | Overwritten |
| action | Deleted |
Jurisdiction List
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/kyb/jurisdictions \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/kyb/jurisdictions 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/v3/kyb/jurisdictions',
{
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/v3/kyb/jurisdictions',
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/v3/kyb/jurisdictions', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/kyb/jurisdictions");
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/v3/kyb/jurisdictions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/kyb/jurisdictions
Returns the list of KYB jurisdictions.
Corporate Scan - Know Your Business - Jurisdictions provides the list of KYB jurisdictions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Example responses
200 Response
[
{
"code": "string",
"name": "string",
"hasStates": true,
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true,
"serviceAvailable": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of KYBCountryResult, lists the KYB jurisdictions. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBCountryResult] | false | none | [KYB Country information elements.] |
| » code | string¦null | false | none | The ISO 3166 2-letter country code. |
| » name | string¦null | false | none | Name of the country. |
| » hasStates | boolean | false | none | Indicates whether the country has registry subdivisions such as states or provinces. |
| » supportsRegistrationNumber | boolean | false | none | Denotes whether the country registry supports searching by business registration number. |
| » companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| » productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
| » serviceAvailable | boolean | false | none | Indicates whether the document products or enhanced profile service are available for the country. |
Lookup Values
Reference data: countries, time zones, document types, system settings.
System Settings
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/lookup-values/system-settings \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v3/lookup-values/system-settings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/lookup-values/system-settings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/lookup-values/system-settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/lookup-values/system-settings', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/lookup-values/system-settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/lookup-values/system-settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/lookup-values/system-settings
Returns system public settings.
Example responses
200 Response
{
"reCaptchaSettings": {
"globalUrl": "string",
"publicKey": "string"
},
"mailSettings": {
"fromEmail": "string",
"supportEmail": "string"
},
"supportingDocumentSettings": {
"maximumFilesAllowed": 0,
"maximumFileSize": 0
},
"serverTimezone": "string",
"isSSOEnabled": true,
"isFeedbackRatingEnabled": true,
"idvStorageFileStorageType": "string",
"idvEventOrigin": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SystemPublicSettings; detail of system public settings. | SystemPublicSettings |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
SSO URL
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token} \
-H 'Accept: application/json'
GET https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/lookup-values/sso-url/{token}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/lookup-values/sso-url/{token}
Returns the single sign-on (SSO) login and logout URLs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| token | path | string | true | none |
Example responses
200 Response
{
"callbackUrl": "string",
"signOutUrl": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | SsoSettings; detail of aws cognito settings. | SsoSettings |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Countries
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/lookup-values/countries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/lookup-values/countries HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/lookup-values/countries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/lookup-values/countries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/lookup-values/countries', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/lookup-values/countries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/lookup-values/countries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/lookup-values/countries
Returns list of countries.
Administration - Organisation - Organisation Details Country list.
Example responses
200 Response
[
{
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgCountry; lists all available countries. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgCountry] | false | none | none |
| » timeZoneId | string¦null | false | none | none |
| » name | string¦null | false | none | none |
| » code | string¦null | false | Length: 0 - 5 | none |
| » nationality | string¦null | false | none | none |
Timezones
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/lookup-values/time-zones \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/lookup-values/time-zones HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/lookup-values/time-zones',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/lookup-values/time-zones',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/lookup-values/time-zones', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/lookup-values/time-zones");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/lookup-values/time-zones", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/lookup-values/time-zones
Returns list of time zones.
Administration - Organisation Time zone list.
Example responses
200 Response
[
{
"id": "string",
"name": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of OrgTimeZone; lists all available time zones. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OrgTimeZone] | false | none | none |
| » id | string¦null | false | none | none |
| » name | string¦null | false | none | none |
Supporting Document Types
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/lookup-values/document-types \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/lookup-values/document-types HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/lookup-values/document-types',
{
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/v3/lookup-values/document-types',
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/v3/lookup-values/document-types', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/lookup-values/document-types");
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/v3/lookup-values/document-types", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/lookup-values/document-types
Returns a list of supporting document types.
Supporting Documents Types Returns a list of supporting document types.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"description": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of SupportingDocumentType, lists the supporting document types. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SupportingDocumentType] | false | none | none |
| » id | integer(int32) | false | none | The identifier of Supporting Document Type. |
| » name | string¦null | false | none | The name of Supporting Document Type. |
| » description | string¦null | false | none | The description of Supporting Document Type. |
Monitoring Lists
Ongoing monitoring management. View, enable, disable, and delete monitored entities.
Member Monitoring Lists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/monitoring-lists/member \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/monitoring-lists/member HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/member',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/monitoring-lists/member',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/monitoring-lists/member', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/member");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/monitoring-lists/member", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/monitoring-lists/member
Returns details of members in the monitoring list.
Monitoring - Monitoring List provides a record of all members in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| clientId | query | string | false | All or part of Client ID. |
| status | query | array[string] | false | Status of monitoring for the member i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| lastMonitoredFrom | query | string | false | Last lonitored from (DD/MM/YYYY). |
| lastMonitoredTo | query | string | false | Last lonitored to (DD/MM/YYYY). |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Example responses
200 Response
[
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"lastMonitored": "2019-08-24",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"gender": "string",
"address": "string",
"country": "string",
"nationality": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of MonitoringListMemberItem; lists the member's monitoring list items. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MonitoringListMemberItem] | false | none | none |
| » id | integer(int32) | false | none | The unique identifier for the member assigned by the system within the monitoring list. |
| » monitor | boolean | false | none | Status of monitoring for the member i.e. actively monitored (true) or disabled from monitoring (false). |
| » addedBy | string¦null | false | none | User who added the member to the monitoring list during a scan. |
| » dateAdded | string(date-time) | false | none | Date the member was first added to the monitoring list. |
| » lastMonitored | string(date)¦null | false | none | Last monitored date of member in the monitoring list. |
| » clientId | string¦null | false | none | The unique Client ID entered for the member during scans. |
| » firstName | string¦null | false | none | The first name scanned for the member. |
| » middleName | string¦null | false | none | The middle name scanned for the member. |
| » lastName | string¦null | false | none | The last name scanned for the member. |
| » scriptNameFullName | string¦null | false | none | The original script / full name scanned for the member. |
| » dob | string¦null | false | none | The date of birth scanned for the member. |
| » gender | string¦null | false | none | The gender scanned for the member. |
| » address | string¦null | false | none | The address scanned for the member. |
| » country | string¦null | false | none | The country scanned for the member. |
| » nationality | string¦null | false | none | The nationality scanned for the member. |
Member Monitoring Lists Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/monitoring-lists/member/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/monitoring-lists/member/report
Downloads the report file (csv) of members in the monitoring list.
Monitoring - Monitoring List - Download CSV Downloads the report file (csv) of all members in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| firstName | query | string | false | All or part of First Name. Only enter Latin or Roman scripts in this parameter. |
| middleName | query | string | false | All or part of Middle Name. Only enter Latin or Roman scripts in this parameter. |
| lastName | query | string | false | Full Last Name. Only enter Latin or Roman scripts in this parameter. |
| scriptNameFullName | query | string | false | Full Original Script Name or Full Name. Only enter original script or full name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc). |
| clientId | query | string | false | All or part of Client ID. |
| status | query | array[string] | false | Status of monitoring for the member i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| lastMonitoredFrom | query | string | false | Last lonitored from (DD/MM/YYYY). |
| lastMonitoredTo | query | string | false | Last lonitored to (DD/MM/YYYY). |
| 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Monitoring lists
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/monitoring-lists/corp \
-H 'Accept: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/monitoring-lists/corp HTTP/1.1
Accept: application/json
X-Request-OrgId: string
const headers = {
'Accept':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corp',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corp", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/monitoring-lists/corp
Returns details of companies in the monitoring list.
Monitoring - Monitoring List provides a record of all companies in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| status | query | array[string] | false | Status of monitoring for the company i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| lastMonitoredFrom | query | string | false | none |
| lastMonitoredTo | query | string | false | none |
| pageIndex | query | integer(int32) | false | The page index of results. |
| pageSize | query | integer(int32) | false | The number of items or results per page or request. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Example responses
200 Response
[
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"lastMonitored": "2019-08-24",
"clientId": "string",
"companyName": "string",
"address": "string",
"country": "string",
"registrationNumber": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Array of MonitoringListCorpItem; lists the corporate's monitoring list items. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [MonitoringListCorpItem] | false | none | none |
| » id | integer(int32) | false | none | The unique identifier for the company assigned by the system within the monitoring list. |
| » monitor | boolean | false | none | Status of monitoring for the company i.e. actively monitored (true) or disabled from monitoring (false). |
| » addedBy | string¦null | false | none | User who added the company to the monitoring list during a scan. |
| » dateAdded | string(date-time) | false | none | Date the company was first added to the monitoring list. |
| » lastMonitored | string(date)¦null | false | none | Last monitored date of company in the monitoring list. |
| » clientId | string¦null | false | none | The unique Client ID for the company entered during scans. |
| » companyName | string¦null | false | none | The name scanned for the company. |
| » address | string¦null | false | none | The address scanned for the company. |
| » country | string¦null | false | none | The country scanned for the company. |
| » registrationNumber | string¦null | false | none | The Registration Number scanned for the company. |
Corporate Monitoring Lists Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/report", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/monitoring-lists/corp/report
Downloads the report file (csv) of companies in the monitoring list.
Monitoring - Monitoring List - Download CSV Downloads the report file (csv) of all companies in the monitoring list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| companyName | query | string | false | All or part of Company Name. |
| clientId | query | string | false | All or part of Client ID. |
| status | query | array[string] | false | Status of monitoring for the company i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values. |
| lastMonitoredFrom | query | string | false | none |
| lastMonitoredTo | query | string | false | none |
| 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. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| status | On |
| status | Off |
| status | All |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Member
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/monitoring-lists/member/{id}/enable
Activates monitoring for an existing member in the Monitoring List.
Monitoring - Monitoring List Enables an existing member in Monitoring List to be actively monitored. Member must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Member
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/monitoring-lists/member/{id}/disable
Deactivates monitoring for an existing member in the Monitoring List.
Monitoring - Monitoring List Disables an existing member in the Monitoring List from being monitored. Member must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Enable Corporate
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/enable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/monitoring-lists/corp/{id}/enable
Activates monitoring for an existing company in the Monitoring List.
Monitoring - Monitoring List Enables an existing company in Monitoring List to be actively monitored. The company must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Disable Corporate
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}/disable", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/monitoring-lists/corp/{id}/disable
Deactivates monitoring for an existing company in the Monitoring List.
Monitoring - Monitoring List Disables an existing company in the Monitoring List from being monitored. Company must already have been previously added to the Monitoring List.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Member
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/monitoring-lists/member/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/monitoring-lists/member/{id}
Delete an existing member from the Monitoring List.
Monitoring - Monitoring List Deletes an existing member from the Monitoring List. This does not impact on historical scans. The deleted member can be re-enabled for monitoring through POST member-scans/single/{id}/monitor/enable.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the member in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Corporate
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id} \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corp/{id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/monitoring-lists/corp/{id}
Delete an existing company from the Monitoring List.
Monitoring - Monitoring List Deletes an existing corporate from the Monitoring List. This does not impact on historical scans. The deleted corporation can be re-enabled for monitoring through POST corp-scans/single/{id}/monitor/enable.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The unique id assigned to the company in the monitoring list. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | Indicates success but nothing is in the response body. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Members
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/members \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/members HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"clientIds": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/members',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/monitoring-lists/members',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/monitoring-lists/members', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/members");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/monitoring-lists/members", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/monitoring-lists/members
Delete members from the Monitoring List.
Deletes existing members from the Monitoring List. This does not impact on historical scans.
Body parameter
{
"clientIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | MonitoringItems | false | Client Ids of items to be deleted. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of deleted items. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Delete Corporates
Code samples
# You can also use wget
curl -X DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/corps \
-H 'Content-Type: application/json' \
-H 'X-Request-OrgId: string' \
-H 'Authorization: Bearer {access-token}'
DELETE https://demo.api.membercheck.com/api/v3/monitoring-lists/corps HTTP/1.1
Content-Type: application/json
X-Request-OrgId: string
const inputBody = '{
"clientIds": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'X-Request-OrgId':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/monitoring-lists/corps',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-OrgId' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://demo.api.membercheck.com/api/v3/monitoring-lists/corps',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-OrgId': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://demo.api.membercheck.com/api/v3/monitoring-lists/corps', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/monitoring-lists/corps");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-OrgId": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://demo.api.membercheck.com/api/v3/monitoring-lists/corps", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /api/v3/monitoring-lists/corps
Delete companies from the Monitoring List.
Deletes existing corporates from the Monitoring List. This does not impact on historical scans.
Body parameter
{
"clientIds": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| body | body | MonitoringItems | false | Client Ids of items to be deleted. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Number of deleted items. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Reports
Report generation and download. PDF, Excel, Word, and CSV formats.
Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/single-activity \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/single-activity HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/single-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/single-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/single-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/single-activity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/single-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/single-activity
Downloads report file of Activity Report in Excel, Word or PDF.
Report - Activity Report Download a report of Activity Report based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
IDV Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/idv-activity \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/idv-activity HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/idv-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/idv-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/idv-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/idv-activity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/idv-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/idv-activity
Downloads report file of IDV Activity Report in Excel, Word or PDF.
Report - IDV Activity Report Download a report of IDV Activity based on scan date for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
KYB Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/business-ubo-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/business-ubo-activity
Downloads a report file of the KYB and UBO Activity Report in Excel, Word or PDF.
Report - Business UBO Activity Report Download a report of KYB and UBO Activity Report which includes all company documents purchased based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Group Activity Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/reports/group-activity \
-H 'Content-Type: application/json' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/reports/group-activity HTTP/1.1
Content-Type: application/json
X-Request-Language: string
const inputBody = '{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"format": "PDF"
}';
const headers = {
'Content-Type':'application/json',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/group-activity',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/reports/group-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/reports/group-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/group-activity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/reports/group-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/reports/group-activity
Downloads report file of Group Activity Report in Excel, Word or PDF.
Report - Group Activity Report Download a report of Group Activity Report based on specified filters for the selected organisations.
Body parameter
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"format": "PDF"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
| body | body | GroupActivityReportParam | false | Group Activity Report parameters, which include fundIDs, date range and format. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Monitoring Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/monitoring \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/monitoring HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/monitoring',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/monitoring',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/monitoring', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/monitoring");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/monitoring", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/monitoring
Downloads report file of Monitoring Report in Excel, Word or PDF.
Report - Monitoring Report Download a report of Monitoring Report based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| includeAllActivities | query | boolean | false | Report to include only Monitoring with updates OR All monitoring activities |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Member Due Diligence Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/member-due-diligence \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/member-due-diligence HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/member-due-diligence',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/member-due-diligence',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/member-due-diligence', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/member-due-diligence");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/member-due-diligence", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/member-due-diligence
Downloads report file of Member Due Diligence Report in Excel, Word, PDF or CSV.
Report - Member Due Diligence Report Downloads report file of Member Due Diligence Report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| from | query | string | false | Decision/Comment date from (DD/MM/YYYY). |
| to | query | string | false | Decision/Comment date to (DD/MM/YYYY). |
| includeAllDecisions | query | boolean | false | Report to include Latest Decision / Latest Comment OR All Decisions / All Comments. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Corporate Due Diligence Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/corp-due-diligence", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/corp-due-diligence
Downloads report file of Corporate Due Diligence Report in Excel, Word, PDF or CSV.
Report - Corporate Due Diligence Report Downloads report file of Corporate Due Diligence Report.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word and CSV. If no format is defined, the default is PDF. |
| from | query | string | false | Decision/Comment date from (DD/MM/YYYY). |
| to | query | string | false | Decision/Comment date to (DD/MM/YYYY). |
| includeAllDecisions | query | boolean | false | Report to include Latest Decision / Latest Comment OR All Decisions / All Comments. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
| format | CSV |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Business UBO Pricing List
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/octet-stream' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
const inputBody = '{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 20
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/octet-stream',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/octet-stream',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/octet-stream',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/octet-stream"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/reports/business-ubo-pricing/search
Returns details of the KYB Business and UBO Pricing.
Report - KYB Business and UBO Pricing Report returns details of the documents and enhanced profile from a specific Know Your Business scan which includes Scan Date, Country, Company Name, Product Title, Requested Date, Completion Date, Price and Status.
Body parameter
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 20
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | KYBPricingParam | false | KYB Business and UBO Pricing Report parameters, which include fundIDs, date range , document status and include enhanced profile. |
Example responses
200 Response
[
{
"scanDate": "string",
"orgNameWithFundID": "string",
"countryCode": "string",
"companyName": "string",
"productTitle": "string",
"orderId": "string",
"creditCharge": 0,
"creditCostPrice": "string",
"price": "string",
"requestedDate": "string",
"downloadedDate": "string",
"status": "string",
"enhancedProfileRequested": true
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | KYBPricingReportResult; details of the business and UBO pricing. | Inline |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 403 | Forbidden | Authorization denied — the authenticated user does not have permission. | None |
| 404 | Not Found | Resource not found — the requested resource does not exist or is inaccessible. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KYBPricingReportResult] | false | none | [Represents details of the KYB pricing report.] |
| » scanDate | string¦null | false | none | Provides the scan date. |
| » orgNameWithFundID | string¦null | false | none | Provides the organisation name and org id. |
| » countryCode | string¦null | false | none | Provides the code of the country. |
| » companyName | string¦null | false | none | Provides the full name of the company. |
| » productTitle | string¦null | false | none | The title of the document product. |
| » orderId | string¦null | false | none | The order reference of the document product. |
| » creditCharge | number(double) | false | none | Provides the credit charge of the document or enhanced profile. |
| » creditCostPrice | string¦null | false | none | Provides the credit cost price of the document or enhanced profile. |
| » price | string¦null | false | none | Provides the price of the document or enhanced profile. |
| » requestedDate | string¦null | false | none | Provides the requested date of the document or enhanced profile. |
| » downloadedDate | string¦null | false | none | Provides the downloaded date of the document or enhanced profile. |
| » status | string¦null | false | none | Provides the status of the document product. |
| » enhancedProfileRequested | boolean | false | none | Identifies enhanced profile is requested or not. |
Business UBO Pricing Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing \
-H 'Content-Type: application/json' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing HTTP/1.1
Content-Type: application/json
X-Request-Language: string
const inputBody = '{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}';
const headers = {
'Content-Type':'application/json',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/reports/business-ubo-pricing", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/reports/business-ubo-pricing
Downloads report file of KYB Business and UBO Pricing Report in CSV.
Report - KYB Business and UBO Pricing Report Download a report of KYB Business and UBO Pricing based on specified filters for the selected organisations, document statuses and enhanced profile inclusion.
Body parameter
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
| body | body | KYBPricingReportParam | false | KYB Business and UBO Pricing Report parameters, which include fundIDs, date range , document status and include enhanced profile. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Group Monitoring Report
Code samples
# You can also use wget
curl -X POST https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary \
-H 'Content-Type: application/json' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
POST https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary HTTP/1.1
Content-Type: application/json
X-Request-Language: string
const inputBody = '{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"format": "PDF"
}';
const headers = {
'Content-Type':'application/json',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://demo.api.membercheck.com/api/v3/reports/monitoring-group-summary", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /api/v3/reports/monitoring-group-summary
Downloads report file of Monitoring Group Summary Report in Excel, Word or PDF.
Report - Monitoring Group Summary Report Download a report of Monitoring Group Summary Report based on specified filters for the selected organisations.
Body parameter
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"format": "PDF"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
| body | body | GroupActivityReportParam | false | Monitoring Group Summary Report parameters, which include fundIDs, date range and format. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Risk Assessment Activity Report
Code samples
# You can also use wget
curl -X GET https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity \
-H 'X-Request-OrgId: string' \
-H 'X-Request-Language: string' \
-H 'Authorization: Bearer {access-token}'
GET https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity HTTP/1.1
X-Request-OrgId: string
X-Request-Language: string
const headers = {
'X-Request-OrgId':'string',
'X-Request-Language':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'X-Request-OrgId' => 'string',
'X-Request-Language' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'X-Request-OrgId': 'string',
'X-Request-Language': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity', headers = headers)
print(r.json())
URL obj = new URL("https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"X-Request-OrgId": []string{"string"},
"X-Request-Language": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://demo.api.membercheck.com/api/v3/reports/aml-risk-activity", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /api/v3/reports/aml-risk-activity
Downloads report file of Risk Assessment Activity Report in Excel, Word or PDF.
Report - Risk Assessment Activity Report Download a report of Risk Assessment Activity Report based on specified filters for the selected organisation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| from | query | string | false | Scan date from (DD/MM/YYYY). |
| to | query | string | false | Scan date to (DD/MM/YYYY). |
| format | query | string | false | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
| X-Request-OrgId | header | string | false | Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations. |
| X-Request-Language | header | string | false | This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used. |
Detailed descriptions
X-Request-Language: This field is optional and used to specify the language in which report will be downloaded (English (EN), Français (FR), العربیة (AR), 中文（简体）(ZH), 日本語 (JA), Español (ES)). If not specified, the default language English (EN) will be used.
Supported values: EN, FR, ZH, AR, JA, ES.
Enumerated Values
| Parameter | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Report file byte array. | None |
| 400 | Bad Request | Validation error — check response body for field-level error details. | None |
| 401 | Unauthorized | Authentication failed — access token is missing, expired, or invalid. | None |
| 500 | Internal Server Error | Internal server error — an unexpected error occurred. Retry or contact support. | None |
Schemas
EVerification.IDVSMSEnabledCountriesDetail
{
"countries": [
{
"countryCode": "string",
"isSmsServiceEnabled": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countries | [EVerification.IDVSMSEnabledCountry]¦null | false | none | none |
EVerification.IDVSMSEnabledCountry
{
"countryCode": "string",
"isSmsServiceEnabled": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryCode | string¦null | false | none | none |
| isSmsServiceEnabled | boolean | false | none | none |
WebhookNotification
{
"enable": true,
"url": "string",
"service": "None",
"channelName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enable | boolean | false | none | none |
| url | string¦null | false | none | none |
| service | string¦null | false | none | none |
| channelName | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| service | None |
| service | Slack |
| service | Mattermost |
SourceListDocument
{
"name": "string",
"description": "string",
"url": "string",
"dataSource": "None",
"visible": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| description | string¦null | false | none | none |
| url | string¦null | false | none | none |
| dataSource | string¦null | false | none | none |
| visible | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dataSource | None |
| dataSource | DowJones |
| dataSource | ThomsonReuters |
| dataSource | MemberCheck |
| dataSource | Acuris |
| dataSource | LexisNexis |
| dataSource | CustomList |
AIAnalysisInputParam
{
"question": "Is this person politically exposed?",
"helperText": "Consider their country of residence, nationality, and any prominent positions they may hold."
}
AIAnalysisInputParam which includes ScanResultId, Question and Helpertext.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| question | string | true | Length: 1 - undefined | Question to be asked for AI Analysis. |
| helperText | string¦null | false | none | Used to define question context for AI Analysis. |
AIAnalysisResultInfo
{
"id": 0,
"scanResultId": 0,
"question": "string",
"answer": "string",
"isStrikedOut": true
}
Represents AIAnalysisResultInfo for entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Identifier of AI Analysis record. This should be used in PUT /ai-analysis/question/{id} API method to Perform strike/unstrike operation on record. |
| scanResultId | integer(int32) | false | none | The identifier of matched entity. The GET /member-scans/single/{id} or GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId. |
| question | string¦null | false | none | Question to be asked for AI Analysis. |
| answer | string¦null | false | none | Provides answer to the question. |
| isStrikedOut | boolean | false | none | Identifies AI Analysis record is striked out or not. |
AccountForgotPasswordData
{
"username": "string",
"recaptchaResponse": "string",
"answer": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| username | string | true | Length: 1 - undefined | none |
| recaptchaResponse | string | true | Length: 1 - undefined | none |
| answer | string¦null | false | none | none |
AccountForgotUsernameData
{
"email": "user@example.com",
"recaptchaResponse": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| string | true | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| recaptchaResponse | string | true | Length: 1 - undefined | none |
AccountResetPasswordData
{
"token": "string",
"newPassword": "Str0ng!P@ss"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| token | string | true | Length: 1 - undefined | none |
| newPassword | string¦null | false | Length: 0 - 100 Pattern: ^(?=.&#... |
none |
AccountResetPasswordTokenInfo
{
"tokenExpired": true,
"isNewAccountPassword": true,
"passwordHistoryLimit": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokenExpired | boolean | false | none | none |
| isNewAccountPassword | boolean¦null | false | none | none |
| passwordHistoryLimit | integer(int32)¦null | false | none | none |
AdvancedMediaBookmarkParam
{
"scanInputId": 0,
"articleId": 0,
"siteId": 0
}
AdvancedMediaBookmarkParam, which includes Id, ScanInputId, ArticleId and SiteId.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanInputId | integer(int32) | false | none | ScanInputId of the scan. |
| articleId | integer(int32) | false | none | ArticleId of bookmark article. |
| siteId | integer(int32) | false | none | SiteId of bookmark article. |
AdvancedMediaResult
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| articleId | integer(int32) | false | none | none |
| siteId | integer(int32) | false | none | none |
| wordCount | string¦null | false | none | none |
| author | string¦null | false | none | none |
| link | string¦null | false | none | none |
| title | string¦null | false | none | none |
| publishedDate | string¦null | false | none | none |
| sourceName | string¦null | false | none | none |
| summary | string¦null | false | none | none |
| body | string¦null | false | none | none |
| readCount | string¦null | false | none | none |
| articleImages | [string]¦null | false | none | none |
| bookmarkId | integer(int32) | false | none | none |
| isBookmarked | boolean | false | none | none |
AssociateCorp
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
Profile of the associated or related company, organisation, or other entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | Name of associated company. |
| category | string¦null | false | none | Category of the associated company. |
| subcategories | string¦null | false | none | Subcategory of associated company.Note: Decommissioned on 1 July 2020. |
| description | string¦null | false | none | Description of the associate. |
| suggestedRisk | string¦null | false | none | Represents the associate's suggested risk level, determined by matching subcategory results against the predefined rules of the organisation. |
Enumerated Values
| Property | Value |
|---|---|
| suggestedRisk | Unallocated |
| suggestedRisk | Low |
| suggestedRisk | Med |
| suggestedRisk | High |
AssociatePerson
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
Profile of the associate or related individual.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| firstName | string¦null | false | none | Associate's first name. |
| middleName | string¦null | false | none | Associate's middle name. |
| lastName | string¦null | false | none | Associate's last name. |
| category | string¦null | false | none | Category of the associated person. |
| subcategories | string¦null | false | none | Subcategory of the associate.Note: Decommissioned on 1 July 2020. |
| description | string¦null | false | none | Description of the associate. |
| suggestedRisk | string¦null | false | none | Represents the associate's suggested risk level, determined by matching subcategory results against the predefined rules of the organisation. |
Enumerated Values
| Property | Value |
|---|---|
| suggestedRisk | Unallocated |
| suggestedRisk | Low |
| suggestedRisk | Med |
| suggestedRisk | High |
AuthenticityCheckDetailListItem
{
"count": 0,
"list": [
{
"elementType": "BLANK",
"elementResult": "ERROR",
"elementDiagnose": "UNKNOWN",
"image": {
"format": "string",
"image": "string"
},
"etalonImage": {
"format": "string",
"image": "string"
},
"percentValue": 0,
"lightIndex": "OFF",
"sourceImage": {
"format": "string",
"image": "string"
},
"resultImages": {
"count": 0,
"images": [
{
"format": "string",
"image": "string"
}
]
}
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | false | none | none |
| list | [ElementDetailsListItem]¦null | false | none | none |
| result | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| type | string¦null | false | none | Represents the document security and authenticity checks that can be performed. - UV_LUMINESCENCE: Document luminescence check in UV light. - IR_B900: B900 ink MRZ contrast check in IR light. - IMAGE_PATTERN: Image patterns presence/absence check (position, shape, color). - AXIAL_PROTECTION: Confirm laminate integrity check in axial light. - UV_FIBERS: Protection fibers presence check (color, density) in UV light. - IR_VISIBILITY: Document elements visibility check in IR light. - OCR_SECURITY_TEXT: OCR for the text field in UV light compared with other text sources. - IPI: Invisible Personal Information (IPI) visualization. - PHOTO_EMBED_TYPE: Owner's photo embedding check (printed or sticked). - OVI: OVI check (deprecated; use document liveness check instead). - HOLOGRAMS: Hologram presence check (deprecated). - PHOTO_AREA: Owner's photo area advanced check (shape, size, position, etc.). - PORTRAIT_COMPARISON: Portrait comparison check (document printed vs chip vs live). - BARCODE_FORMAT_CHECK: Barcode format check (metadata, data format, contents format, etc.). - KINEGRAM: Kinegram check. - LETTER_SCREEN: LetterScreen check. - HOLOGRAM_DETECTION: Hologram detection and validation check. - FINGERPRINT_COMPARISON: Fingerprint comparison check. - LIVENESS: Document liveness check. - EXTENDED_OCR_CHECK: Extended OCR check. - EXTENDED_MRZ_CHECK: Extended MRZ check. - ENCRYPTED_IPI: Encrypted IPI. |
Enumerated Values
| Property | Value |
|---|---|
| result | ERROR |
| result | OK |
| result | WAS_NOT_DONE |
| type | UV_LUMINESCENCE |
| type | IR_B900 |
| type | IMAGE_PATTERN |
| type | AXIAL_PROTECTION |
| type | UV_FIBERS |
| type | IR_VISIBILITY |
| type | OCR_SECURITY_TEXT |
| type | IPI |
| type | PHOTO_EMBED_TYPE |
| type | OVI |
| type | HOLOGRAMS |
| type | PHOTO_AREA |
| type | PORTRAIT_COMPARISON |
| type | BARCODE_FORMAT_CHECK |
| type | KINEGRAM |
| type | LETTER_SCREEN |
| type | HOLOGRAM_DETECTION |
| type | FINGERPRINT_COMPARISON |
| type | LIVENESS |
| type | EXTENDED_OCR_CHECK |
| type | EXTENDED_MRZ_CHECK |
| type | ENCRYPTED_IPI |
AuthenticityCheckListDetails
{
"count": 0,
"list": [
{
"count": 0,
"list": [
{
"elementType": "BLANK",
"elementResult": "ERROR",
"elementDiagnose": "UNKNOWN",
"image": {
"format": "string",
"image": "string"
},
"etalonImage": {
"format": "string",
"image": "string"
},
"percentValue": 0,
"lightIndex": "OFF",
"sourceImage": {
"format": "string",
"image": "string"
},
"resultImages": {
"count": 0,
"images": [
{
"format": "string",
"image": "string"
}
]
}
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
],
"pageIdx": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | false | none | none |
| list | [AuthenticityCheckDetailListItem]¦null | false | none | none |
| pageIdx | integer(int32) | false | none | none |
AvailableSourceItem
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| containerType | string¦null | false | none | Specifies the type of result container returned in the response. Each type corresponds to a specific data extraction or verification step. - DOCUMENT_IMAGE: Cropped/rotated document image with perspective compensation (ID: 1). - MRZ_TEXT: MRZ OCR results (ID: 3). - BARCODES: Raw information about barcodes (ID: 5). - VISUAL_GRAPHICS: Graphic fields from the Visual zone like signatures/photos (ID: 6). - MRZ_TEST_QUALITY: Result of the MRZ quality assessment (ID: 7). - DOCUMENT_TYPE_CANDIDATES: Potential document matches with probabilities (ID: 8). - DOCUMENT_TYPE: The finalized determined document type (ID: 9). - LEXICAL_ANALYSIS: Cross-source comparison (legacy; use TEXT) (ID: 15). - RAW_UNCROPPED_IMAGE: The original unedited input images (ID: 16). - VISUAL_TEXT: Data extracted from the visual zone (ID: 17). - BARCODE_TEXT: Text-based results from parsed barcodes (ID: 18). - BARCODE_GRAPHICS: Visual results from parsed barcodes (ID: 19). - AUTHENTICITY: Results of security and authenticity checks (ID: 20). - MAGNETIC_STRIPE_TEXT_DATA: Data from the magnetic stripe (ID: 26). - IMAGE_QUALITY: Detailed quality check of the input images (ID: 30). - LIVE_PORTRAIT: Data regarding the live portrait/selfie (ID: 32). - STATUS: Consolidated check statuses by source (ID: 33). - PORTRAIT_COMPARISON: Match results between document and live portraits (ID: 34). - EXT_PORTRAIT: Extended portrait/graphics info (ID: 35). - TEXT: Unified text fields with cross-source validation (ID: 36). - IMAGES: Unified image container for all sources (ID: 37). - FINGERPRINTS: Fingerprint data container (ID: 38). - FINGERPRINT_COMPARISON: Match results for fingerprints (ID: 39). - ENCRYPTED_RCL: Encrypted result data (ID: 49). - LICENSE: Current license status (ID: 50). - MRZ_POSITION: Coordinates for the MRZ area (ID: 61). - BARCODE_POSITION: Coordinates for the barcode area (ID: 62). - DOCUMENT_POSITION: Global coordinates, center, and angle of the document (ID: 85). - MRZ_DETECTOR: Low-level MRZ detection results (ID: 87). - FACE_DETECTION: Location and properties of faces in the image (ID: 97). - RFID_RAW_DATA: Unprocessed RFID chip data (ID: 101). - RFID_TEXT: Text extracted from the RFID chip (ID: 102). - RFID_GRAPHICS: Graphics extracted from the RFID chip (ID: 103). - RFID_BINARY_DATA: Binary files from the RFID chip (ID: 104). - RFID_ORIGINAL_GRAPHICS: Original uncompressed RFID graphics (ID: 105). - DTC_VC: Digital Travel Credential data (ID: 109). - MDL_PARSED_RESPONSE: Parsed mobile Driver's License response (ID: 121). - VDS_NC: Result of Visible Digital Seal for Non-Electronic Documents (ID: 124). - VDS: Result of Visible Digital Seal (ID: 125). |
| source | string¦null | false | none | none |
| validityStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| containerType | DOCUMENT_IMAGE |
| containerType | MRZ_TEXT |
| containerType | BARCODES |
| containerType | VISUAL_GRAPHICS |
| containerType | MRZ_TEST_QUALITY |
| containerType | DOCUMENT_TYPE_CANDIDATES |
| containerType | DOCUMENT_TYPE |
| containerType | LEXICAL_ANALYSIS |
| containerType | RAW_UNCROPPED_IMAGE |
| containerType | VISUAL_TEXT |
| containerType | BARCODE_TEXT |
| containerType | BARCODE_GRAPHICS |
| containerType | AUTHENTICITY |
| containerType | MAGNETIC_STRIPE_TEXT_DATA |
| containerType | IMAGE_QUALITY |
| containerType | LIVE_PORTRAIT |
| containerType | STATUS |
| containerType | PORTRAIT_COMPARISON |
| containerType | EXT_PORTRAIT |
| containerType | TEXT |
| containerType | IMAGES |
| containerType | FINGERPRINTS |
| containerType | FINGERPRINT_COMPARISON |
| containerType | ENCRYPTED_RCL |
| containerType | LICENSE |
| containerType | MRZ_POSITION |
| containerType | BARCODE_POSITION |
| containerType | DOCUMENT_POSITION |
| containerType | MRZ_DETECTOR |
| containerType | FACE_DETECTION |
| containerType | RFID_RAW_DATA |
| containerType | RFID_TEXT |
| containerType | RFID_GRAPHICS |
| containerType | RFID_BINARY_DATA |
| containerType | RFID_ORIGINAL_GRAPHICS |
| containerType | DTC_VC |
| containerType | MDL_PARSED_RESPONSE |
| containerType | VDS_NC |
| containerType | VDS |
| validityStatus | ERROR |
| validityStatus | OK |
| validityStatus | WAS_NOT_DONE |
BatchScanHistoryLog
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"ignoreBlankPolicy": "DOB"
}
Represents details of the member batch files, which have been uploaded and scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| membersScanned | integer(int32) | false | none | Number of members scanned. |
| matchedMembers | integer(int32) | false | none | Number of matched members. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
| matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| residence | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| dobTolerance | integer(int32)¦null | false | none | DOB Tolerance used for scan. |
| ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
BatchScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "ApplyAll",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "Yes",
"dobTolerance": 2,
"updateMonitoringList": false,
"allowDuplicateFileName": false,
"includeJurisdictionRisk": "No",
"includeAdvancedMedia": "No",
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
Batch scan parameters, which include match type and policy options.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| updateMonitoringList | boolean | false | none | none |
| allowDuplicateFileName | boolean | false | none | Used for allowing scan of files with duplicate name. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | 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 organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
BatchScanResult
{
"batchScanId": 0,
"status": "string"
}
Returns the batch scan identifier.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of this batch scan. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
BatchScanResults
{
"organisation": "string",
"user": "string",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"dobTolerance": 0,
"ignoreBlankPolicy": "DOB"
}
Represents member batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the batch scan. |
| user | string¦null | false | none | The User performing the batch scan. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| categoryResults | [CategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| dataSources | string¦null | false | none | Scan against selected data sources. This is useful for organisations that may choose to change Data Sources between scans. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| matchedEntities | [ScanHistoryLog0]¦null | false | none | List of matched entities. |
| 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. |
| matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| residence | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| dobTolerance | integer(int32)¦null | false | none | DOB Tolerance used for scan. |
| ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| 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 |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
BatchScanStatus
{
"batchScanId": 0,
"membersScanned": 0,
"matchedMembers": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Represents status of the member batch file.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan. |
| membersScanned | integer(int32)¦null | false | none | Number of members scanned. This only available for Completed or Completed with errors status. |
| matchedMembers | integer(int32)¦null | false | none | Number of matched members. This only available for Completed or Completed with errors status. |
| numberOfMatches | integer(int32)¦null | false | none | Total number of matches. This only available for Completed or Completed with errors status. |
| progress | integer(int32)¦null | false | none | Progress of scanning. This only available for In Progress or Scanning status. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
BulkDisableInputParam
{
"ids": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ids | [integer] | true | none | List of scan identifiers (scanId) to be disabled from monitoring. |
BulkEnableInputParam
{
"forceUpdate": true,
"ids": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| forceUpdate | boolean | false | none | When true, skips conflict checking and replaces any existing active Monitoring List entries with the same Client Id. |
| ids | [integer] | true | none | List of scan identifiers (scanId) to be enabled for monitoring. |
CategoryResults
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
Represents the categories the matched record belongs to.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | Category of matched record, which can be TER, PEP, SIP and RCA. |
| matchedMembers | integer(int32) | false | none | Number of matched members with this Category. |
| numberOfMatches | integer(int32) | false | none | Number of total matches by Category and as a Total. |
CategoryRisk
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | none |
| subCategory | string¦null | false | none | none |
| risk | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| risk | Unallocated |
| risk | Low |
| risk | Med |
| risk | High |
CompanyResult
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
Represents the result data of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string¦null | false | none | A unique code for that entity that will be used for ordering a company profile or retrieving product documents. |
| companyNumber | string¦null | false | none | The registration number of the company. |
| date | string¦null | false | none | The date of the company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| legalStatusDescription | string¦null | false | none | Additional information on the legal status of the company. |
| address | string¦null | false | none | The address of the company. |
ComparisonListItem
{
"sourceLeft": "MRZ",
"sourceRight": "MRZ",
"status": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sourceLeft | string¦null | false | none | Defines the source or method used to obtain the data or security feature. - MRZ: Machine Readable Zone (the two or three lines of text at the bottom of the document). - VISUAL: The human-readable fields on the document face (name, expiry, etc.). - BARCODE: Data extracted from 1D or 2D barcodes (like PDF417). - RFID: Data read from the contactless electronic chip. - MAGNETIC: Data read from a magnetic stripe. - LIVE: Data captured in real-time (e.g., live portrait or liveness check). - FINGERPRINT: Biometric fingerprint data. |
| sourceRight | string¦null | false | none | Defines the source or method used to obtain the data or security feature. - MRZ: Machine Readable Zone (the two or three lines of text at the bottom of the document). - VISUAL: The human-readable fields on the document face (name, expiry, etc.). - BARCODE: Data extracted from 1D or 2D barcodes (like PDF417). - RFID: Data read from the contactless electronic chip. - MAGNETIC: Data read from a magnetic stripe. - LIVE: Data captured in real-time (e.g., live portrait or liveness check). - FINGERPRINT: Biometric fingerprint data. |
| status | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| sourceLeft | MRZ |
| sourceLeft | VISUAL |
| sourceLeft | BARCODE |
| sourceLeft | RFID |
| sourceLeft | MAGNETIC |
| sourceLeft | LIVE |
| sourceLeft | FINGERPRINT |
| sourceRight | MRZ |
| sourceRight | VISUAL |
| sourceRight | BARCODE |
| sourceRight | RFID |
| sourceRight | MAGNETIC |
| sourceRight | LIVE |
| sourceRight | FINGERPRINT |
| status | ERROR |
| status | OK |
| status | WAS_NOT_DONE |
CorpBatchScanHistoryLog
{
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"ignoreBlankPolicy": "RegistrationNumber"
}
Represents details of the batch files, which have been uploaded and scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
| matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| addressPolicy | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| ignoreBlankPolicy | RegistrationNumber |
CorpBatchScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "ApplyAll",
"blankAddress": "ApplyDefaultCountry",
"updateMonitoringList": false,
"allowDuplicateFileName": false,
"includeJurisdictionRisk": "No",
"includeAdvancedMedia": "No",
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
Batch scan parameters, which include match type and policy options.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| updateMonitoringList | boolean | false | none | Used for adding the companies to Monitoring List for all records in the batch file with clientId/entityNumber, if the Monitoring setting is On. |
| allowDuplicateFileName | boolean | false | none | Used for allowing scan of files with duplicate name. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | Used for matching watchlist for scan profiles. The acceptable values are POI, SIE, Official Lists, SOE, Entity Type and Custom Watchlists. If watchlist is not passed or is NULL, the setting configured in the organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | RegistrationNumber |
CorpBatchScanResults
{
"organisation": "string",
"user": "string",
"defaultCountry": "string",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"matchedEntities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"batchScanId": 0,
"date": "2019-08-24T14:15:22Z",
"fileName": "string",
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"status": "string",
"statusDescription": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"ignoreBlankPolicy": "RegistrationNumber"
}
Represents corporate batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the batch scan. |
| user | string¦null | false | none | The User performing the batch scan. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| categoryResults | [CorpCategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| dataSources | string¦null | false | none | Scan against selected data sources. This is useful for organisations that may choose to change Data Sources between scans. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| matchedEntities | [CorpScanHistoryLog0]¦null | false | none | List of matched entities. |
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| date | string(date-time) | false | none | Date and time of the upload. |
| fileName | string¦null | false | none | File name of the batch file. |
| companiesScanned | integer(int32) | false | none | Number of companies scanned. |
| matchedCompanies | integer(int32) | false | none | Number of companies matched. |
| numberOfMatches | integer(int32) | false | none | Total number of matches. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
| matchType | string¦null | false | none | Match type scanned. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| addressPolicy | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| ignoreBlankPolicy | string¦null | false | none | IgnoreBlankPolicy of the batch scan. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| ignoreBlankPolicy | RegistrationNumber |
CorpBatchScanStatus
{
"batchScanId": 0,
"companiesScanned": 0,
"matchedCompanies": 0,
"numberOfMatches": 0,
"progress": 0,
"status": "string",
"statusDescription": "string"
}
Represents status of the corporate batch file.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| batchScanId | integer(int32) | false | none | The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan. |
| companiesScanned | integer(int32)¦null | false | none | Number of companies scanned. This only available for Completed or Completed with errors status. |
| matchedCompanies | integer(int32)¦null | false | none | Number of companies matched. This only available for Completed or Completed with errors status. |
| numberOfMatches | integer(int32)¦null | false | none | Total number of matches. This only available for Completed or Completed with errors status. |
| progress | integer(int32)¦null | false | none | Progress of scanning. This only available for In Progress or Scanning status. |
| status | string¦null | false | none | Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled. |
| statusDescription | string¦null | false | none | Status description. This only available for Completed with errors, Error or Cancelled status. |
CorpCategoryResults
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
Represents the categories the matched record belongs to.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | Category of matched record, which can be TER, SIE, SOE and POI. |
| matchedCompanies | integer(int32) | false | none | Number of matched companies with this Category. |
| numberOfMatches | integer(int32) | false | none | Number of total matches by Category and as a Total. |
CorpLinkedProfiles
{
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompaniesOld": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Returns the Linked Company profiles with suggested risks.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| linkedCompanies | [AssociateCorp]¦null | false | none | Represents the Linked Companies of an entity. |
| linkedCompaniesOld | [AssociateCorp]¦null | false | none | Represents the old Linked Companies of an entity. This is only available if entity has been Updated in monitoring. |
CorpMonitoringScanHistoryLog
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry"
}
Represents details of the automated corporate monitoring scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string¦null | false | none | Monitoring Scan or Rescan. |
| totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
| matchType | string¦null | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| addressPolicy | string¦null | false | none | Address policy scanned. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
CorpMonitoringScanResults
{
"organisation": "string",
"user": "string",
"categoryResults": [
{
"category": "string",
"matchedCompanies": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"watchlistsScanned": [
"string"
],
"watchlistsNote": "string",
"entities": [
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalCompaniesMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"companiesReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddress": "ApplyDefaultCountry"
}
Represents corporate batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the scan. |
| user | string¦null | false | none | The User performing the scan. |
| categoryResults | [CorpCategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| dataSources | string¦null | false | none | Scan against selected data sources. This is useful for organisations that may choose to change Data Sources between scans. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| entities | [CorpScanHistoryLog0]¦null | false | none | List of matched entities. |
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string¦null | false | none | Monitoring Scan or Rescan. |
| totalCompaniesMonitored | integer(int32) | false | none | Total number of companies being actively monitored in the monitoring list. |
| newMatches | integer(int32) | false | none | Number of new matches found against the detected changes in the watchlists. New Matches may include new profiles being added to the watchlists or updated profile information that matches with the company. |
| updatedEntities | integer(int32) | false | none | Number of existing matching profiles updated. These are existing matches for the company which have had changes detected in the watchlists. |
| removedMatches | integer(int32) | false | none | Number of matches removed based on detected changes in the watchlists. Matches may be removed due to removal from the watchlists or updated profiles no longer matching the company. |
| status | string¦null | false | none | Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error. |
| reviewStatus | string¦null | false | none | Review status in the monitoring scan. |
| companiesReviewed | integer(int32)¦null | false | none | Number of reviewed results by the users in the monitoring scan. |
| matchType | string¦null | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| addressPolicy | string¦null | false | none | Address policy scanned. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
CorpNameDetail
{
"nameType": "string",
"entityName": "string"
}
Represents other aliases and also known as names of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | Type of name. |
| entityName | string¦null | false | none | The company name. |
CorpRiskAssessmentCountryDetail
{
"answer": "string",
"score": 0
}
Represents the country-specific details used in a corporate risk assessment, including the country name and its associated risk score.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| answer | string¦null | false | none | Represents country name used in assessment. |
| score | integer(int32)¦null | false | none | Provides the score assigned to the country based on its associated risk level. |
CorpRiskAssessmentHistoryDetail
{
"corpRiskAssessmentParam": {
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"companyName": "string",
"clientId": "string",
"legalStatusId": 0,
"otherLegalStatus": "string",
"clientVisitId": 0,
"industryTypeId": 0,
"incorporationCountryCode": "string",
"highRiskCountriesCode": "string",
"fatfCountriesCode": "string",
"shareholderCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"hasPEP": true,
"isSanctioned": true,
"hasSanctions": true,
"hasAdverseMedia": true
},
"corpRiskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"riskAssessmentServiceEnabled": true
}
Details of the corporate scan parameters and information used to scan, and risk assessment result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| corpRiskAssessmentParam | CorpRiskAssessmentParamHistory¦null | false | none | Scan parameters and corporate risk assessment information that were scanned. |
| corpRiskAssessmentResult | CorpRiskAssessmentResult¦null | false | none | The result of the corporate risk assessment check. |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
| riskAssessmentServiceEnabled | boolean | false | none | Indicates whether the risk assessment service is enabled. |
CorpRiskAssessmentInputParam
{
"companyName": "Example Corporation Pty Ltd",
"clientId": "CORP-001",
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}
Represents risk assessment input scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| clientId | string¦null | false | none | Your Customer Reference, Client or Account ID to uniquely identify the entity. |
| legalStatusId | integer(int32) | true | none | The legal status ID of the corporate entity, used to determine risk. |
| otherLegalStatus | string¦null | false | none | Specifies any other legal status of the corporate entity. Optional field. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the corporate entity, used to determine risk. |
| industryTypeId | integer(int32) | true | none | The industry type ID of the corporate entity, used to determine risk. |
| incorporationCountryCode | string | true | Length: 1 - undefined | The country code of incorporation for the corporate entity, used to determine risk. |
| highRiskCountriesCode | string¦null | false | none | Comma-separated list of high-risk country codes associated with the corporate entity. Optional field. |
| fatfCountriesCode | string¦null | false | none | Comma-separated list of FATF country codes associated with the corporate entity. Optional field. |
| shareholderCountryCode | string | true | Length: 1 - undefined | Comma-separated list of shareholder country codes, used to determine corporate risk. |
| productId | integer(int32) | true | none | The product ID associated with the corporate entity, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the corporate entity, used to determine risk. |
| hasPEP | boolean | false | none | Indicates whether the corporate entity has any Politically Exposed Persons (PEPs). |
| isSanctioned | boolean | false | none | Indicates whether the corporate entity is listed on any sanctions lists. |
| hasSanctions | boolean | false | none | Indicates whether the corporate entity is associated with any sanctions. Default is false. |
| hasAdverseMedia | boolean | false | none | Indicates whether the corporate entity is associated with any adverse media coverage. Default is false. |
CorpRiskAssessmentInputParamHistory
{
"companyName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyName | string¦null | false | none | Company name. |
| clientId | string¦null | false | none | The client ID associated with the company scan. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | The date and time when the scan was performed. |
| updatedDate | string(date-time) | false | none | The date and time when the scan information was last updated. |
CorpRiskAssessmentItem
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
Details of the corporate risk assessment.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countries | [CorpRiskAssessmentCountryDetail]¦null | false | none | List of country-specific details. |
| category | string¦null | false | none | Risk assessment question category. |
| question | string¦null | false | none | Risk assessment question. |
| answer | string¦null | false | none | The answer provided for the corresponding risk assessment question. |
| score | integer(int32)¦null | false | none | The score associated with the answer, if applicable. |
CorpRiskAssessmentParamHistory
{
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"companyName": "string",
"clientId": "string",
"legalStatusId": 0,
"otherLegalStatus": "string",
"clientVisitId": 0,
"industryTypeId": 0,
"incorporationCountryCode": "string",
"highRiskCountriesCode": "string",
"fatfCountriesCode": "string",
"shareholderCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"hasPEP": true,
"isSanctioned": true,
"hasSanctions": true,
"hasAdverseMedia": true
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | The date and time when the scan was performed. |
| updatedDate | string(date-time) | false | none | The date and time when the scan information was last updated. |
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| clientId | string¦null | false | none | Your Customer Reference, Client or Account ID to uniquely identify the entity. |
| legalStatusId | integer(int32) | true | none | The legal status ID of the corporate entity, used to determine risk. |
| otherLegalStatus | string¦null | false | none | Specifies any other legal status of the corporate entity. Optional field. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the corporate entity, used to determine risk. |
| industryTypeId | integer(int32) | true | none | The industry type ID of the corporate entity, used to determine risk. |
| incorporationCountryCode | string | true | Length: 1 - undefined | The country code of incorporation for the corporate entity, used to determine risk. |
| highRiskCountriesCode | string¦null | false | none | Comma-separated list of high-risk country codes associated with the corporate entity. Optional field. |
| fatfCountriesCode | string¦null | false | none | Comma-separated list of FATF country codes associated with the corporate entity. Optional field. |
| shareholderCountryCode | string | true | Length: 1 - undefined | Comma-separated list of shareholder country codes, used to determine corporate risk. |
| productId | integer(int32) | true | none | The product ID associated with the corporate entity, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the corporate entity, used to determine risk. |
| hasPEP | boolean | false | none | Indicates whether the corporate entity has any Politically Exposed Persons (PEPs). |
| isSanctioned | boolean | false | none | Indicates whether the corporate entity is listed on any sanctions lists. |
| hasSanctions | boolean | false | none | Indicates whether the corporate entity is associated with any sanctions. Default is false. |
| hasAdverseMedia | boolean | false | none | Indicates whether the corporate entity is associated with any adverse media coverage. Default is false. |
CorpRiskAssessmentResult
{
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
Represents individual risk assessment result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalScore | integer(int32) | false | none | Represents the total score calculated based on all risk assessment responses. |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
| corpRiskResult | [CorpRiskAssessmentItem]¦null | false | none | List of corporate risk assessment result. |
Enumerated Values
| Property | Value |
|---|---|
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
CorpRiskAssessmentScanResult
{
"scanId": 0,
"corpRiskAssessmentParam": {
"companyName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"corpRiskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"corpRiskResult": [
{
"countries": [
{
"answer": "string",
"score": 0
}
],
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Represents corporate risk assessment scan result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /riskassessment/corp-scans/{scanId} API method to get details of this corp scan. |
| corpRiskAssessmentParam | CorpRiskAssessmentInputParamHistory¦null | false | none | Scan parameters and corporate risk assessment information that were scanned. |
| corpRiskAssessmentResult | CorpRiskAssessmentResult¦null | false | none | The result of the corporate risk assessment check. |
CorpRiskAssessmentUpdateParam
{
"legalStatusId": 1,
"otherLegalStatus": "",
"clientVisitId": 2,
"industryTypeId": 1,
"incorporationCountryCode": "AU",
"highRiskCountriesCode": "AO;BS",
"fatfCountriesCode": "AO;BG",
"shareholderCountryCode": "AU;AT",
"productId": 2,
"deliveryChannelId": 3,
"hasPEP": false,
"isSanctioned": false,
"hasSanctions": false,
"hasAdverseMedia": false
}
Represents the input parameters required to perform or update a corporate risk assessment check.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| legalStatusId | integer(int32) | true | none | The legal status ID of the corporate entity, used to determine risk. |
| otherLegalStatus | string¦null | false | none | Specifies any other legal status of the corporate entity. Optional field. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the corporate entity, used to determine risk. |
| industryTypeId | integer(int32) | true | none | The industry type ID of the corporate entity, used to determine risk. |
| incorporationCountryCode | string | true | Length: 1 - undefined | The country code of incorporation for the corporate entity, used to determine risk. |
| highRiskCountriesCode | string¦null | false | none | Comma-separated list of high-risk country codes associated with the corporate entity. Optional field. |
| fatfCountriesCode | string¦null | false | none | Comma-separated list of FATF country codes associated with the corporate entity. Optional field. |
| shareholderCountryCode | string | true | Length: 1 - undefined | Comma-separated list of shareholder country codes, used to determine corporate risk. |
| productId | integer(int32) | true | none | The product ID associated with the corporate entity, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the corporate entity, used to determine risk. |
| hasPEP | boolean | false | none | Indicates whether the corporate entity has any Politically Exposed Persons (PEPs). |
| isSanctioned | boolean | false | none | Indicates whether the corporate entity is listed on any sanctions lists. |
| hasSanctions | boolean | false | none | Indicates whether the corporate entity is associated with any sanctions. Default is false. |
| hasAdverseMedia | boolean | false | none | Indicates whether the corporate entity is associated with any adverse media coverage. Default is false. |
CorpScanEntity
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"name": "string",
"matchRate": 0,
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Represents the scan result of the Corporate scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resultId | integer(int32) | false | none | The identifier of each matched entity. It should be used when requesting the GET /corp-scans/single/results/{id} API method to get the entity profile information. |
| uniqueId | integer(int32) | false | none | The unique identifier of matched entity. |
| resultEntity | EntityCorp¦null | false | none | Represents detail profile of matched entiry. |
| monitoredOldEntity | EntityCorp¦null | false | none | Represents old detail profile of monitored entiry. This only available if monitoringStatus is UpdatedMatches. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| matchedFields | string¦null | false | none | Indicates matched fields. Contains combination of AKA, PrimaryName, FullPrimaryName, Country and IDNumber values. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| name | string¦null | false | none | The name of the matched company. |
| matchRate | integer(int32)¦null | false | none | For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close). |
| primaryLocation | string¦null | false | none | The primary location of the matched company. |
| decisionDetail | DecisionDetail¦null | false | none | A list of due diligence decisions for matched entity. (If clientId/entityNumber was not included in the scan, decision will not available). |
| aiAnalysisQuestionCount | integer(int32)¦null | false | none | Number of AIAnalysis questions asked for matched entity. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and locations. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and locations. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
CorpScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"kybScanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Details of the scan parameters and company information used to scan, and list of possible matches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | CorpScanInputParamHistory | true | none | Scan parameters and company information used to scan. |
| scanResult | CorpScanResult | true | none | Lists Found Entities identified from the Watchlists as possible matches. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
CorpScanHistoryLog
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"kybProductsCount": 0,
"kybCompanyProfileCount": 0,
"isPaS": true,
"isKYB": true,
"isRiskAssessment": true,
"scanService": "PepAndSanction",
"supportingDocumentNames": [
"string"
],
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
Represents corporate scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | false | none | Date of scan. |
| scanType | string¦null | false | none | Scan type. See supported values below. |
| matchType | string¦null | false | none | Match type scanned. See supported values below. |
| whitelist | string¦null | 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. |
| isRiskAssessment | boolean¦null | false | none | Identifies that Risk Assessment is performed or not. |
| scanService | string¦null | false | none | Type of service for scan. |
| supportingDocumentNames | [string]¦null | false | none | List of supporting document names associated with a specific scan. |
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| matches | integer(int32) | false | none | Number of matches found for the company. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| companyName | string¦null | false | none | The company name scanned. |
| registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| 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). |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| scanService | PepAndSanction |
| scanService | KYB |
| scanService | RiskAssessment |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
CorpScanHistoryLog0
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"companyName": "string",
"registrationNumber": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
Represents the scan history data scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| matches | integer(int32) | false | none | Number of matches found for the company. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, SIE, SOE, POI. |
| companyName | string¦null | false | none | The company name scanned. |
| registrationNumber | string¦null | false | none | The company registration/ID number scanned. |
| 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). |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
CorpScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "ApplyAll",
"blankAddress": "Ignore",
"companyName": "Example Corporation Pty Ltd",
"idNumber": "12345678",
"registrationNumber": "12345678",
"clientId": "CORP-001",
"address": "123 Corporate Ave, Sydney NSW 2000",
"country": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "AU",
"registrationNumberSearch": false,
"allowDuplicateKYBScan": false
},
"watchlists": "",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
Scan parameters, which include match type and policy options, applicable to each scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| registrationNumber | string¦null | false | Length: 0 - 100 | Company Registration Number - such as ABN, ACN or equivalent. If you enter a Registration Number it will be used in the matching process and Company Name matches will be returned if the Registration Number is 'contained' in the watchlist record. |
| entityNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. |
| address | string¦null | false | Length: 0 - 255 | Company Address - you can enter the ISO 3166-1 2-letter country code, or the country name. You can also enter the full address (there are no restrictions imposed on the address format). Only the country component will be used for comparing country of operation or registration when the Country of Operation policy (addressPolicy) is applied. |
| country | [string]¦null | false | none | Company Country - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the company to the Monitoring List if clientId/entityNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing company with the same clientId/entityNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeAdvancedMedia | string¦null | false | none | Used for including advanced media results. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| kybParam | KYBInputParam¦null | false | none | KYB Input Parameters. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | Used for matching watchlist for scan profiles. The acceptable values are POI, SIE, Official Lists, SOE, Entity Type and Custom Watchlists. If watchlist is not passed or is NULL, the setting configured in the organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | RegistrationNumber |
CorpScanInputParamHistory
{
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanType | string¦null | false | none | Type of scan. |
| scanService | string¦null | false | none | Type of scan service. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User who performed the scan. |
| date | string(date-time) | false | none | Date of scan. |
| defaultCountry | string¦null | false | none | Default country of operation of scan. |
| watchLists | [string]¦null | false | none | Scan against selected watchlists. This selection can be changed by the Compliance Officer in Administration > Organisations > List Access tab. |
| watchlistsNote | string¦null | false | none | none |
| kybCountryCode | string¦null | false | none | Country Code. |
| matchType | string¦null | false | none | Used to determine how closely a watchlist corporate entity name must match a company before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| addressPolicy | string¦null | false | none | Used for matching corporate and watchlist profiles that have the same Country of Operation or Registration. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Operation in the Organisation's Scan Settings in the web application to apply the default Country if corporate addresses are blank. |
| companyName | string | true | Length: 0 - 255 | Company name - this field is mandatory. |
| registrationNumber | string¦null | false | Length: 0 - 100 | Company Registration Number - such as ABN, ACN or equivalent. If you enter a Registration Number it will be used in the matching process and Company Name matches will be returned if the Registration Number is 'contained' in the watchlist record. |
| entityNumber | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. This property has been superseded and will be deprecated in the future. Please use clientId instead. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the company. This is required if you wish to record due diligence decisions for any matched entities. |
| address | string¦null | false | Length: 0 - 255 | Company Address - you can enter the ISO 3166-1 2-letter country code, or the country name. You can also enter the full address (there are no restrictions imposed on the address format). Only the country component will be used for comparing country of operation or registration when the Country of Operation policy (addressPolicy) is applied. |
| country | [string]¦null | false | none | Company Country - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the company to the Monitoring List if clientId/entityNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing company with the same clientId/entityNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeAdvancedMedia | string¦null | false | none | Used for including advanced media results. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| kybParam | KYBInputParam¦null | false | none | KYB Input Parameters. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | Used for matching watchlist for scan profiles. The acceptable values are POI, SIE, Official Lists, SOE, Entity Type and Custom Watchlists. If watchlist is not passed or is NULL, the setting configured in the organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | KYB |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| whitelist | Apply |
| whitelist | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddress | ApplyDefaultCountry |
| blankAddress | Ignore |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | RegistrationNumber |
CorpScanResult
{
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"fatfJurisdictionRiskResult": [
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"kybScanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
},
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string"
}
Lists the scan match results of the Company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The matada about result. |
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /corp-scans/single/{id} API method to get details of this company scan. |
| resultUrl | string¦null | false | none | This URL provides a link to view the scan information and details of the matched companies. Valid credentials are required as well as authorisation to view the scan results. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| matchedNumber | integer(int32) | false | none | Number of matched entities found. 0 means no matches found. |
| matchedEntities | [CorpScanEntity]¦null | false | none | List of matched entities. |
| webSearchResults | [WebSearchResult]¦null | false | none | List of adverse media results on the web using Google search engine. |
| advancedMediaResults | [AdvancedMediaResult]¦null | false | none | List of Advanced Media results. |
| fatfJurisdictionRiskResult | [FATFJurisdictionRiskInfo]¦null | false | none | List of jurisdiction risk results. |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
| kybScanResult | KYBScanResult¦null | false | none | List of companies and products history of Know Your Business scans. |
| monitoringReviewStatus | boolean¦null | false | none | Monitoring Review Status. |
| monitoringReviewSummary | string¦null | false | none | Monitoring Review Summary message. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
Country
{
"countryType": "string",
"countryValue": "string"
}
For individuals, this represents the country of nationality or citizenship. For entities, this represents the country where the entity is registered.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryType | string¦null | false | none | Relationship of the entity to the country. |
| countryValue | string¦null | false | none | Country name. |
DLResult
{
"requestParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| requestParam | IdCheckDriverLicence¦null | false | none | none |
| result | DvsDLResult¦null | false | none | none |
DataBreachCheckInputParam
{
"emailAddress": "string"
}
Data Breach Check parameter.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Used for compromised email checks. Enter the member’s email address to run a check on compromised information in known data breaches. |
DataBreachCheckResult
{
"name": "string",
"domain": "string",
"breachDate": "string",
"description": "string",
"logoPath": "string",
"dataClasses": [
"string"
]
}
Data Breach Check result, list results for data breaches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | Name of site where email breached. |
| domain | string¦null | false | none | Domain link of email breach. |
| breachDate | string¦null | false | none | Breach date of email breach. |
| description | string¦null | false | none | Description of email breach. |
| logoPath | string¦null | false | none | Logo path of email breach company. |
| dataClasses | [string]¦null | false | none | List of data breached which includes email address, passwords etc. |
DataSourceIndicator
{
"code": "string",
"dataSource": "string"
}
Represents a single datasource indicator for a country verification.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The datasource prefix code (e.g., "GVT", "CRD"). |
| dataSource | string¦null | false | none | The human-readable datasource category name (e.g., "Government Verification"). |
Date
{
"dateType": "string",
"dateValue": "string"
}
Represents different type of entity's date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateType | string¦null | false | none | Type of date. |
| dateValue | string¦null | false | none | Value of date. |
DecisionDetail
{
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
Returns the due diligence decision, match decision and assessed risk of a member or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| text | string¦null | false | none | Description of the due diligence decision. |
| matchDecision | string¦null | false | none | Due diligence match decision. The options are: Match, NoMatch, NotSure or NotReviewed (NotReviewed can be applicable until a decision is made). |
| assessedRisk | string¦null | false | none | Allocate an assessed risk. This only applies if matchDecision is set to Match or NotSure. The options available are Unallocated (default), High, Medium or Low. |
| comment | string¦null | false | Length: 0 - 200 | Optional - additional comment or reason for the decision. |
Enumerated Values
| Property | Value |
|---|---|
| matchDecision | Match |
| matchDecision | NoMatch |
| matchDecision | NotSure |
| matchDecision | NotReviewed |
| matchDecision | Unknown |
| assessedRisk | Unallocated |
| assessedRisk | Low |
| assessedRisk | Med |
| assessedRisk | High |
DecisionHistory
{
"username": "string",
"date": "2019-08-24T14:15:22Z",
"decision": "string",
"comment": "string"
}
Returns the due diligence decisions for a person or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| username | string¦null | false | none | The user who recorded the decision. |
| date | string(date-time) | false | none | The date and time of decision. |
| decision | string¦null | false | none | The status and risk of decision. |
| comment | string¦null | false | none | Additional comment entered with the decision. |
DecisionInfo
{
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
Contains scan due diligence decisions count and risk information.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| match | integer(int32) | false | none | Number of Match decisions. |
| noMatch | integer(int32) | false | none | Number of No Match decisions. |
| notSure | integer(int32) | false | none | Number of Not Sure decisions. |
| notReviewed | integer(int32) | false | none | Number of Not Reviewed decisions. |
| risk | string¦null | false | none | Assessed risk on Match or NotSure decisions. Combination of H for High, M for Medium and L for Low. |
DecisionParam
{
"matchDecision": "Match",
"assessedRisk": "High",
"comment": "Confirmed true match."
}
Record due diligence decision, match decision and assessed risk of a member or corporate entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchDecision | string¦null | false | none | Due diligence match decision. The options are: Match, NoMatch, NotSure or NotReviewed (NotReviewed can be applicable until a decision is made). |
| assessedRisk | string¦null | false | none | Allocate an assessed risk. This only applies if matchDecision is set to Match or NotSure. The options available are Unallocated (default), High, Medium or Low. |
| comment | string¦null | false | Length: 0 - 200 | Optional - additional comment or reason for the decision. |
Enumerated Values
| Property | Value |
|---|---|
| matchDecision | Match |
| matchDecision | NoMatch |
| matchDecision | NotSure |
| matchDecision | NotReviewed |
| matchDecision | Unknown |
| assessedRisk | Unallocated |
| assessedRisk | Low |
| assessedRisk | Med |
| assessedRisk | High |
DecisionResult
{
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
}
}
Returns brief information of added decision and decisions count of main scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information of main scan. |
| decisionDetail | DecisionDetail¦null | false | none | The applied due diligence decision. |
Description
{
"description1": "string",
"description2": "string",
"description3": "string"
}
Represents the master list of classification.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description1 | string¦null | false | none | Contains the major watchlist category description. |
| description2 | string¦null | false | none | Contains the minor watchlist category description. |
| description3 | string¦null | false | none | Contains other additional watchlist category description.Note: Decommissioned on 1 July 2020. |
DetailsOptical
{
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| overallStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| docType | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| expiry | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| imageQA | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| mrz | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| pagesCount | integer(int32) | false | none | none |
| security | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| text | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| vds | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| overallStatus | ERROR |
| overallStatus | OK |
| overallStatus | WAS_NOT_DONE |
| docType | ERROR |
| docType | OK |
| docType | WAS_NOT_DONE |
| expiry | ERROR |
| expiry | OK |
| expiry | WAS_NOT_DONE |
| imageQA | ERROR |
| imageQA | OK |
| imageQA | WAS_NOT_DONE |
| mrz | ERROR |
| mrz | OK |
| mrz | WAS_NOT_DONE |
| security | ERROR |
| security | OK |
| security | WAS_NOT_DONE |
| text | ERROR |
| text | OK |
| text | WAS_NOT_DONE |
| vds | ERROR |
| vds | OK |
| vds | WAS_NOT_DONE |
DirectorShip
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
Represents the detail hierarchy of directorship.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | The identifier of the directorship. |
| parentId | string¦null | false | none | The parent identifier of the directorship. This refers identifier of the directorship i.e. DirectorShip.ID. |
| role | string¦null | false | none | The role of the director. |
| name | string¦null | false | none | The name of the director. |
| type | string¦null | false | none | Provides the type of the directorship. |
| holdings | string¦null | false | none | Provides holdings of the director. |
| address | string¦null | false | none | Address of the director. |
| appointDate | string¦null | false | none | Appointed date of the director. |
DisqualifiedDirector
{
"caseReference": "string",
"company": "string",
"reason": "string",
"from": "string",
"to": "string"
}
Represents details of the disqualifications. This is applicable to UK only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseReference | string¦null | false | none | The unique Companies House identification number of the disqualification. |
| company | string¦null | false | none | The name of the company that the person was acting for. |
| reason | string¦null | false | none | The reason for the disqualification. |
| from | string¦null | false | none | Start date of the disqualification. |
| to | string¦null | false | none | End date of the disqualificaiton. |
DvsDLResult
{
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | string¦null | false | none | none |
| verificationRequestNumber | string¦null | false | none | none |
| errors | [VerificationResultError]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| result | NotVerified |
| result | Verified |
| result | Pass |
| result | PartialPass |
| result | Fail |
| result | Pending |
| result | Incomplete |
| result | NotRequested |
| result | ReviewRequired |
| result | InvalidData |
| result | TechnicalError |
| result | All |
DvsResult
{
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string¦null | false | none | none |
| result | string¦null | false | none | none |
| verificationRequestNumber | string¦null | false | none | none |
| errors | [VerificationResultError]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| result | NotVerified |
| result | Verified |
| result | Pass |
| result | PartialPass |
| result | Fail |
| result | Pending |
| result | Incomplete |
| result | NotRequested |
| result | ReviewRequired |
| result | InvalidData |
| result | TechnicalError |
| result | All |
ElementDetailsListItem
{
"elementType": "BLANK",
"elementResult": "ERROR",
"elementDiagnose": "UNKNOWN",
"image": {
"format": "string",
"image": "string"
},
"etalonImage": {
"format": "string",
"image": "string"
},
"percentValue": 0,
"lightIndex": "OFF",
"sourceImage": {
"format": "string",
"image": "string"
},
"resultImages": {
"count": 0,
"images": [
{
"format": "string",
"image": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| elementType | string¦null | false | none | none |
| elementResult | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| elementDiagnose | string¦null | false | none | Represents result and error codes returned during document processing and verification. - UNKNOWN: Unknown. - PASS: Successful verification. - INVALID_INPUT_DATA: Invalid input data. - INTERNAL_ERROR: Internal error. - EXCEPTION_IN_MODULE: Exception occurred in module. - UNCERTAIN_VERIFICATION: Uncertain verification result. - NECESSARY_IMAGE_NOT_FOUND: Necessary image not found. - PHOTO_SIDES_NOT_FOUND: Photo sides not found. - INVALID_CHECKSUM: Invalid checksum. - SYNTAX_ERROR: Syntax error. - LOGIC_ERROR: Logic error. - SOURCES_COMPARISON_ERROR: Sources comparison error. - FIELDS_COMPARISON_LOGIC_ERROR: Fields comparison logic error. - INVALID_FIELD_FORMAT: Invalid field format. - TRUE_LUMINESCENCE_ERROR: True luminescence error. - FALSE_LUMINESCENCE_ERROR: False luminescence error. - FIXED_PATTERN_ERROR: Fixed pattern error. - LOW_CONTRAST_IN_IR_LIGHT: Low contrast in IR light. - INCORRECT_BACKGROUND_LIGHT: Incorrect background light. - BACKGROUND_COMPARISON_ERROR: Background comparison error. - INCORRECT_TEXT_COLOR: Incorrect text color. - PHOTO_FALSE_LUMINESCENCE: Photo false luminescence. - TOO_MUCH_SHIFT: Too much shift detected. - CONTACT_CHIP_TYPE_MISMATCH: Contact chip type mismatch. - FIBERS_NOT_FOUND: Fibers not found. - TOO_MANY_OBJECTS: Too many objects detected. - SPECKS_IN_UV: Specks detected in UV. - TOO_LOW_RESOLUTION: Image resolution too low. - INVISIBLE_ELEMENT_PRESENT: Invisible element present. - VISIBLE_ELEMENT_ABSENT: Visible element absent. - ELEMENT_SHOULD_BE_COLORED: Element should be colored. - ELEMENT_SHOULD_BE_GRAYSCALE: Element should be grayscale. - PHOTO_WHITE_IR_DONT_MATCH: Photo white IR does not match. - UV_DULL_PAPER_MRZ: UV dull paper detected in MRZ. - FALSE_LUMINESCENCE_IN_MRZ: False luminescence in MRZ. - UV_DULL_PAPER_PHOTO: UV dull paper detected in photo. - UV_DULL_PAPER_BLANK: UV dull paper detected in blank area. - UV_DULL_PAPER_ERROR: UV dull paper error. - FALSE_LUMINESCENCE_IN_BLANK: False luminescence in blank area. - BAD_AREA_IN_AXIAL: Bad area detected in axial light. - FALSE_IPI_PARAMETERS: False IPI parameters. - ENCRYPTED_IPI_NOT_FOUND: Encrypted IPI not found. - ENCRYPTED_IPI_DATA_DONT_MATCH: Encrypted IPI data does not match. - FIELD_POS_CORRECTOR_HIGHLIGHT_IR: Field position corrector IR highlight error. - FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA: Glares in photo area detected. - FIELD_POS_CORRECTOR_PHOTO_REPLACED: Photo replacement detected. - FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR: Landmarks check error. - FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR: Face presence check error. - FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR: Face absence check error. - FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION: Incorrect head position. - FIELD_POS_CORRECTOR_AGE_CHECK_ERROR: Age check error. - FIELD_POS_CORRECTOR_SEX_CHECK_ERROR: Sex check error. - OVI_IR_INVISIBLE: OVI invisible in IR. - OVI_INSUFFICIENT_AREA: OVI insufficient area. - OVI_COLOR_INVARIABLE: OVI color invariable. - OVI_BAD_COLOR_FRONT: OVI bad front color. - OVI_BAD_COLOR_SIDE: OVI bad side color. - OVI_WIDE_COLOR_SPREAD: OVI wide color spread. - OVI_BAD_COLOR_PERCENT: OVI bad color percentage. - HOLOGRAM_ELEMENT_ABSENT: Hologram element absent. - HOLOGRAM_SIDE_TOP_IMAGES_ABSENT: Hologram side/top images absent. - HOLOGRAM_ELEMENT_PRESENT: Hologram element present. - HOLOGRAM_FRAMES_IS_ABSENT: Hologram frames absent. - HOLOGRAM_HOLO_FIELD_IS_ABSENT: Hologram holo field absent. - PHOTO_PATTERN_INTERRUPTED: Photo pattern interrupted. - PHOTO_PATTERN_SHIFTED: Photo pattern shifted. - PHOTO_PATTERN_DIFFERENT_COLORS: Photo pattern has different colors. - PHOTO_PATTERN_IR_VISIBLE: Photo pattern visible in IR. - PHOTO_PATTERN_NOT_INTERSECT: Photo pattern does not intersect. - PHOTO_SIZE_IS_WRONG: Photo size is wrong. - PHOTO_PATTERN_INVALID_COLOR: Photo pattern invalid color. - PHOTO_PATTERN_SHIFTED_VERT: Photo pattern vertically shifted. - PHOTO_PATTERN_PATTERN_NOT_FOUND: Photo pattern not found. - PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS: Photo pattern different line thickness. - PHOTO_IS_NOT_RECTANGLE: Photo is not rectangular. - PHOTO_CORNERS_IS_WRONG: Photo corners are wrong. - DOCUMENT_IS_CANCELLING: Document is cancelling. - TEXT_COLOR_SHOULD_BE_BLUE: Text color should be blue. - TEXT_COLOR_SHOULD_BE_GREEN: Text color should be green. - TEXT_COLOR_SHOULD_BE_RED: Text color should be red. - TEXT_SHOULD_BE_BLACK: Text should be black. - TEXT_IS_ABSENT: Text is absent. - BARCODE_WAS_READ_WITH_ERRORS: Barcode read with errors. - BARCODE_DATA_FORMAT_ERROR: Barcode data format error. - BARCODE_SIZE_PARAMS_ERROR: Barcode size parameters error. - NOT_ALL_BARCODES_READ: Not all barcodes read. - GLARES_IN_BARCODE_AREA: Glares in barcode area. - NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK: No certificate for digital signature check. - PORTRAIT_COMPARISON_PORTRAITS_DIFFER: Portraits differ. - PORTRAIT_COMPARISON_NO_SERVICE_REPLY: No service reply. - PORTRAIT_COMPARISON_SERVICE_ERROR: Service error. - PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES: Not enough images. - PORTRAIT_COMPARISON_NO_LIVE_PHOTO: No live photo. - PORTRAIT_COMPARISON_NO_SERVICE_LICENSE: No service license. - PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED: No portrait detected. - MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS: Unsuitable light conditions. - MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE: No difference in white UV. - FINGERPRINTS_COMPARISON_MISMATCH: Fingerprints mismatch. - HOLO_PHOTO_FACE_NOT_DETECTED: Face not detected in holo photo. - HOLO_PHOTO_FACE_COMPARISON_FAILED: Holo photo face comparison failed. - HOLO_PHOTO_GLARE_IN_CENTER_ABSENT: Glare in center absent. - HOLO_PHOTO_HOLO_ELEMENT_SHAPE_ERROR: Holo element shape error. - HOLO_PHOTO_ALGORITHMS_STEPS_ERROR: Algorithms steps error. - HOLO_PHOTO_HOLO_AREAS_NOT_LOADED: Holo areas not loaded. - HOLO_PHOTO_FINISHED_BY_TIMEOUT: Finished by timeout. - HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME: Document outside frame. - LIVENESS_DEPTH_CHECK_FAILED: Liveness depth check failed. - MRZ_QUALITY_WRONG_SYMBOL_POSITION: MRZ wrong symbol position. - MRZ_QUALITY_WRONG_BACKGROUND: MRZ wrong background. - MRZ_QUALITY_WRONG_MRZ_WIDTH: MRZ wrong width. - MRZ_QUALITY_WRONG_MRZ_HEIGHT: MRZ wrong height. - MRZ_QUALITY_WRONG_LINE_POSITION: MRZ wrong line position. - MRZ_QUALITY_WRONG_FONT_TYPE: MRZ wrong font type. - OCR_QUALITY_TEXT_POSITION: OCR text position error. - OCR_QUALITY_INVALID_FONT: OCR invalid font. - OCR_QUALITY_INVALID_BACKGROUND: OCR invalid background. - LASINK_INVALID_LINES_FREQUENCY: LASINK invalid lines frequency. - DOC_LIVENESS_DOCUMENT_NOT_LIVE: Document not live. - DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED: Black and white copy detected. - DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED: Electronic device detected. - DOC_LIVENESS_INVALID_BARCODE_BACKGROUND: Invalid barcode background. - DOC_LIVENESS_VIRTUAL_CAMERA_DETECTED: Virtual camera detected. - CHD_ICAO_IDB_BASE32_ERROR: ICAO IDB Base32 error. - CHD_ICAO_IDB_ZIPPED_ERROR: ICAO IDB zipped error. - CHD_ICAO_IDB_MESSAGE_ZONE_EMPTY: ICAO IDB message zone empty. - CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT: ICAO IDB signature must be present. - CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT: ICAO IDB signature must not be present. - CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT: ICAO IDB certificate must not be present. - CHD_INCORRECT_OBJECT_COLOR: Incorrect object color. |
| image | ImageDetails¦null | false | none | none |
| etalonImage | ImageDetails¦null | false | none | none |
| percentValue | integer(int32) | false | none | none |
| lightIndex | string¦null | false | none | Represents illumination types used during document image capture. - OFF: No light. - WHITE_TOP: Upper/lower white light. - WHITE_SIDE: Side white light. - WHITE: White light. - IR: Infrared light. - UV: Ultraviolet light. - AXIAL_WHITE: Axial white light. |
| sourceImage | ImageDetails¦null | false | none | none |
| resultImages | ResultImageItem¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| elementType | BLANK |
| elementType | FILL |
| elementType | PHOTO |
| elementType | MRZ |
| elementType | FALSE_LUMINESCENCE |
| elementType | HOLO_SIMPLE |
| elementType | HOLO_VERIFY_STATIC |
| elementType | HOLO_VERIFY_MULTI_STATIC |
| elementType | HOLO_VERIFY_DYNAMIC |
| elementType | PATTERN_NOT_INTERRUPTED |
| elementType | PATTERN_NOT_SHIFTED |
| elementType | PATTERN_SAME_COLORS |
| elementType | PATTERN_IR_INVISIBLE |
| elementType | PHOTO_SIZE_CHECK |
| elementType | PORTRAIT_COMPARISON_VS_GHOST |
| elementType | PORTRAIT_COMPARISON_VS_RFID |
| elementType | PORTRAIT_COMPARISON_VS_VISUAL |
| elementType | BARCODE |
| elementType | PATTERN_DIFFERENT_LINES_THICKNESS |
| elementType | PORTRAIT_COMPARISON_VS_CAMERAMAIN |
| elementType | PORTRAIT_COMPARISON_RFID_VS_CAMERA |
| elementType | GHOST_PHOTO |
| elementType | CLEAR_GHOST_PHOTO |
| elementType | INVISIBLE_OBJECT |
| elementType | LOW_CONTRAST_OBJECT |
| elementType | PHOTO_COLOR |
| elementType | PHOTO_SHAPE |
| elementType | PHOTO_CORNERS |
| elementType | OCR |
| elementType | PORTRAIT_COMPARISON_EXT_VS_VISUAL |
| elementType | PORTRAIT_COMPARISON_EXT_VS_RFID |
| elementType | PORTRAIT_COMPARISON_EXT_VS_CAMERA |
| elementType | LIVENESS_DEPTH |
| elementType | MICRO_TEXT |
| elementType | FLUORESCENT_OBJECT |
| elementType | LANDMARK_CHECK |
| elementType | FACE_PRESENCE |
| elementType | FACE_ABSENCE |
| elementType | LIVENESS_SCREEN_CAPTURE |
| elementType | LIVENESS_ELECTRONIC_DEVICE |
| elementType | LIVENESS_OVI |
| elementType | BARCODE_SIZE_CHECK |
| elementType | LASINK |
| elementType | LIVENESS_MLI |
| elementType | LIVENESS_BARCODE_BACKGROUND |
| elementType | PORTRAIT_COMPARISON_VS_BARCODE |
| elementType | PORTRAIT_COMPARISON_RFID_VS_BARCODE |
| elementType | PORTRAIT_COMPARISON_EXT_VS_BARCODE |
| elementType | PORTRAIT_COMPARISON_BARCODE_VS_CAMERA |
| elementType | CHECK_DIGITAL_SIGNATURE |
| elementType | CONTACT_CHIP_CLASSIFICATION |
| elementType | HEAD_POSITION_CHECK |
| elementType | LIVENESS_BLACK_AND_WHITE_COPY_CHECK |
| elementType | LIVENESS_DYNAPRINT |
| elementType | LIVENESS_GEOMETRY_CHECK |
| elementType | AGE_CHECK |
| elementType | SEX_CHECK |
| elementResult | ERROR |
| elementResult | OK |
| elementResult | WAS_NOT_DONE |
| elementDiagnose | UNKNOWN |
| elementDiagnose | PASS |
| elementDiagnose | INVALID_INPUT_DATA |
| elementDiagnose | INTERNAL_ERROR |
| elementDiagnose | EXCEPTION_IN_MODULE |
| elementDiagnose | UNCERTAIN_VERIFICATION |
| elementDiagnose | NECESSARY_IMAGE_NOT_FOUND |
| elementDiagnose | PHOTO_SIDES_NOT_FOUND |
| elementDiagnose | INVALID_CHECKSUM |
| elementDiagnose | SYNTAX_ERROR |
| elementDiagnose | LOGIC_ERROR |
| elementDiagnose | SOURCES_COMPARISON_ERROR |
| elementDiagnose | FIELDS_COMPARISON_LOGIC_ERROR |
| elementDiagnose | INVALID_FIELD_FORMAT |
| elementDiagnose | TRUE_LUMINESCENCE_ERROR |
| elementDiagnose | FALSE_LUMINESCENCE_ERROR |
| elementDiagnose | FIXED_PATTERN_ERROR |
| elementDiagnose | LOW_CONTRAST_IN_IR_LIGHT |
| elementDiagnose | INCORRECT_BACKGROUND_LIGHT |
| elementDiagnose | BACKGROUND_COMPARISON_ERROR |
| elementDiagnose | INCORRECT_TEXT_COLOR |
| elementDiagnose | PHOTO_FALSE_LUMINESCENCE |
| elementDiagnose | TOO_MUCH_SHIFT |
| elementDiagnose | CONTACT_CHIP_TYPE_MISMATCH |
| elementDiagnose | FIBERS_NOT_FOUND |
| elementDiagnose | TOO_MANY_OBJECTS |
| elementDiagnose | SPECKS_IN_UV |
| elementDiagnose | TOO_LOW_RESOLUTION |
| elementDiagnose | INVISIBLE_ELEMENT_PRESENT |
| elementDiagnose | VISIBLE_ELEMENT_ABSENT |
| elementDiagnose | ELEMENT_SHOULD_BE_COLORED |
| elementDiagnose | ELEMENT_SHOULD_BE_GRAYSCALE |
| elementDiagnose | PHOTO_WHITE_IR_DONT_MATCH |
| elementDiagnose | UV_DULL_PAPER_MRZ |
| elementDiagnose | FALSE_LUMINESCENCE_IN_MRZ |
| elementDiagnose | UV_DULL_PAPER_PHOTO |
| elementDiagnose | UV_DULL_PAPER_BLANK |
| elementDiagnose | UV_DULL_PAPER_ERROR |
| elementDiagnose | FALSE_LUMINESCENCE_IN_BLANK |
| elementDiagnose | BAD_AREA_IN_AXIAL |
| elementDiagnose | FALSE_IPI_PARAMETERS |
| elementDiagnose | ENCRYPTED_IPI_NOT_FOUND |
| elementDiagnose | ENCRYPTED_IPI_DATA_DONT_MATCH |
| elementDiagnose | FIELD_POS_CORRECTOR_HIGHLIGHT_IR |
| elementDiagnose | FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA |
| elementDiagnose | FIELD_POS_CORRECTOR_PHOTO_REPLACED |
| elementDiagnose | FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR |
| elementDiagnose | FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR |
| elementDiagnose | FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR |
| elementDiagnose | FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION |
| elementDiagnose | FIELD_POS_CORRECTOR_AGE_CHECK_ERROR |
| elementDiagnose | FIELD_POS_CORRECTOR_SEX_CHECK_ERROR |
| elementDiagnose | OVI_IR_INVISIBLE |
| elementDiagnose | OVI_INSUFFICIENT_AREA |
| elementDiagnose | OVI_COLOR_INVARIABLE |
| elementDiagnose | OVI_BAD_COLOR_FRONT |
| elementDiagnose | OVI_BAD_COLOR_SIDE |
| elementDiagnose | OVI_WIDE_COLOR_SPREAD |
| elementDiagnose | OVI_BAD_COLOR_PERCENT |
| elementDiagnose | HOLOGRAM_ELEMENT_ABSENT |
| elementDiagnose | HOLOGRAM_SIDE_TOP_IMAGES_ABSENT |
| elementDiagnose | HOLOGRAM_ELEMENT_PRESENT |
| elementDiagnose | HOLOGRAM_FRAMES_IS_ABSENT |
| elementDiagnose | HOLOGRAM_HOLO_FIELD_IS_ABSENT |
| elementDiagnose | PHOTO_PATTERN_INTERRUPTED |
| elementDiagnose | PHOTO_PATTERN_SHIFTED |
| elementDiagnose | PHOTO_PATTERN_DIFFERENT_COLORS |
| elementDiagnose | PHOTO_PATTERN_IR_VISIBLE |
| elementDiagnose | PHOTO_PATTERN_NOT_INTERSECT |
| elementDiagnose | PHOTO_SIZE_IS_WRONG |
| elementDiagnose | PHOTO_PATTERN_INVALID_COLOR |
| elementDiagnose | PHOTO_PATTERN_SHIFTED_VERT |
| elementDiagnose | PHOTO_PATTERN_PATTERN_NOT_FOUND |
| elementDiagnose | PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS |
| elementDiagnose | PHOTO_IS_NOT_RECTANGLE |
| elementDiagnose | PHOTO_CORNERS_IS_WRONG |
| elementDiagnose | DOCUMENT_IS_CANCELLING |
| elementDiagnose | TEXT_COLOR_SHOULD_BE_BLUE |
| elementDiagnose | TEXT_COLOR_SHOULD_BE_GREEN |
| elementDiagnose | TEXT_COLOR_SHOULD_BE_RED |
| elementDiagnose | TEXT_SHOULD_BE_BLACK |
| elementDiagnose | TEXT_IS_ABSENT |
| elementDiagnose | BARCODE_WAS_READ_WITH_ERRORS |
| elementDiagnose | BARCODE_DATA_FORMAT_ERROR |
| elementDiagnose | BARCODE_SIZE_PARAMS_ERROR |
| elementDiagnose | NOT_ALL_BARCODES_READ |
| elementDiagnose | GLARES_IN_BARCODE_AREA |
| elementDiagnose | NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK |
| elementDiagnose | PORTRAIT_COMPARISON_PORTRAITS_DIFFER |
| elementDiagnose | PORTRAIT_COMPARISON_NO_SERVICE_REPLY |
| elementDiagnose | PORTRAIT_COMPARISON_SERVICE_ERROR |
| elementDiagnose | PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES |
| elementDiagnose | PORTRAIT_COMPARISON_NO_LIVE_PHOTO |
| elementDiagnose | PORTRAIT_COMPARISON_NO_SERVICE_LICENSE |
| elementDiagnose | PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED |
| elementDiagnose | MOBILE_IMAGES_UNSUITABLE_LIGHT_CONDITIONS |
| elementDiagnose | MOBILE_IMAGES_WHITE_UV_NO_DIFFERENCE |
| elementDiagnose | FINGERPRINTS_COMPARISON_MISMATCH |
| elementDiagnose | HOLO_PHOTO_FACE_NOT_DETECTED |
| elementDiagnose | HOLO_PHOTO_FACE_COMPARISON_FAILED |
| elementDiagnose | HOLO_PHOTO_GLARE_IN_CENTER_ABSENT |
| elementDiagnose | HOLO_PHOTO_HOLO_ELEMENT_SHAPE_ERROR |
| elementDiagnose | HOLO_PHOTO_ALGORITHMS_STEPS_ERROR |
| elementDiagnose | HOLO_PHOTO_HOLO_AREAS_NOT_LOADED |
| elementDiagnose | HOLO_PHOTO_FINISHED_BY_TIMEOUT |
| elementDiagnose | HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME |
| elementDiagnose | LIVENESS_DEPTH_CHECK_FAILED |
| elementDiagnose | MRZ_QUALITY_WRONG_SYMBOL_POSITION |
| elementDiagnose | MRZ_QUALITY_WRONG_BACKGROUND |
| elementDiagnose | MRZ_QUALITY_WRONG_MRZ_WIDTH |
| elementDiagnose | MRZ_QUALITY_WRONG_MRZ_HEIGHT |
| elementDiagnose | MRZ_QUALITY_WRONG_LINE_POSITION |
| elementDiagnose | MRZ_QUALITY_WRONG_FONT_TYPE |
| elementDiagnose | OCR_QUALITY_TEXT_POSITION |
| elementDiagnose | OCR_QUALITY_INVALID_FONT |
| elementDiagnose | OCR_QUALITY_INVALID_BACKGROUND |
| elementDiagnose | LASINK_INVALID_LINES_FREQUENCY |
| elementDiagnose | DOC_LIVENESS_DOCUMENT_NOT_LIVE |
| elementDiagnose | DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED |
| elementDiagnose | DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED |
| elementDiagnose | DOC_LIVENESS_INVALID_BARCODE_BACKGROUND |
| elementDiagnose | DOC_LIVENESS_VIRTUAL_CAMERA_DETECTED |
| elementDiagnose | CHD_ICAO_IDB_BASE32_ERROR |
| elementDiagnose | CHD_ICAO_IDB_ZIPPED_ERROR |
| elementDiagnose | CHD_ICAO_IDB_MESSAGE_ZONE_EMPTY |
| elementDiagnose | CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT |
| elementDiagnose | CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT |
| elementDiagnose | CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT |
| elementDiagnose | CHD_INCORRECT_OBJECT_COLOR |
| lightIndex | OFF |
| lightIndex | WHITE_TOP |
| lightIndex | WHITE_SIDE |
| lightIndex | WHITE |
| lightIndex | IR |
| lightIndex | UV |
| lightIndex | AXIAL_WHITE |
Entity
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Details of the person to help determine whether an identified match is true and the likelihood of the member being a risk under your organisation's AML/CTF obligations.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | integer(int32) | false | none | Unique identifier of the person. |
| dataSource | string¦null | false | none | Specifies the data source of the profile. |
| category | string¦null | false | none | Category of the person. |
| categories | string¦null | false | none | Full descriptive categories of the person. |
| subcategory | string¦null | false | none | Subcategory of the person.Note: Decommissioned on 1 July 2020. |
| suggestedRisk | string¦null | false | none | Represents the person's suggested risk level, determined by matching subcategory results against the predefined rules of the organisation. |
| gender | string¦null | false | none | Gender of the person. |
| deceased | string¦null | false | none | Deceased status of the person, if applicable. |
| primaryFirstName | string¦null | false | none | Primary first name of the person. |
| primaryMiddleName | string¦null | false | none | Primary middle name of the person. |
| primaryLastName | string¦null | false | none | Primary last name of the person. |
| position | string¦null | false | none | Position of the person, if available.Note: Decommissioned on 1 July 2020. |
| dateOfBirth | string¦null | false | none | Date of birth of the person. |
| deceasedDate | string¦null | false | none | Deceased date of the person, if applicable. |
| placeOfBirth | string¦null | false | none | Birth place of the person. |
| primaryLocation | string¦null | false | none | Person's primary location. |
| images | [string]¦null | false | none | List of URL links to the pictures of the person, if available. Note: Only Acuris |
| generalInfo | object¦null | false | none | Person's general information. Note: Only Acuris |
| » additionalProperties | string¦null | false | none | none |
| furtherInformation | string¦null | false | none | Further information of the person. |
| lastReviewed | string¦null | false | none | Last reviewed date of the record. |
| descriptions | [Description]¦null | false | none | Person's description list. |
| nameDetails | [NameDetail]¦null | false | none | Person's name detail list. |
| roles | [Role]¦null | false | none | List of roles of the PEP profile. |
| importantDates | [Date]¦null | false | none | List of important dates for the person. |
| nationalities | [string]¦null | false | none | List of nationalities for the person. |
| nationalitiesCodes | [string]¦null | false | none | List of nationalities country codes for the person. |
| locations | [Location]¦null | false | none | List of locations for the person. |
| countries | [Country]¦null | false | none | List of countries where the person has been located.Note: Decommissioned on 1 July 2020. |
| officialLists | [OfficialList]¦null | false | none | List of official lists where the person is found. |
| idNumbers | [IDNumber]¦null | false | none | List of registration/ID number of the person.Note: Decommissioned on 1 July 2020. |
| identifiers | [Identifier]¦null | false | none | List of registration/ID number of the person. |
| disqualifiedDirectors | [DisqualifiedDirector]¦null | false | none | List of disqualifications for the person. Note: Only Acuris |
| profileOfInterests | [ProfileOfInterest]¦null | false | none | List of Profile of Interest (POI) related details for the person. Note: Only Acuris |
| sources | [Source]¦null | false | none | List of all public sources, including both government and media sources, used to build the full profile. |
| linkedIndividuals | [AssociatePerson]¦null | false | none | List of individuals associated with the person. |
| linkedCompanies | [AssociateCorp]¦null | false | none | List of companies associated with the person. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and nationalities. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and nationalities. |
Enumerated Values
| Property | Value |
|---|---|
| suggestedRisk | Unallocated |
| suggestedRisk | Low |
| suggestedRisk | Med |
| suggestedRisk | High |
EntityCorp
{
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Details of the company entity to help determine whether an identified match is true.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uniqueId | integer(int32) | false | none | Unique identifier of the company. |
| dataSource | string¦null | false | none | Specifies the data source of the profile. |
| category | string¦null | false | none | Category of the company. |
| categories | string¦null | false | none | Full descriptive categories of the company. |
| subcategory | string¦null | false | none | Subcategory of the company.Note: Decommissioned on 1 July 2020. |
| suggestedRisk | string¦null | false | none | Represents the company's suggested risk level, determined by matching subcategory results against the predefined rules of the organisation. |
| primaryName | string¦null | false | none | Company primary name. |
| primaryLocation | string¦null | false | none | Company primary location. |
| images | [string]¦null | false | none | List of URL links to the pictures of the company, if available. Note: Only Acuris |
| generalInfo | object¦null | false | none | Company general information. Note: Only Acuris |
| » additionalProperties | string¦null | false | none | none |
| furtherInformation | string¦null | false | none | Additional information of the company. |
| lastReviewed | string¦null | false | none | Last reviewed date of the profile record. |
| descriptions | [Description]¦null | false | none | Company description list. |
| nameDetails | [CorpNameDetail]¦null | false | none | Detailed list of company name. |
| locations | [Location]¦null | false | none | List of locations the company is associated with. |
| countries | [Country]¦null | false | none | List of countries the company is located in.Note: Decommissioned on 1 July 2020. |
| officialLists | [OfficialList]¦null | false | none | List of official lists the company is found in. |
| idNumbers | [IDNumber]¦null | false | none | List of registration/ID number of the company.Note: Decommissioned on 1 July 2020. |
| identifiers | [Identifier]¦null | false | none | List of registration/ID number of the company. |
| profileOfInterests | [ProfileOfInterest]¦null | false | none | List of Profile of Interest (POI) related details for the company. Note: Only Acuris |
| sources | [Source]¦null | false | none | List of all public sources, including both government and media sources, used to build the full profile. |
| linkedIndividuals | [AssociatePerson]¦null | false | none | List of individuals associated with the company. |
| linkedCompanies | [AssociateCorp]¦null | false | none | List of companies associated with the company. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and locations. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and locations. |
Enumerated Values
| Property | Value |
|---|---|
| suggestedRisk | Unallocated |
| suggestedRisk | Low |
| suggestedRisk | Med |
| suggestedRisk | High |
FATFJurisdictionRiskInfo
{
"jurisdiction": "string",
"effectivenessScore": 0,
"effectivenessLevel": 0,
"complianceScore": 0,
"complianceLevel": 0,
"comments": "string",
"fatfCompliance": "string",
"fatfComplianceNotes": "string",
"fatfEffectiveness": "string",
"fatfEffectivenessNotes": "string",
"fatfEffectivenessSubtitles": "string",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
List of the person's jurisdiction risk information based on country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| jurisdiction | string¦null | false | none | Represents risk country name. |
| effectivenessScore | number(double) | false | none | Indicates Effectiveness Score of risk. |
| effectivenessLevel | integer(int32) | false | none | Indicates Effectiveness Level of risk. |
| complianceScore | number(double) | false | none | Indicates Effectiveness Level of risk. |
| complianceLevel | integer(int32) | false | none | Indicates Compliance Level of risk. |
| comments | string¦null | false | none | Overall comments of risk. |
| fatfCompliance | string¦null | false | none | Represents the type of FATF Compliance risk. |
| fatfComplianceNotes | string¦null | false | none | Indicates FATF Compliance risk notes. |
| fatfEffectiveness | string¦null | false | none | Represents the type of FATF Effectiveness risk. |
| fatfEffectivenessNotes | string¦null | false | none | Indicates FATF Effectiveness risk notes. |
| fatfEffectivenessSubtitles | string¦null | false | none | Indicates FATF Effectiveness risk Subtitles. |
| fatfBlackGreyRisk | integer(int32) | false | none | Represents FATF Black/Gray country risk. |
| countryCode | string¦null | false | none | Represents country code of risk. |
FDSIDListDetail
{
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | false | none | none |
| icaoCode | string¦null | false | none | none |
| list | [integer]¦null | false | none | none |
| dCountryName | string¦null | false | none | none |
| dFormat | string¦null | false | none | Represents supported document formats. - UNKNOWN: Unknown document format. - ID1: ID1 document format. - ID2: ID2 document format. - ID3: ID3 document format. - NON: Undefined document format. - A4: A4 document format. - ID3_X2: ID3 double document format. - ID2_TURKEY: Turkey ID2 card. - ID1_90: ID1 format document rotated by 90 degrees. - ID1_180: ID1 format document rotated by 180 degrees. - ID1_270: ID1 format document rotated by 270 degrees. - ID2_180: ID2 format document rotated by 180 degrees. - ID3_180: ID3 format document rotated by 180 degrees. - CUSTOM: Arbitrary format. - FLEXIBLE: Flexible format. Standard formats can be resized during cropping depending on various factors such as light and background. |
| dmrz | boolean | false | none | none |
| dType | string¦null | false | none | Represents supported document types. - NOT_DEFINED: Not defined. - PASSPORT: Passport. - IDENTITY_CARD: Identity card. - DIPLOMATIC_PASSPORT: Diplomatic passport. - SERVICE_PASSPORT: Service passport. - SEAMANS_IDENTITY_DOCUMENT: Seamans identity document. - IDENTITY_CARD_FOR_RESIDENCE: Identity card for residence. - TRAVEL_DOCUMENT: Travel document. - NATIONAL_IDENTITY_CARD: National identity card. - SOCIAL_IDENTITY_CARD: Social identity card. - ALIENS_IDENTITY_CARD: Alien's identity card. - PRIVILEGED_IDENTITY_CARD: Privileged identity card. - RESIDENCE_PERMIT_IDENTITY_CARD: Residence permit identity card. - ORIGIN_CARD: Origin card. - EMERGENCY_PASSPORT: Emergency passport. - ALIENS_PASSPORT: Alien's passport. - ALTERNATIVE_IDENTITY_CARD: Alternative identity card. - VISA_ID2: Visa ID2. - VISA_ID3: Visa ID3. - AUTHORIZATION_CARD: Authorization card. - BEGINNER_PERMIT: Beginner permit. - BORDER_CROSSING_CARD: Border crossing card. - CHAUFFEUR_LICENSE: Chauffeur license. - CHAUFFEUR_LICENSE_UNDER_18: Chauffeur license under 18. - CHAUFFEUR_LICENSE_UNDER_21: Chauffeur license under 21. - COMMERCIAL_DRIVING_LICENSE: Commercial driving license. - COMMERCIAL_DRIVING_LICENSE_INSTRUCTIONAL_PERMIT: Commercial driving license instructional permit. - COMMERCIAL_DRIVING_LICENSE_UNDER_18: Commercial driving license under 18. - COMMERCIAL_DRIVING_LICENSE_UNDER_21: Commercial driving license under 21. - COMMERCIAL_INSTRUCTION_PERMIT: Commercial instruction permit. - COMMERCIAL_NEW_PERMIT: Commercial new permit. - CONCEALED_CARRY_LICENSE: Concealed carry license. - CONCEALED_FIREARM_PERMIT: Concealed firearm permit. - CONDITIONAL_DRIVING_LICENSE: Conditional driving license. - DEPARTMENT_OF_VETERANS_AFFAIRS_IDENTITY_CARD: Department of veterans affairs identity card. - DIPLOMATIC_DRIVING_LICENSE: Diplomatic driving license. - DRIVING_LICENSE: Driving license. - DRIVING_LICENSE_INSTRUCTIONAL_PERMIT: Driving license instructional permit. - DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_18: Driving license instructional permit under 18. - DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_21: Driving license instructional permit under 21. - DRIVING_LICENSE_LEARNERS_PERMIT: Driving license learners permit. - DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_18: Driving license learners permit under 18. - DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_21: Driving license learners permit under 21. - DRIVING_LICENSE_NOVICE: Driving license novice. - DRIVING_LICENSE_NOVICE_UNDER_18: Driving license novice under 18. - DRIVING_LICENSE_NOVICE_UNDER_21: Driving license novice under 21. - DRIVING_LICENSE_REGISTERED_OFFENDER: Driving license registered offender. - DRIVING_LICENSE_RESTRICTED_UNDER_18: Driving license restricted under 18. - DRIVING_LICENSE_RESTRICTED_UNDER_21: Driving license restricted under 21. - DRIVING_LICENSE_TEMPORARY_VISITOR: Driving license temporary visitor. - DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_18: Driving license temporary visitor under 18. - DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_21: Driving license temporary visitor under 21. - DRIVING_LICENSE_UNDER_18: Driving license under 18. - DRIVING_LICENSE_UNDER_21: Driving license under 21. - EMPLOYMENT_DRIVING_PERMIT: Employment driving permit. - ENHANCED_CHAUFFEUR_LICENSE: Enhanced chauffeur license. - ENHANCED_COMMERCIAL_DRIVING_LICENSE: Enhanced commercial driving license. - ENHANCED_DRIVING_LICENSE: Enhanced driving license. - ENHANCED_IDENTITY_CARD: Enhanced identity card. - FIREARMS_PERMIT: Firearms permit. - FULL_PROVISIONAL_LICENSE: Full provisional license. - GENEVA_CONVENTIONS_IDENTITY_CARD: Geneva conventions identity card. - HANDGUN_CARRY_PERMIT: Handgun carry permit. - IDENTITY_AND_PRIVILEGE_CARD: Identity and privilege card. - OTHER: Other. - IMMIGRANT_VISA: Immigrant visa. - INTERIM_DRIVING_LICENSE: Interim driving license. - JUNIOR_DRIVING_LICENSE: Junior driving license. - LEARNER_LICENSE: Learner license. - LIMITED_LICENSE: Limited license. - NEW_PERMIT: New permit. - NON_US_CITIZEN_DRIVING_LICENSE: Non-US citizen driving license. - OCCUPATIONAL_DRIVING_LICENSE: Occupational driving license. - OPERATOR_LICENSE: Operator license. - PERMANENT_DRIVING_LICENSE: Permanent driving license. - PERMIT_TO_REENTER: Permit to re-enter. - PROVISIONAL_DRIVING_LICENSE: Provisional driving license. - PASSPORT_CARD: Passport card. - PERSONAL_IDENTIFICATION_VERIFICATION: Personal identification verification. - TEMPORARY_OPERATOR_LICENSE: Temporary operator license. - VISA: Visa. - TEMPORARY_PASSPORT: Temporary passport. - VOTING_CARD: Voting card. - HEALTH_CARD: Health card. - CERTIFICATE_OF_CITIZENSHIP: Certificate of citizenship. - ADDRESS_CARD: Address card. - AIRPORT_IMMIGRATION_CARD: Airport immigration card. - ALIEN_REGISTRATION_CARD: Alien registration card. - CREW_MEMBER_CERTIFICATE: Crew member certificate. - DOCUMENT_FOR_RETURN: Document for return. - EMPLOYMENT_CARD: Employment card. - LABOUR_CARD: Labour card. - LAISSEZ_PASSER: Laissez passer. - PASSPORT_STATELESS: Passport stateless. - PASSPORT_CHILD: Passport child. - PASSPORT_OFFICIAL: Passport official. - RESIDENCE_PERMIT: Residence permit. - DOCUMENT_OF_IDENTITY: Document of identity. - SIM_CARD: Sim card. - COMPANY_CARD: Company card. - DOMESTIC_PASSPORT: Domestic passport. - ARMED_FORCES_IDENTITY_CARD: Armed forces identity card. - MEMBERSHIP_CARD: Membership card. - PASSPORT_PAGE: Passport page. - INVOICE: Invoice. - PASSENGER_LOCATOR_FORM: Passenger locator form. |
| dDescription | string¦null | false | none | none |
| dYear | string¦null | false | none | none |
| isDeprecated | boolean | false | none | none |
| dStateCode | string¦null | false | none | none |
| dStateName | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dFormat | ID1 |
| dFormat | ID2 |
| dFormat | ID3 |
| dFormat | NON |
| dFormat | A4 |
| dFormat | ID3_X2 |
| dFormat | ID2_TURKEY |
| dFormat | ID1_90 |
| dFormat | ID1_180 |
| dFormat | ID1_270 |
| dFormat | ID2_180 |
| dFormat | ID3_180 |
| dFormat | CUSTOM |
| dFormat | FLEXIBLE |
| dFormat | UNKNOWN |
| dType | NOT_DEFINED |
| dType | PASSPORT |
| dType | IDENTITY_CARD |
| dType | DIPLOMATIC_PASSPORT |
| dType | SERVICE_PASSPORT |
| dType | SEAMANS_IDENTITY_DOCUMENT |
| dType | IDENTITY_CARD_FOR_RESIDENCE |
| dType | TRAVEL_DOCUMENT |
| dType | NATIONAL_IDENTITY_CARD |
| dType | SOCIAL_IDENTITY_CARD |
| dType | ALIENS_IDENTITY_CARD |
| dType | PRIVILEGED_IDENTITY_CARD |
| dType | RESIDENCE_PERMIT_IDENTITY_CARD |
| dType | ORIGIN_CARD |
| dType | EMERGENCY_PASSPORT |
| dType | ALIENS_PASSPORT |
| dType | ALTERNATIVE_IDENTITY_CARD |
| dType | VISA_ID2 |
| dType | VISA_ID3 |
| dType | AUTHORIZATION_CARD |
| dType | BEGINNER_PERMIT |
| dType | BORDER_CROSSING_CARD |
| dType | CHAUFFEUR_LICENSE |
| dType | CHAUFFEUR_LICENSE_UNDER_18 |
| dType | CHAUFFEUR_LICENSE_UNDER_21 |
| dType | COMMERCIAL_DRIVING_LICENSE |
| dType | COMMERCIAL_DRIVING_LICENSE_INSTRUCTIONAL_PERMIT |
| dType | COMMERCIAL_DRIVING_LICENSE_UNDER_18 |
| dType | COMMERCIAL_DRIVING_LICENSE_UNDER_21 |
| dType | COMMERCIAL_INSTRUCTION_PERMIT |
| dType | COMMERCIAL_NEW_PERMIT |
| dType | CONCEALED_CARRY_LICENSE |
| dType | CONCEALED_FIREARM_PERMIT |
| dType | CONDITIONAL_DRIVING_LICENSE |
| dType | DEPARTMENT_OF_VETERANS_AFFAIRS_IDENTITY_CARD |
| dType | DIPLOMATIC_DRIVING_LICENSE |
| dType | DRIVING_LICENSE |
| dType | DRIVING_LICENSE_INSTRUCTIONAL_PERMIT |
| dType | DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_18 |
| dType | DRIVING_LICENSE_INSTRUCTIONAL_PERMIT_UNDER_21 |
| dType | DRIVING_LICENSE_LEARNERS_PERMIT |
| dType | DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_18 |
| dType | DRIVING_LICENSE_LEARNERS_PERMIT_UNDER_21 |
| dType | DRIVING_LICENSE_NOVICE |
| dType | DRIVING_LICENSE_NOVICE_UNDER_18 |
| dType | DRIVING_LICENSE_NOVICE_UNDER_21 |
| dType | DRIVING_LICENSE_REGISTERED_OFFENDER |
| dType | DRIVING_LICENSE_RESTRICTED_UNDER_18 |
| dType | DRIVING_LICENSE_RESTRICTED_UNDER_21 |
| dType | DRIVING_LICENSE_TEMPORARY_VISITOR |
| dType | DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_18 |
| dType | DRIVING_LICENSE_TEMPORARY_VISITOR_UNDER_21 |
| dType | DRIVING_LICENSE_UNDER_18 |
| dType | DRIVING_LICENSE_UNDER_21 |
| dType | EMPLOYMENT_DRIVING_PERMIT |
| dType | ENHANCED_CHAUFFEUR_LICENSE |
| dType | ENHANCED_CHAUFFEUR_LICENSE_UNDER_18 |
| dType | ENHANCED_CHAUFFEUR_LICENSE_UNDER_21 |
| dType | ENHANCED_COMMERCIAL_DRIVING_LICENSE |
| dType | ENHANCED_DRIVING_LICENSE |
| dType | ENHANCED_DRIVING_LICENSE_UNDER_18 |
| dType | ENHANCED_DRIVING_LICENSE_UNDER_21 |
| dType | ENHANCED_IDENTITY_CARD |
| dType | ENHANCED_IDENTITY_CARD_UNDER_18 |
| dType | ENHANCED_IDENTITY_CARD_UNDER_21 |
| dType | ENHANCED_OPERATORS_LICENSE |
| dType | FIREARMS_PERMIT |
| dType | FULL_PROVISIONAL_LICENSE |
| dType | FULL_PROVISIONAL_LICENSE_UNDER_18 |
| dType | FULL_PROVISIONAL_LICENSE_UNDER_21 |
| dType | GENEVA_CONVENTIONS_IDENTITY_CARD |
| dType | GRADUATED_DRIVING_LICENSE_UNDER_18 |
| dType | GRADUATED_DRIVING_LICENSE_UNDER_21 |
| dType | GRADUATED_INSTRUCTION_PERMIT_UNDER_18 |
| dType | GRADUATED_INSTRUCTION_PERMIT_UNDER_21 |
| dType | GRADUATED_LICENSE_UNDER_18 |
| dType | GRADUATED_LICENSE_UNDER_21 |
| dType | HANDGUN_CARRY_PERMIT |
| dType | IDENTITY_AND_PRIVILEGE_CARD |
| dType | IDENTITY_CARD_MOBILITY_IMPAIRED |
| dType | IDENTITY_CARD_REGISTERED_OFFENDER |
| dType | IDENTITY_CARD_TEMPORARY_VISITOR |
| dType | IDENTITY_CARD_TEMPORARY_VISITOR_UNDER_18 |
| dType | IDENTITY_CARD_TEMPORARY_VISITOR_UNDER_21 |
| dType | IDENTITY_CARD_UNDER_18 |
| dType | IDENTITY_CARD_UNDER_21 |
| dType | OTHER |
| dType | IGNITION_INTERLOCK_PERMIT |
| dType | IMMIGRANT_VISA |
| dType | INSTRUCTION_PERMIT |
| dType | INSTRUCTION_PERMIT_UNDER_18 |
| dType | INSTRUCTION_PERMIT_UNDER_21 |
| dType | INTERIM_DRIVING_LICENSE |
| dType | INTERIM_IDENTITY_CARD |
| dType | INTERMEDIATE_DRIVING_LICENSE |
| dType | INTERMEDIATE_DRIVING_LICENSE_UNDER_18 |
| dType | INTERMEDIATE_DRIVING_LICENSE_UNDER_21 |
| dType | JUNIOR_DRIVING_LICENSE |
| dType | LEARNER_INSTRUCTIONAL_PERMIT |
| dType | LEARNER_LICENSE |
| dType | LEARNER_LICENSE_UNDER_18 |
| dType | LEARNER_LICENSE_UNDER_21 |
| dType | LEARNER_PERMIT |
| dType | LEARNER_PERMIT_UNDER_18 |
| dType | LEARNER_PERMIT_UNDER_21 |
| dType | LIMITED_LICENSE |
| dType | LIMITED_PERMIT |
| dType | LIMITED_TERM_DRIVING_LICENSE |
| dType | LIMITED_TERM_IDENTITY_CARD |
| dType | LIQUOR_IDENTITY_CARD |
| dType | NEW_PERMIT |
| dType | NEW_PERMIT_UNDER_18 |
| dType | NEW_PERMIT_UNDER_21 |
| dType | NON_US_CITIZEN_DRIVING_LICENSE |
| dType | OCCUPATIONAL_DRIVING_LICENSE |
| dType | ONEIDA_TRIBE_OF_INDIANS_IDENTITY_CARD |
| dType | OPERATOR_LICENSE |
| dType | OPERATOR_LICENSE_UNDER_18 |
| dType | OPERATOR_LICENSE_UNDER_21 |
| dType | PERMANENT_DRIVING_LICENSE |
| dType | PERMIT_TO_REENTER |
| dType | PROBATIONARY_AUTO_LICENSE |
| dType | PROBATIONARY_DRIVING_LICENSE_UNDER_18 |
| dType | PROBATIONARY_DRIVING_LICENSE_UNDER_21 |
| dType | PROBATIONARY_VEHICLE_SALES_PERSON_LICENSE |
| dType | PROVISIONAL_DRIVING_LICENSE |
| dType | PROVISIONAL_DRIVING_LICENSE_UNDER_18 |
| dType | PROVISIONAL_DRIVING_LICENSE_UNDER_21 |
| dType | PROVISIONAL_LICENSE |
| dType | PROVISIONAL_LICENSE_UNDER_18 |
| dType | PROVISIONAL_LICENSE_UNDER_21 |
| dType | PUBLIC_PASSENGER_CHAUFFEUR_LICENSE |
| dType | RACING_AND_GAMING_COMISSION_CARD |
| dType | REFUGEE_TRAVEL_DOCUMENT |
| dType | RENEWAL_PERMIT |
| dType | RESTRICTED_COMMERCIAL_DRIVER_LICENSE |
| dType | RESTRICTED_DRIVER_LICENSE |
| dType | RESTRICTED_PERMIT |
| dType | SEASONAL_PERMIT |
| dType | SEASONAL_RESIDENT_IDENTITY_CARD |
| dType | SEASONAL_CITIZEN_IDENTITY_CARD |
| dType | SEX_OFFENDER |
| dType | SOCIAL_SECURITY_CARD |
| dType | TEMPORARY_DRIVING_LICENSE |
| dType | TEMPORARY_DRIVING_LICENSE_UNDER_18 |
| dType | TEMPORARY_DRIVING_LICENSE_UNDER_21 |
| dType | TEMPORARY_IDENTITY_CARD |
| dType | TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD |
| dType | TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD_UNDER_18 |
| dType | TEMPORARY_INSTRUCTION_PERMIT_IDENTITY_CARD_UNDER_21 |
| dType | TEMPORARY_VISITOR_DRIVING_LICENSE |
| dType | TEMPORARY_VISITOR_DRIVING_LICENSE_UNDER_18 |
| dType | TEMPORARY_VISITOR_DRIVING_LICENSE_UNDER_21 |
| dType | UNIFORMED_SERVICES_IDENTITY_CARD |
| dType | VEHICLE_SALES_PERSON_LICENSE |
| dType | WORKER_IDENTIFICATION_CREDENTIAL |
| dType | COMMERCIAL_DRIVING_LICENSE_NOVICE |
| dType | COMMERCIAL_DRIVING_LICENSE_NOVICE_UNDER_18 |
| dType | COMMERCIAL_DRIVING_LICENSE_NOVICE_UNDER_21 |
| dType | PASSPORT_CARD |
| dType | PASSPORT_RESIDENT_CARD |
| dType | PERSONAL_IDENTIFICATION_VERIFICATION |
| dType | TEMPORARY_OPERATOR_LICENSE |
| dType | DRIVING_LICENSE_UNDER_19 |
| dType | IDENTITY_CARD_UNDER_19 |
| dType | VISA |
| dType | TEMPORARY_PASSPORT |
| dType | VOTING_CARD |
| dType | HEALTH_CARD |
| dType | CERTIFICATE_OF_CITIZENSHIP |
| dType | ADDRESS_CARD |
| dType | AIRPORT_IMMIGRATION_CARD |
| dType | ALIEN_REGISTRATION_CARD |
| dType | APEH_CARD |
| dType | COUPON_TO_DRIVING_LICENSE |
| dType | CREW_MEMBER_CERTIFICATE |
| dType | DOCUMENT_FOR_RETURN |
| dType | E_CARD |
| dType | EMPLOYMENT_CARD |
| dType | HKSAR_IMMIGRATION_FORM |
| dType | IMMIGRANT_CARD |
| dType | LABOUR_CARD |
| dType | LAISSEZ_PASSER |
| dType | LAWYER_IDENTITY_CERTIFICATE |
| dType | LICENSE_CARD |
| dType | PASSPORT_STATELESS |
| dType | PASSPORT_CHILD |
| dType | PASSPORT_CONSULAR |
| dType | PASSPORT_DIPLOMATIC_SERVICE |
| dType | PASSPORT_OFFICIAL |
| dType | PASSPORT_PROVISIONAL |
| dType | PASSPORT_SPECIAL |
| dType | PERMISSION_TO_THE_LOCAL_BORDER_TRAFFIC |
| dType | REGISTRATION_CERTIFICATE |
| dType | SEDESOL_CARD |
| dType | SOCIAL_CARD |
| dType | TB_CARD |
| dType | VEHICLE_PASSPORT |
| dType | W_DOCUMENT |
| dType | DIPLOMATIC_IDENTITY_CARD |
| dType | CONSULAR_IDENTITY_CARD |
| dType | INCOME_TAX_CARD |
| dType | RESIDENCE_PERMIT |
| dType | DOCUMENT_OF_IDENTITY |
| dType | BORDER_CROSSING_PERMIT |
| dType | PASSPORT_LIMITED_VALIDITY |
| dType | SIM_CARD |
| dType | TAX_CARD |
| dType | COMPANY_CARD |
| dType | DOMESTIC_PASSPORT |
| dType | IDENTITY_CERTIFICATE |
| dType | RESIDENT_ID_CARD |
| dType | ARMED_FORCES_IDENTITY_CARD |
| dType | PROFESSIONAL_CARD |
| dType | REGISTRATION_STAMP |
| dType | DRIVER_CARD |
| dType | DRIVER_TRAINING_CERTIFICATE |
| dType | QUALIFICATION_DRIVING_LICENSE |
| dType | MEMBERSHIP_CARD |
| dType | PUBLIC_VEHICLE_DRIVER_AUTHORITY_CARD |
| dType | MARINE_LICENSE |
| dType | TEMPORARY_LEARNER_LICENSE |
| dType | TEMPORARY_COMMERCIAL_DRIVING_LICENSE |
| dType | INTERIM_INSTRUCTIONAL_PERMIT |
| dType | CERTIFICATE_OF_COMPETENCY |
| dType | CERTIFICATE_OF_PROFICIENCY |
| dType | TRADE_LICENSE |
| dType | PASSPORT_PAGE |
| dType | INVOICE |
| dType | PASSENGER_LOCATOR_FORM |
FaceMatchVerificationResult
{
"processingTime": 0,
"transactionId": "string",
"statusDetails": {
"overallStatus": "ERROR",
"optical": "ERROR",
"rfid": "ERROR",
"detailsOptical": {
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
},
"portrait": "ERROR",
"stopList": "ERROR"
},
"graphicFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"fieldList": [
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": "string",
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"lightIndex": "OFF",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalPageIndex": 0,
"pageIndex": 0
}
]
}
]
},
"textFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"comparisonStatus": "ERROR",
"dateFormat": "string",
"fieldList": [
{
"comparisonList": [
{
"sourceLeft": "MRZ",
"sourceRight": "MRZ",
"status": "ERROR"
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": "string",
"status": "ERROR"
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": "DOCUMENT_IMAGE",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalSymbols": [
{
"code": "string",
"probability": 0,
"rect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
}
],
"originalValidity": 0,
"pageIndex": 0,
"probability": 0,
"source": "string",
"status": "string",
"value": "string"
}
]
}
],
"status": "ERROR",
"validityStatus": "ERROR"
},
"documentTypeDetails": [
{
"authenticityNecessaryLights": 0,
"checkAuthenticity": 0,
"documentName": "string",
"fdsidList": {
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
},
"id": 0,
"necessaryLights": 0,
"oviExp": 0,
"p": 0,
"rfiD_Presence": 0,
"rotated180": true,
"uvExp": 0,
"pageIdx": 0
}
],
"imageQualityDetails": [
{
"count": 0,
"list": [
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
],
"result": "ERROR",
"pageIdx": 0
}
],
"portraitComparison": {
"code": "FACER_OK",
"detections": [
{
"faces": [
{
"faceIndex": 0,
"rotationAngle": 0,
"crop": "string"
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
],
"results": [
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
]
},
"securityChecks": [
{
"count": 0,
"list": [
{
"count": 0,
"list": [
{
"elementType": "BLANK",
"elementResult": "ERROR",
"elementDiagnose": "UNKNOWN",
"image": {
"format": "string",
"image": "string"
},
"etalonImage": {
"format": "string",
"image": "string"
},
"percentValue": 0,
"lightIndex": "OFF",
"sourceImage": {
"format": "string",
"image": "string"
},
"resultImages": {
"count": 0,
"images": [
{
"format": "string",
"image": "string"
}
]
}
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
],
"pageIdx": 0
}
],
"livenessDetectionResult": {
"livenessDetectionStatus": 0,
"estimatedAge": 0,
"livenessDetectionTransactionId": "string",
"isLivenessVideoPresent": true
},
"originalImages": [
{
"pageIdx": 0,
"image": "string"
}
],
"faceMatchCompletionTime": "2019-08-24T14:15:22Z"
}
result.faceMatchVerificationResult from the IDV microservice /verificationresult API.
Aligns with OpenAPI FaceMatchVerificationResult; nested types reuse existing Regula DTOs.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| processingTime | number(double) | false | none | none |
| transactionId | string¦null | false | none | none |
| statusDetails | StatusDetails¦null | false | none | none |
| graphicFieldsDetails | ImagesDetails¦null | false | none | none |
| textFieldsDetails | TextDetails¦null | false | none | none |
| documentTypeDetails | [OneCandidateDetails]¦null | false | none | none |
| imageQualityDetails | [ImageQualityCheckListDetails]¦null | false | none | none |
| portraitComparison | PortraitComparisionResult¦null | false | none | none |
| securityChecks | [AuthenticityCheckListDetails]¦null | false | none | none |
| livenessDetectionResult | LivenessDetectionResult¦null | false | none | none |
| originalImages | [OriginalImageDetails]¦null | false | none | none |
| faceMatchCompletionTime | string(date-time)¦null | false | none | none |
FieldItem
{
"comparisonList": [
{
"sourceLeft": "MRZ",
"sourceRight": "MRZ",
"status": "ERROR"
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": "string",
"status": "ERROR"
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": "DOCUMENT_IMAGE",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalSymbols": [
{
"code": "string",
"probability": 0,
"rect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
}
],
"originalValidity": 0,
"pageIndex": 0,
"probability": 0,
"source": "string",
"status": "string",
"value": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| comparisonList | [ComparisonListItem]¦null | false | none | none |
| comparisonStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| fieldName | string¦null | false | none | none |
| fieldType | string¦null | false | none | Represents the specific data fields that can be extracted from a document. - DOCUMENT_CLASS_CODE: Document class code. - ISSUING_STATE_CODE: Issuing state code. - DOCUMENT_NUMBER: Document number. - DATE_OF_EXPIRY: Date of expiry. - DATE_OF_ISSUE: Date of issue. - DATE_OF_BIRTH: Date of birth. - PLACE_OF_BIRTH: Place of birth. - PERSONAL_NUMBER: Personal number. - SURNAME: Surname. - GIVEN_NAMES: Given name(s). - MOTHERS_NAME: Mother's name. - NATIONALITY: Nationality. - SEX: Sex. - HEIGHT: Height. - WEIGHT: Weight. - EYES_COLOR: Eyes color. - HAIR_COLOR: Hair color. - ADDRESS: Address. - DONOR: Donor. - SOCIAL_SECURITY_NUMBER: Social security number. - DL_CLASS: DL class. - DL_ENDORSED: DL endorsement code. - DL_RESTRICTION_CODE: DL restriction code. - DL_UNDER_21_DATE: Date of 21st birthday. - AUTHORITY: Issuing authority. - SURNAME_AND_GIVEN_NAMES: Surname and given names. - NATIONALITY_CODE: Nationality code. - PASSPORT_NUMBER: Passport number. - INVITATION_NUMBER: Invitation number. - VISA_ID: Visa ID. - VISA_CLASS: Visa class. - VISA_SUBCLASS: Visa subclass. - MRZ_TYPE: MRZ type. - OPTIONAL_DATA: Optional data. - DOCUMENT_CLASS_NAME: Document class name. - ISSUING_STATE_NAME: Issuing state name. - PLACE_OF_ISSUE: Place of issue. - DOCUMENT_NUMBER_CHECKSUM: Document number checksum. - DATE_OF_BIRTH_CHECKSUM: Date of birth checksum. - DATE_OF_EXPIRY_CHECKSUM: Date of expiry checksum. - PERSONAL_NUMBER_CHECKSUM: Personal number checksum. - FINAL_CHECKSUM: Final checksum. - PASSPORT_NUMBER_CHECKSUM: Passport number checksum. - INVITATION_NUMBER_CHECKSUM: Invitation number checksum. - VISA_ID_CHECKSUM: Visa ID checksum. - SURNAME_AND_GIVEN_NAMES_CHECKSUM: Surname and given names checksum. - VISA_VALID_UNTIL_CHECKSUM: Visa valid until checksum. - OTHER: Other. - MRZ_STRINGS: MRZ strings. - NAME_SUFFIX: Name suffix. - NAME_PREFIX: Name prefix. - DATE_OF_ISSUE_CHECKSUM: Date of issue checksum. - DATE_OF_ISSUE_CHECK_DIGIT: Date of issue check digit. - DOCUMENT_SERIES: Document series. - REG_CERT_REG_NUMBER: Registration number. - REG_CERT_CAR_MODEL: Vehicle model. - REG_CERT_CAR_COLOR: Vehicle color. - REG_CERT_BODY_NUMBER: Vehicle body number. - REG_CERT_CAR_TYPE: Vehicle type. - REG_CERT_MAX_WEIGHT: Max permissible weight. - REG_CERT_WEIGHT: Unladen mass. - ADDRESS_AREA: Address: area. - ADDRESS_STATE: Address: state. - ADDRESS_BUILDING: Address: building. - ADDRESS_HOUSE: Address: house. - ADDRESS_FLAT: Address: flat. - PLACE_OF_REGISTRATION: Place of registration. - DATE_OF_REGISTRATION: Date of registration. - RESIDENT_FROM: Resident from. - RESIDENT_UNTIL: Resident until. - AUTHORITY_CODE: Issuing authority code. - PLACE_OF_BIRTH_AREA: Place of birth: area. - PLACE_OF_BIRTH_STATE_CODE: Place of birth: state code. - ADDRESS_STREET: Address: street. - ADDRESS_CITY: Address: city. - ADDRESS_JURISDICTION_CODE: Address: jurisdiction code. - ADDRESS_POSTAL_CODE: Address: postal code. - DOCUMENT_NUMBER_CHECK_DIGIT: Document number check digit. - DATE_OF_BIRTH_CHECK_DIGIT: Date of birth check digit. - DATE_OF_EXPIRY_CHECK_DIGIT: Date of expiry check digit. - PERSONAL_NUMBER_CHECK_DIGIT: Personal number check digit. - FINAL_CHECK_DIGIT: Final check digit. - PASSPORT_NUMBER_CHECK_DIGIT: Passport number check digit. - INVITATION_NUMBER_CHECK_DIGIT: Invitation number check digit. - VISA_ID_CHECK_DIGIT: Visa ID check digit. - SURNAME_AND_GIVEN_NAMES_CHECK_DIGIT: Surname and given names check digit. - VISA_VALID_UNTIL_CHECK_DIGIT: Visa valid until check digit. - PERMIT_DL_CLASS: Permit class. - PERMIT_DATE_OF_EXPIRY: Permit expiry date. - PERMIT_IDENTIFIER: Permit identifier. - PERMIT_DATE_OF_ISSUE: Permit issue date. - PERMIT_RESTRICTION_CODE: Permit restriction code. - PERMIT_ENDORSED: Permit endorsement code. - ISSUE_TIMESTAMP: Issue timestamp. - NUMBER_OF_DUPLICATES: Number of duplicates. - MEDICAL_INDICATOR_CODES: Medical indicator codes. - NON_RESIDENT_INDICATOR: Non-resident indicator. - VISA_TYPE: Visa type. - VISA_VALID_FROM: Visa valid from. - VISA_VALID_UNTIL: Visa valid until. - DURATION_OF_STAY: Duration of stay. - NUMBER_OF_ENTRIES: Number of entries. - DAY: Day. - MONTH: Month. - YEAR: Year. - UNIQUE_CUSTOMER_IDENTIFIER: Unique customer identifier. - COMMERCIAL_VEHICLE_CODES: Commercial vehicle code. - AKA_DATE_OF_BIRTH: AKA: date of birth. - AKA_SOCIAL_SECURITY_NUMBER: AKA: social insurance number. - AKA_SURNAME: AKA: surname. - AKA_GIVEN_NAMES: AKA: given name(s). - AKA_NAME_SUFFIX: AKA: name suffix. - AKA_NAME_PREFIX: AKA: name prefix. - MAILING_ADDRESS_STREET: Mailing address: street. - MAILING_ADDRESS_CITY: Mailing address: city. - MAILING_ADDRESS_JURISDICTION_CODE: Mailing address: jurisdiction code. - MAILING_ADDRESS_POSTAL_CODE: Mailing address: postal code. - AUDIT_INFORMATION: Number for validation. - INVENTORY_NUMBER: Inventory number. - RACE_ETHNICITY: Race ethnicity. - JURISDICTION_VEHICLE_CLASS: Jurisdiction vehicle class. - JURISDICTION_ENDORSEMENT_CODE: Jurisdiction endorsement code. - JURISDICTION_RESTRICTION_CODE: Jurisdiction restriction code. - FAMILY_NAME: Family name. - GIVEN_NAMES_RUS: Given name(s) (national). - VISA_ID_RUS: Visa ID (national). - FATHERS_NAME: Father's name. - FATHERS_NAME_RUS: Father's name (national). - SURNAME_AND_GIVEN_NAMES_RUS: Surname and given names (national). - PLACE_OF_BIRTH_RUS: Place of birth (national). - AUTHORITY_RUS: Issuing authority (national). - ISSUING_STATE_CODE_NUMERIC: Issuing state code (numeric). - NATIONALITY_CODE_NUMERIC: Nationality code (numeric). - ENGINE_POWER: Engine power. - ENGINE_VOLUME: Engine volume. - CHASSIS_NUMBER: Chassis number. - ENGINE_NUMBER: Engine number. - ENGINE_MODEL: Engine model. - VEHICLE_CATEGORY: Vehicle category. - IDENTITY_CARD_NUMBER: Identity card number. - CONTROL_NUMBER: Control number. - PARENTS_GIVEN_NAMES: Parents' given names. - SECOND_SURNAME: Second surname. - MIDDLE_NAME: Middle name. - REG_CERT_VIN: Vehicle identification number. - REG_CERT_VIN_CHECK_DIGIT: VIN check digit. - REG_CERT_VIN_CHECKSUM: VIN checksum. - LINE_1_CHECK_DIGIT: Line 1 check digit. - LINE_2_CHECK_DIGIT: Line 2 check digit. - LINE_3_CHECK_DIGIT: Line 3 check digit. - LINE_1_CHECKSUM: Line 1 checksum. - LINE_2_CHECKSUM: Line 2 checksum. - LINE_3_CHECKSUM: Line 3 checksum. - REG_CERT_REG_NUMBER_CHECK_DIGIT: Registration number check digit. - REG_CERT_REG_NUMBER_CHECKSUM: Registration number checksum. - REG_CERT_VEHICLE_ITS_CODE: Vehicle ITS code. - CARD_ACCESS_NUMBER: Card access number. - MARITAL_STATUS: Marital status. - COMPANY_NAME: Company name. - SPECIAL_NOTES: Special notes. - SURNAME_OF_SPOUSE: Spouse's surname. - TRACKING_NUMBER: Tracking number. - BOOKLET_NUMBER: Booklet number. - CHILDREN: Children. - COPY: Copy. - SERIAL_NUMBER: Serial number. - DOSSIER_NUMBER: Dossier number. - AKA_SURNAME_AND_GIVEN_NAMES: AKA: surname and given names. - TERRITORIAL_VALIDITY: Territorial validity. - MRZ_STRINGS_WITH_CORRECT_CHECK_SUMS: MRZ strings with correct checksums. - DL_CDL_RESTRICTION_CODE: CDL restriction code. - DL_UNDER_18_DATE: Date of 18th birthday. - DL_RECORD_CREATED: DL record created. - DL_DUPLICATE_DATE: DL date of duplicate issue. - DL_ISSUE_TYPE: Card type. - MILITARY_BOOK_NUMBER: Military ID number. - DESTINATION: Destination. - BLOOD_GROUP: Blood group. - SEQUENCE_NUMBER: Sequence number. - REG_CERT_BODY_TYPE: Body type. - REG_CERT_CAR_MARK: Vehicle make. - TRANSACTION_NUMBER: Transaction number. - AGE: Age. - FOLIO_NUMBER: Folio number. - VOTER_KEY: Voter key. - ADDRESS_MUNICIPALITY: Address: municipality. - ADDRESS_LOCATION: Address: location. - SECTION: Section. - OCR_NUMBER: OCR number. - FEDERAL_ELECTIONS: Federal elections. - REFERENCE_NUMBER: Reference number. - OPTIONAL_DATA_CHECKSUM: Optional data checksum. - OPTIONAL_DATA_CHECK_DIGIT: Optional data check digit. - VISA_NUMBER: Visa number. - VISA_NUMBER_CHECKSUM: Visa number checksum. - VISA_NUMBER_CHECK_DIGIT: Visa number check digit. - VOTER: Voter. - PREVIOUS_TYPE: Type of the previous document. - FIELD_FROM_MRZ: Field from MRZ. - CURRENT_DATE: Current date. - STATUS_DATE_OF_EXPIRY: Status date of expiry. - BANKNOTE_NUMBER: Banknote number. - CSC_CODE: CSC code. - ARTISTIC_NAME: Pseudonym. - ACADEMIC_TITLE: Academic title. - ADDRESS_COUNTRY: Address country. - ADDRESS_ZIP_CODE: Address ZIP code. - E_ID_RESIDENCE_PERMIT_1: eID residence permit 1. - E_ID_RESIDENCE_PERMIT_2: eID residence permit 2. - E_ID_PLACE_OF_BIRTH_STREET: eID place of birth: street. - E_ID_PLACE_OF_BIRTH_CITY: eID place of birth: city. - E_ID_PLACE_OF_BIRTH_STATE: eID place of birth: state. - E_ID_PLACE_OF_BIRTH_COUNTRY: eID place of birth: country. - E_ID_PLACE_OF_BIRTH_ZIP_CODE: eID place of birth: postal code. - CDL_CLASS: CDL class. - DL_UNDER_19_DATE: Date of 19th birthday. - WEIGHT_POUNDS: Weight (pound). - LIMITED_DURATION_DOCUMENT_INDICATOR: Indicator of document limited duration. - ENDORSEMENT_EXPIRATION_DATE: Endorsement expiration date. - REVISION_DATE: Revision date. - COMPLIANCE_TYPE: Compliance type. - FAMILY_NAME_TRUNCATION: Family name truncation. - FIRST_NAME_TRUNCATION: First name truncation. - MIDDLE_NAME_TRUNCATION: Middle name truncation. - EXAM_DATE: Exam date. - ORGANIZATION: Organization. - DEPARTMENT: Department. - PAY_GRADE: Pay grade. - RANK: Rank. - BENEFITS_NUMBER: Benefits number. - SPONSOR_SERVICE: Sponsor service. - SPONSOR_STATUS: Sponsor status. - SPONSOR: Sponsor. - RELATIONSHIP: Relationship. - USCIS: USCIS. - CATEGORY: Category. - CONDITIONS: Conditions. - IDENTIFIER: Identifier. - CONFIGURATION: Configuration. - DISCRETIONARY_DATA: Discretionary data. - LINE_1_OPTIONAL_DATA: Line 1 optional data. - LINE_2_OPTIONAL_DATA: Line 2 optional data. - LINE_3_OPTIONAL_DATA: Line 3 optional data. - EQV_CODE: EQV code. - ALT_CODE: ALT code. - BINARY_CODE: Binary code. - PSEUDO_CODE: Pseudo code. - FEE: Fee. - STAMP_NUMBER: Stamp number. - SBH_SECURITY_OPTIONS: SBH security options. - SBH_INTEGRITY_OPTIONS: SBH integrity options. - DATE_OF_CREATION: Date of creation. - VALIDITY_PERIOD: Validity period. - PATRON_HEADER_VERSION: Patron header version. - BDB_TYPE: BDB type. - BIOMETRIC_TYPE: Biometric type. - BIOMETRIC_SUBTYPE: Biometric subtype. - BIOMETRIC_PRODUCT_ID: Biometric product ID. - BIOMETRIC_FORMAT_OWNER: Biometric format owner. - BIOMETRIC_FORMAT_TYPE: Biometric format type. - PHONE: Phone. - PROFESSION: Profession. - TITLE: Position. - PERSONAL_SUMMARY: Personal data summary. - OTHER_VALID_ID: Other valid ID. - CUSTODY_INFO: Custody info. - OTHER_NAME: Other name. - OBSERVATIONS: Observations. - TAX: Tax. - DATE_OF_PERSONALIZATION: Personalization date. - PERSONALIZATION_SN: Personalization SN. - OTHER_PERSON_NAME: Other person name. - PERSON_TO_NOTIFY_DATE_OF_RECORD: Notify person: date of record. - PERSON_TO_NOTIFY_NAME: Notify person: name. - PERSON_TO_NOTIFY_PHONE: Notify person: phone. - PERSON_TO_NOTIFY_ADDRESS: Notify person: address. - DS_CERTIFICATE_ISSUER: DS certificate issuer. - DS_CERTIFICATE_SUBJECT: DS certificate subject. - DS_CERTIFICATE_VALID_FROM: DS certificate valid from. - DS_CERTIFICATE_VALID_TO: DS certificate valid to. - VRC_DATA_OBJECT_ENTRY: Vehicle data from the DG1 data group. - TYPE_APPROVAL_NUMBER: Type of approval number. - ADMINISTRATIVE_NUMBER: Administrative number. - DOCUMENT_DISCRIMINATOR: Document discriminator. - DATA_DISCRIMINATOR: Data discriminator. - ISO_ISSUER_ID_NUMBER: ID number of ISO issuer. - DTC_VERSION: DTC version. - DTC_ID: DTC ID. - DTC_DATE_OF_EXPIRY: DTC date of expiry. - GNIB_NUMBER: GNIB number. - DEPT_NUMBER: Department number. - TELEX_CODE: Telegraph code. - ALLERGIES: Allergies. - SP_CODE: Special code. - COURT_CODE: Court code. - CTY: County. - SPONSOR_SSN: Sponsor SSN. - DOD_NUMBER: DoD number. - MC_NOVICE_DATE: Expiry date of Motorcycle Novice status. - DUF_NUMBER: DUF number. - AGY: AGY. - PNR_CODE: PNR code. - FROM_AIRPORT_CODE: Code of the airport of departure. - TO_AIRPORT_CODE: Code of the airport of arrival. - FLIGHT_NUMBER: Flight number. - DATE_OF_FLIGHT: Date of flight. - SEAT_NUMBER: Seat number. - DATE_OF_ISSUE_BOARDING_PASS: Date of boarding pass issue. - CCW_UNTIL: CCW until. - REFERENCE_NUMBER_CHECKSUM: Reference number checksum. - REFERENCE_NUMBER_CHECK_DIGIT: Reference number check digit. - ROOM_NUMBER: Room number. - RELIGION: Religion. - REMAINDER_TERM: Months to expire. - ELECTRONIC_TICKET_INDICATOR: Electronic ticket indicator. - COMPARTMENT_CODE: Compartment code. - CHECK_IN_SEQUENCE_NUMBER: Check-in sequence number. - AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER: Airline designator of boarding pass issuer. - AIRLINE_NUMERIC_CODE: Airline numeric code. - TICKET_NUMBER: Ticket number. - FREQUENT_FLYER_AIRLINE_DESIGNATOR: Frequent flyer airline designator. - FREQUENT_FLYER_NUMBER: Frequent flyer number. - FREE_BAGGAGE_ALLOWANCE: Free baggage allowance. - PDF417_CODEC: PDF417 codec. - IDENTITY_CARD_NUMBER_CHECKSUM: Identity card number checksum. - IDENTITY_CARD_NUMBER_CHECK_DIGIT: Identity card number check digit. - VETERAN: Veteran. - DL_CLASS_CODE_A1_FROM: DL category A1 valid from. - DL_CLASS_CODE_A1_TO: DL category A1 valid to. - DL_CLASS_CODE_A1_NOTES: DL category A1 codes. - DL_CLASS_CODE_A_FROM: DL category A valid from. - DL_CLASS_CODE_A_TO: DL category A valid to. - DL_CLASS_CODE_A_NOTES: DL category A codes. - DL_CLASS_CODE_B_FROM: DL category B valid from. - DL_CLASS_CODE_B_TO: DL category B valid to. - DL_CLASS_CODE_B_NOTES: DL category B codes. - DL_CLASS_CODE_C1_FROM: DL category C1 valid from. - DL_CLASS_CODE_C1_TO: DL category C1 valid to. - DL_CLASS_CODE_C1_NOTES: DL category C1 codes. - DL_CLASS_CODE_C_FROM: DL category C valid from. - DL_CLASS_CODE_C_TO: DL category C valid to. - DL_CLASS_CODE_C_NOTES: DL category C codes. - DL_CLASS_CODE_D1_FROM: DL category D1 valid from. - DL_CLASS_CODE_D1_TO: DL category D1 valid to. - DL_CLASS_CODE_D1_NOTES: DL category D1 codes. - DL_CLASS_CODE_D_FROM: DL category D valid from. - DL_CLASS_CODE_D_TO: DL category D valid to. - DL_CLASS_CODE_D_NOTES: DL category D codes. - DL_CLASS_CODE_BE_FROM: DL category BE valid from. - DL_CLASS_CODE_BE_TO: DL category BE valid to. - DL_CLASS_CODE_BE_NOTES: DL category BE codes. - DL_CLASS_CODE_C1E_FROM: DL category C1E valid from. - DL_CLASS_CODE_C1E_TO: DL category C1E valid to. - DL_CLASS_CODE_C1E_NOTES: DL category C1E codes. - DL_CLASS_CODE_CE_FROM: DL category CE valid from. - DL_CLASS_CODE_CE_TO: DL category CE valid to. - DL_CLASS_CODE_CE_NOTES: DL category CE codes. - DL_CLASS_CODE_D1E_FROM: DL category D1E valid from. - DL_CLASS_CODE_D1E_TO: DL category D1E valid to. - DL_CLASS_CODE_D1E_NOTES: DL category D1E codes. - DL_CLASS_CODE_DE_FROM: DL category DE valid from. - DL_CLASS_CODE_DE_TO: DL category DE valid to. - DL_CLASS_CODE_DE_NOTES: DL category DE codes. - DL_CLASS_CODE_M_FROM: DL category M valid from. - DL_CLASS_CODE_M_TO: DL category M valid to. - DL_CLASS_CODE_M_NOTES: DL category M codes. - DL_CLASS_CODE_L_FROM: DL category L valid from. - DL_CLASS_CODE_L_TO: DL category L valid to. - DL_CLASS_CODE_L_NOTES: DL category L codes. - DL_CLASS_CODE_T_FROM: DL category T valid from. - DL_CLASS_CODE_T_TO: DL category T valid to. - DL_CLASS_CODE_T_NOTES: DL category T codes. - DL_CLASS_CODE_AM_FROM: DL category AM valid from. - DL_CLASS_CODE_AM_TO: DL category AM valid to. - DL_CLASS_CODE_AM_NOTES: DL category AM codes. - DL_CLASS_CODE_A2_FROM: DL category A2 valid from. - DL_CLASS_CODE_A2_TO: DL category A2 valid to. - DL_CLASS_CODE_A2_NOTES: DL category A2 codes. - DL_CLASS_CODE_B1_FROM: DL category B1 valid from. - DL_CLASS_CODE_B1_TO: DL category B1 valid to. - DL_CLASS_CODE_B1_NOTES: DL category B1 codes. - SURNAME_AT_BIRTH: Surname at birth. - CIVIL_STATUS: Civil status. - NUMBER_OF_SEATS: Number of seats. - NUMBER_OF_STANDING_PLACES: Number of standing places. - MAX_SPEED: Max speed. - FUEL_TYPE: Fuel type. - EC_ENVIRONMENTAL_TYPE: Vehicle environmental type. - POWER_WEIGHT_RATIO: Power-to-weight ratio. - MAX_MASS_OF_TRAILER_BRAKED: Max mass of trailer (braked). - MAX_MASS_OF_TRAILER_UNBRAKED: Max mass of trailer (unbraked). - TRANSMISSION_TYPE: Transmission type. - TRAILER_HITCH: Trailer hitch. - ACCOMPANIED_BY: Accompanied by. - POLICE_DISTRICT: Police district. - FIRST_ISSUE_DATE: First issue date. - PAYLOAD_CAPACITY: Payload capacity. - NUMBER_OF_AXLES: Number of axles. - PERMISSIBLE_AXLE_LOAD: Permissible axle load. - PRECINCT: Precinct. - INVITED_BY: Invited by. - PURPOSE_OF_ENTRY: Purpose of entry. - SKIN_COLOR: Skin color. - COMPLEXION: Complexion. - AIRPORT_FROM: Airport of departure. - AIRPORT_TO: Airport of arrival. - AIRLINE_NAME: Airline name. - AIRLINE_NAME_FREQUENT_FLYER: Airline loyalty program for frequent flyers. - LICENSE_NUMBER: License number. - IN_TANKS: In tanks. - EXCEPT_IN_TANKS: Other than tanks. - FAST_TRACK: Fast Track service. - OWNER: Owner. - MRZ_STRINGS_ICAO_RFID: MRZ strings from ICAO RFID. - NUMBER_OF_CARD_ISSUANCE: Number of card issuances. - NUMBER_OF_CARD_ISSUANCE_CHECKSUM: Number of card issuances checksum. - NUMBER_OF_CARD_ISSUANCE_CHECK_DIGIT: Number of card issuances check digit. - CENTURY_DATE_OF_BIRTH: Century of birth. - DL_CLASS_CODE_A3_FROM: DL category A3 valid from. - DL_CLASS_CODE_A3_TO: DL category A3 valid to. - DL_CLASS_CODE_A3_NOTES: DL category A3 codes. - DL_CLASS_CODE_C2_FROM: DL category C2 valid from. - DL_CLASS_CODE_C2_TO: DL category C2 valid to. - DL_CLASS_CODE_C2_NOTES: DL category C2 codes. - DL_CLASS_CODE_B2_FROM: DL category B2 valid from. - DL_CLASS_CODE_B2_TO: DL category B2 valid to. - DL_CLASS_CODE_B2_NOTES: DL category B2 codes. - DL_CLASS_CODE_D2_FROM: DL category D2 valid from. - DL_CLASS_CODE_D2_TO: DL category D2 valid to. - DL_CLASS_CODE_D2_NOTES: DL category D2 codes. - DL_CLASS_CODE_B2E_FROM: DL category B2E valid from. - DL_CLASS_CODE_B2E_TO: DL category B2E valid to. - DL_CLASS_CODE_B2E_NOTES: DL category B2E codes. - DL_CLASS_CODE_G_FROM: DL category G valid from. - DL_CLASS_CODE_G_TO: DL category G valid to. - DL_CLASS_CODE_G_NOTES: DL category G codes. - DL_CLASS_CODE_J_FROM: DL category J valid from. - DL_CLASS_CODE_J_TO: DL category J valid to. - DL_CLASS_CODE_J_NOTES: DL category J codes. - DL_CLASS_CODE_LC_FROM: DL category LC valid from. - DL_CLASS_CODE_LC_TO: DL category LC valid to. - DL_CLASS_CODE_LC_NOTES: DL category LC codes. - BANK_CARD_NUMBER: Bank card number. - BANK_CARD_VALID_THRU: Bank card validity. - TAX_NUMBER: Tax number. - HEALTH_NUMBER: Health insurance number. - GRANDFATHER_NAME: Grandfather's name. - SELECTEE_INDICATOR: Selectee indicator. - MOTHER_SURNAME: Mother's surname. - MOTHER_GIVEN_NAME: Mother's name. - FATHER_SURNAME: Father's surname. - FATHER_GIVEN_NAME: Father's name. - MOTHER_DATE_OF_BIRTH: Mother's date of birth. - FATHER_DATE_OF_BIRTH: Father's date of birth. - MOTHER_PERSONAL_NUMBER: Mother's personal number. - FATHER_PERSONAL_NUMBER: Father's personal number. - MOTHER_PLACE_OF_BIRTH: Mother's place of birth. - FATHER_PLACE_OF_BIRTH: Father's place of birth. - MOTHER_COUNTRY_OF_BIRTH: Mother's country of birth. - FATHER_COUNTRY_OF_BIRTH: Father's country of birth. - DATE_FIRST_RENEWAL: Date of first renewal. - DATE_SECOND_RENEWAL: Date of second renewal. - PLACE_OF_EXAMINATION: Place of examination. - APPLICATION_NUMBER: Application number. - VOUCHER_NUMBER: Voucher number. - AUTHORIZATION_NUMBER: Authorization number. - FACULTY: Faculty. - FORM_OF_EDUCATION: Form of education. - DNI_NUMBER: DNI number. - RETIREMENT_NUMBER: Retirement number. - PROFESSIONAL_ID_NUMBER: Professional id number. - AGE_AT_ISSUE: Age at issue. - YEARS_SINCE_ISSUE: Years since issue. - DL_CLASS_CODE_BTP_FROM: DL category BTP valid from. - DL_CLASS_CODE_BTP_TO: DL category BTP valid to. - DL_CLASS_CODE_BTP_NOTES: DL category BTP codes. - DL_CLASS_CODE_C3_FROM: DL category C3 valid from. - DL_CLASS_CODE_C3_TO: DL category C3 valid to. - DL_CLASS_CODE_C3_NOTES: DL category C3 codes. - DL_CLASS_CODE_E_FROM: DL category E valid from. - DL_CLASS_CODE_E_TO: DL category E valid to. - DL_CLASS_CODE_E_NOTES: DL category E codes. - DL_CLASS_CODE_F_FROM: DL category F valid from. - DL_CLASS_CODE_F_TO: DL category F valid to. - DL_CLASS_CODE_F_NOTES: DL category F codes. - DL_CLASS_CODE_FA_FROM: DL category FA valid from. - DL_CLASS_CODE_FA_TO: DL category FA valid to. - DL_CLASS_CODE_FA_NOTES: DL category FA codes. - DL_CLASS_CODE_FA1_FROM: DL category FA1 valid from. - DL_CLASS_CODE_FA1_TO: DL category FA1 valid to. - DL_CLASS_CODE_FA1_NOTES: DL category FA1 codes. - DL_CLASS_CODE_FB_FROM: DL category FB valid from. - DL_CLASS_CODE_FB_TO: DL category FB valid to. - DL_CLASS_CODE_FB_NOTES: DL category FB codes. - DL_CLASS_CODE_G1_FROM: DL category G1 valid from. - DL_CLASS_CODE_G1_TO: DL category G1 valid to. - DL_CLASS_CODE_G1_NOTES: DL category G1 codes. - DL_CLASS_CODE_H_FROM: DL category H valid from. - DL_CLASS_CODE_H_TO: DL category H valid to. - DL_CLASS_CODE_H_NOTES: DL category H codes. - DL_CLASS_CODE_I_FROM: DL category I valid from. - DL_CLASS_CODE_I_TO: DL category I valid to. - DL_CLASS_CODE_I_NOTES: DL category I codes. - DL_CLASS_CODE_K_FROM: DL category K valid from. - DL_CLASS_CODE_K_TO: DL category K valid to. - DL_CLASS_CODE_K_NOTES: DL category K codes. - DL_CLASS_CODE_LK_FROM: DL category LK valid from. - DL_CLASS_CODE_LK_TO: DL category LK valid to. - DL_CLASS_CODE_LK_NOTES: DL category LK codes. - DL_CLASS_CODE_N_FROM: DL category N valid from. - DL_CLASS_CODE_N_TO: DL category N valid to. - DL_CLASS_CODE_N_NOTES: DL category N codes. - DL_CLASS_CODE_S_FROM: DL category S valid from. - DL_CLASS_CODE_S_TO: DL category S valid to. - DL_CLASS_CODE_S_NOTES: DL category S codes. - DL_CLASS_CODE_TB_FROM: DL category TB valid from. - DL_CLASS_CODE_TB_TO: DL category TB valid to. - DL_CLASS_CODE_TB_NOTES: DL category TB codes. - DL_CLASS_CODE_TM_FROM: DL category TM valid from. - DL_CLASS_CODE_TM_TO: DL category TM valid to. - DL_CLASS_CODE_TM_NOTES: DL category TM codes. - DL_CLASS_CODE_TR_FROM: DL category TR valid from. - DL_CLASS_CODE_TR_TO: DL category TR valid to. - DL_CLASS_CODE_TR_NOTES: DL category TR codes. - DL_CLASS_CODE_TV_FROM: DL category TV valid from. - DL_CLASS_CODE_TV_TO: DL category TV valid to. - DL_CLASS_CODE_TV_NOTES: DL category TV codes. - DL_CLASS_CODE_V_FROM: DL category V valid from. - DL_CLASS_CODE_V_TO: DL category V valid to. - DL_CLASS_CODE_V_NOTES: DL category V codes. - DL_CLASS_CODE_W_FROM: DL category W valid from. - DL_CLASS_CODE_W_TO: DL category W valid to. - DL_CLASS_CODE_W_NOTES: DL category W codes. - URL: URL. - CALIBER: Caliber. - MODEL: Model. - MAKE: Make. - NUMBER_OF_CYLINDERS: Number of cylinders. - SURNAME_OF_HUSBAND_AFTER_REGISTRATION: Surname of husband after registration. - SURNAME_OF_WIFE_AFTER_REGISTRATION: Surname of wife after registration. - DATE_OF_BIRTH_OF_WIFE: Date of birth of wife. - DATE_OF_BIRTH_OF_HUSBAND: Date of birth of husband. - CITIZENSHIP_OF_FIRST_PERSON: Citizenship of first person. - CITIZENSHIP_OF_SECOND_PERSON: Citizenship of second person. - CVV: CVV code. - DATE_OF_INSURANCE_EXPIRY: Date of insurance expiry. - MORTGAGE_BY: Mortgage by. - OLD_DOCUMENT_NUMBER: Old document number. - OLD_DATE_OF_ISSUE: Old date of issue. - OLD_PLACE_OF_ISSUE: Old place of issue. - DL_CLASS_CODE_LR_FROM: DL category LR valid from. - DL_CLASS_CODE_LR_TO: DL category LR valid to. - DL_CLASS_CODE_LR_NOTES: DL category LR codes. - DL_CLASS_CODE_MR_FROM: DL category MR valid from. - DL_CLASS_CODE_MR_TO: DL category MR valid to. - DL_CLASS_CODE_MR_NOTES: DL category MR codes. - DL_CLASS_CODE_HR_FROM: DL category HR valid from. - DL_CLASS_CODE_HR_TO: DL category HR valid to. - DL_CLASS_CODE_HR_NOTES: DL category HR codes. - DL_CLASS_CODE_HC_FROM: DL category HC valid from. - DL_CLASS_CODE_HC_TO: DL category HC valid to. - DL_CLASS_CODE_HC_NOTES: DL category HC codes. - DL_CLASS_CODE_MC_FROM: DL category MC valid from. - DL_CLASS_CODE_MC_TO: DL category MC valid to. - DL_CLASS_CODE_MC_NOTES: DL category MC codes. - DL_CLASS_CODE_RE_FROM: DL category RE valid from. - DL_CLASS_CODE_RE_TO: DL category RE valid to. - DL_CLASS_CODE_RE_NOTES: DL category RE codes. - DL_CLASS_CODE_R_FROM: DL category R valid from. - DL_CLASS_CODE_R_TO: DL category R valid to. - DL_CLASS_CODE_R_NOTES: DL category R codes. - DL_CLASS_CODE_CA_FROM: DL category CA valid from. - DL_CLASS_CODE_CA_TO: DL category CA valid to. - DL_CLASS_CODE_CA_NOTES: DL category CA codes. - CITIZENSHIP_STATUS: Citizenship status. - MILITARY_SERVICE_FROM: Military service from. - MILITARY_SERVICE_TO: Military service to. - DL_CLASS_CODE_NT_FROM: DL category NT valid from. - DL_CLASS_CODE_NT_TO: DL category NT valid to. - DL_CLASS_CODE_NT_NOTES: DL category NT codes. - DL_CLASS_CODE_TN_FROM: DL category TN valid from. - DL_CLASS_CODE_TN_TO: DL category TN valid to. - DL_CLASS_CODE_TN_NOTES: DL category TN codes. - DL_CLASS_CODE_D3_FROM: DL category D3 valid from. - DL_CLASS_CODE_D3_TO: DL category D3 valid to. - DL_CLASS_CODE_D3_NOTES: DL category D3 codes. - ALT_DATE_OF_EXPIRY: Alternative date of expiry. - DL_CLASS_CODE_CD_FROM: DL category CD valid from. - DL_CLASS_CODE_CD_TO: DL category CD valid to. - DL_CLASS_CODE_CD_NOTES: DL category CD codes. - ISSUER_IDENTIFICATION_NUMBER: Issuer identification number. - PAYMENT_PERIOD_FROM: Payment period from. - PAYMENT_PERIOD_TO: Payment period to. - VACCINATION_CERTIFICATE_IDENTIFIER: Vaccination certificate identifier. - FIRST_NAME: First name. - DATE_OF_ARRIVAL: Date of arrival. - SECOND_NAME: Second name. - THIRD_NAME: Third name. - FOURTH_NAME: Fourth name. - LAST_NAME: Last name. - DL_CLASS_CODE_RM_FROM: DL category RM valid from. - DL_CLASS_CODE_RM_TO: DL category RM valid to. - DL_CLASS_CODE_RM_NOTES: DL category RM codes. - DL_CLASS_CODE_PW_FROM: DL category PW valid from. - DL_CLASS_CODE_PW_TO: DL category PW valid to. - DL_CLASS_CODE_PW_NOTES: DL category PW codes. - DL_CLASS_CODE_EB_FROM: DL category EB valid from. - DL_CLASS_CODE_EB_TO: DL category EB valid to. - DL_CLASS_CODE_EB_NOTES: DL category EB codes. - DL_CLASS_CODE_EC_FROM: DL category EC valid from. - DL_CLASS_CODE_EC_TO: DL category EC valid to. - DL_CLASS_CODE_EC_NOTES: DL category EC codes. - DL_CLASS_CODE_EC1_FROM: DL category EC1 valid from. - DL_CLASS_CODE_EC1_TO: DL category EC1 valid to. - DL_CLASS_CODE_EC1_NOTES: DL category EC1 codes. - PLACE_OF_BIRTH_CITY: Place of birth city. - YEAR_OF_BIRTH: Year of birth. - YEAR_OF_EXPIRY: Year of expiry. - GRANDFATHER_NAME_MATERNAL: Grandfather's name (maternal). - FIRST_SURNAME: First surname. - MONTH_OF_BIRTH: Month of birth. - ADDRESS_FLOOR_NUMBER: Floor number. - ADDRESS_ENTRANCE: Entrance number. - ADDRESS_BLOCK_NUMBER: Block number. - ADDRESS_STREET_NUMBER: Street number. - ADDRESS_STREET_TYPE: Street type. - ADDRESS_CITY_SECTOR: City sector. - ADDRESS_COUNTY_TYPE: County type. - ADDRESS_CITY_TYPE: City type. - ADDRESS_BUILDING_TYPE: Building type. - DATE_OF_RETIREMENT: Date of retirement. - DOCUMENT_STATUS: Document status. - SIGNATURE: Signature. - FT_UNIQUE_CERTIFICATE_IDENTIFIER: Unique certificate identifier. - FT_EMAIL: Email. - FT_DATE_OF_SPECIMEN_COLLECTION: Date of specimen collection. - FT_TYPE_OF_TESTING: Type of testing. - FT_RESULT_OF_TESTING: Result of testing. - FT_METHOD_OF_TESTING: Method of testing. - FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER: Digital travel authorization number. - FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT: Date of first positive test result. - EF_CARD_ACCESS: EF.CardAccess. - SHORT_FLIGHT_NUMBER: Short flight number. - AIRLINE_CODE: Airline code. - FT_MVC_AGENCY: MVC agency. - FT_ISSUING_STATE_CODE_ALPHA2: Issuing state code (Alpha-2). - FT_NATIONALITY_CODE_ALPHA2: Nationality code (Alpha-2). - FT_FIRST_ISSUE_DATE_CHECKDIGIT: First issue date check digit. - FT_FIRST_ISSUE_DATE_CHECKSUM: First issue date checksum. - FT_COMMERCIAL_INDICATOR: Commercial indicator. - FT_NON_DOMICILED_INDICATOR: Non-domiciled indicator. - FT_JURISDICTION_SPECIFIC_DATA: Jurisdiction-specific data. |
| lcid | string¦null | false | none | Represents supported languages, regional variants, scripts, and special detection types. - LATIN: Latin. - AFRIKAANS: Afrikaans. - ALBANIAN: Albanian. - ARABIC_ALGERIA: Arabic (Algeria). - ARABIC_BAHRAIN: Arabic (Bahrain). - ARABIC_EGYPT: Arabic (Egypt). - ARABIC_IRAQ: Arabic (Iraq). - ARABIC_JORDAN: Arabic (Jordan). - ARABIC_KUWAIT: Arabic (Kuwait). - ARABIC_LEBANON: Arabic (Lebanon). - ARABIC_LIBYA: Arabic (Libya). - ARABIC_MOROCCO: Arabic (Morocco). - ARABIC_OMAN: Arabic (Oman). - ARABIC_QATAR: Arabic (Qatar). - ARABIC_SAUDI_ARABIA: Arabic (Saudi Arabia). - ARABIC_SYRIA: Arabic (Syria). - ARABIC_TUNISIA: Arabic (Tunisia). - ARABIC_UAE: Arabic (U.A.E.). - ARABIC_YEMEN: Arabic (Yemen). - ARMENIAN: Armenian. - AZERI_CYRILIC: Azeri (Cyrillic). - AZERI_LATIN: Azeri (Latin). - BASQUE: Basque. - BELARUSIAN: Belarusian. - BULGARIAN: Bulgarian. - BURMESE: Burmese. - CATALAN: Catalan. - CHINESE: Chinese. - CHINESE_HONGKONG_SAR: Chinese (Hong Kong S.A.R.). - CHINESE_MACAO_SAR: Chinese (Macao S.A.R.). - CHINESE_SINGAPORE: Chinese (Singapore). - CHINESE_TAIWAN: Chinese (Taiwan). - CROATIAN: Croatian. - CZECH: Czech. - DANISH: Danish. - DIVEHI: Divehi. - DUTCH_BELGIUM: Dutch (Belgium). - DUTCH_NETHERLANDS: Dutch (Netherlands). - ENGLISH_AUSTRALIA: English (Australia). - ENGLISH_BELIZE: English (Belize). - ENGLISH_CANADA: English (Canada). - ENGLISH_CARRIBEAN: English (Caribbean). - ENGLISH_IRELAND: English (Ireland). - ENGLISH_JAMAICA: English (Jamaica). - ENGLISH_NEW_ZEALAND: English (New Zealand). - ENGLISH_PHILIPPINES: English (Philippines). - ENGLISH_SOUTH_AFRICA: English (South Africa). - ENGLISH_TRINIDAD: English (Trinidad). - ENGLISH_UK: English (United Kingdom). - ENGLISH_US: English (United States). - ENGLISH_ZIMBABWE: English (Zimbabwe). - ESTONIAN: Estonian. - FAEROESE: Faeroese. - FARSI: Farsi. - FINNISH: Finnish. - FRENCH_BELGIUM: French (Belgium). - FRENCH_CANADA: French (Canada). - FRENCH_FRANCE: French (France). - FRENCH_LUXEMBOURG: French (Luxembourg). - FRENCH_MONACO: French (Monaco). - FRENCH_SWITZERLAND: French (Switzerland). - FYRO_MACEDONIAN: FYRO Macedonian. - GALICIAN: Galician. - GEORGIAN: Georgian. - GERMAN_AUSTRIA: German (Austria). - GERMAN_GERMANY: German (Germany). - GERMAN_LIECHTENSTEIN: German (Liechtenstein). - GERMAN_LUXEMBOURG: German (Luxembourg). - GERMAN_SWITZERLAND: German (Switzerland). - GREEK: Greek. - GUJARATI: Gujarati. - HEBREW: Hebrew. - HINDI_INDIA: Hindi (India). - HUNGARIAN: Hungarian. - ICELANDIC: Icelandic. - INDONESIAN: Indonesian. - ITALIAN_ITALY: Italian (Italy). - ITALIAN_SWITZERLAND: Italian (Switzerland). - JAPANESE: Japanese. - KANNADA: Kannada. - KAZAKH: Kazakh. - KHMER: Khmer. - KONKANI: Konkani. - KOREAN: Korean. - KYRGYZ_CYRILLIC: Kyrgyz (Cyrillic). - LATVIAN: Latvian. - LITHUANIAN: Lithuanian. - MALAY_MALAYSIA: Malay (Malaysia). - MALAY_BRUNEI_DARUSSALAM: Malay (Brunei Darussalam). - MALTESE: Maltese. - MARATHI: Marathi. - MONGOLIAN_CYRILIC: Mongolian (Cyrillic). - NORWEGIAN_BOKMAL: Norwegian (Bokmal). - NORWEGIAN_NYORSK: Norwegian (Nynorsk). - POLISH: Polish. - PORTUGUESE_BRAZIL: Portuguese (Brazil). - PORTUGUESE_PORTUGAL: Portuguese (Portugal). - PUNJABI: Punjabi. - ROMANIAN: Romanian. - RUSSIAN: Russian. - SANSKRIT: Sanskrit. - SERBIAN_CYRILIC: Serbian (Cyrillic). - SERBIAN_LATIN: Serbian (Latin). - SINHALA: Sinhala. - SLOVAK: Slovak. - SLOVENIAN: Slovenian. - SPANISH_MEXICO: Spanish (Mexico). - SPANISH_US: Spanish (United States). - SWAHILI: Swahili. - SWEDISH: Swedish. - SWEDISH_FINLAND: Swedish (Finland). - TAMIL: Tamil. - TELUGU: Telugu. - THAI_THAILAND: Thai (Thailand). - TURKISH: Turkish. - UKRAINIAN: Ukrainian. - URDU: Urdu. - UZBEK_CYRILIC: Uzbek (Cyrillic). - UZBEK_LATIN: Uzbek (Latin). - VIETNAMESE: Vietnamese. - ARABIC: Arabic (World). - BANK_CARD: Bank card. - BANK_CARD_NUMBER: Bank card number. - BANK_CARD_EXPIRY_DATE: Bank card expiry date. - BANK_CARD_NAME: Bank card name. - BANK_CARD_CVV2: Bank card CVV2. - URDU_DETECTION: Urdu detection. |
| lcidName | string¦null | false | none | none |
| status | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| validityList | [ValidityItem]¦null | false | none | none |
| validityStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| value | string¦null | false | none | none |
| valueList | [ValueItem]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| comparisonStatus | ERROR |
| comparisonStatus | OK |
| comparisonStatus | WAS_NOT_DONE |
| fieldType | DOCUMENT_CLASS_CODE |
| fieldType | ISSUING_STATE_CODE |
| fieldType | DOCUMENT_NUMBER |
| fieldType | DATE_OF_EXPIRY |
| fieldType | DATE_OF_ISSUE |
| fieldType | DATE_OF_BIRTH |
| fieldType | PLACE_OF_BIRTH |
| fieldType | PERSONAL_NUMBER |
| fieldType | SURNAME |
| fieldType | GIVEN_NAMES |
| fieldType | MOTHERS_NAME |
| fieldType | NATIONALITY |
| fieldType | SEX |
| fieldType | HEIGHT |
| fieldType | WEIGHT |
| fieldType | EYES_COLOR |
| fieldType | HAIR_COLOR |
| fieldType | ADDRESS |
| fieldType | DONOR |
| fieldType | SOCIAL_SECURITY_NUMBER |
| fieldType | DL_CLASS |
| fieldType | DL_ENDORSED |
| fieldType | DL_RESTRICTION_CODE |
| fieldType | DL_UNDER_21_DATE |
| fieldType | AUTHORITY |
| fieldType | SURNAME_AND_GIVEN_NAMES |
| fieldType | NATIONALITY_CODE |
| fieldType | PASSPORT_NUMBER |
| fieldType | INVITATION_NUMBER |
| fieldType | VISA_ID |
| fieldType | VISA_CLASS |
| fieldType | VISA_SUBCLASS |
| fieldType | MRZ_TYPE |
| fieldType | OPTIONAL_DATA |
| fieldType | DOCUMENT_CLASS_NAME |
| fieldType | ISSUING_STATE_NAME |
| fieldType | PLACE_OF_ISSUE |
| fieldType | DOCUMENT_NUMBER_CHECKSUM |
| fieldType | DATE_OF_BIRTH_CHECKSUM |
| fieldType | DATE_OF_EXPIRY_CHECKSUM |
| fieldType | FINAL_CHECKSUM |
| fieldType | FINAL_CHECKSUM |
| fieldType | PASSPORT_NUMBER_CHECKSUM |
| fieldType | INVITATION_NUMBER_CHECKSUM |
| fieldType | VISA_ID_CHECKSUM |
| fieldType | SURNAME_AND_GIVEN_NAMES_CHECKSUM |
| fieldType | VISA_VALID_UNTIL_CHECKSUM |
| fieldType | OTHER |
| fieldType | MRZ_STRINGS |
| fieldType | NAME_SUFFIX |
| fieldType | NAME_PREFIX |
| fieldType | DATE_OF_ISSUE_CHECKSUM |
| fieldType | DATE_OF_ISSUE_CHECK_DIGIT |
| fieldType | DOCUMENT_SERIES |
| fieldType | REG_CERT_REG_NUMBER |
| fieldType | REG_CERT_CAR_MODEL |
| fieldType | REG_CERT_CAR_COLOR |
| fieldType | REG_CERT_BODY_NUMBER |
| fieldType | REG_CERT_CAR_TYPE |
| fieldType | REG_CERT_MAX_WEIGHT |
| fieldType | REG_CERT_WEIGHT |
| fieldType | ADDRESS_AREA |
| fieldType | ADDRESS_STATE |
| fieldType | ADDRESS_BUILDING |
| fieldType | ADDRESS_HOUSE |
| fieldType | ADDRESS_FLAT |
| fieldType | PLACE_OF_REGISTRATION |
| fieldType | DATE_OF_REGISTRATION |
| fieldType | RESIDENT_FROM |
| fieldType | RESIDENT_UNTIL |
| fieldType | AUTHORITY_CODE |
| fieldType | PLACE_OF_BIRTH_AREA |
| fieldType | PLACE_OF_BIRTH_STATE_CODE |
| fieldType | ADDRESS_STREET |
| fieldType | ADDRESS_CITY |
| fieldType | ADDRESS_JURISDICTION_CODE |
| fieldType | ADDRESS_POSTAL_CODE |
| fieldType | DOCUMENT_NUMBER_CHECK_DIGIT |
| fieldType | DATE_OF_BIRTH_CHECK_DIGIT |
| fieldType | DATE_OF_EXPIRY_CHECK_DIGIT |
| fieldType | PERSONAL_NUMBER_CHECK_DIGIT |
| fieldType | FINAL_CHECK_DIGIT |
| fieldType | PASSPORT_NUMBER_CHECK_DIGIT |
| fieldType | INVITATION_NUMBER_CHECK_DIGIT |
| fieldType | VISA_ID_CHECK_DIGIT |
| fieldType | SURNAME_AND_GIVEN_NAMES_CHECK_DIGIT |
| fieldType | VISA_VALID_UNTIL_CHECK_DIGIT |
| fieldType | PERMIT_DL_CLASS |
| fieldType | PERMIT_DATE_OF_EXPIRY |
| fieldType | PERMIT_IDENTIFIER |
| fieldType | PERMIT_DATE_OF_ISSUE |
| fieldType | PERMIT_RESTRICTION_CODE |
| fieldType | PERMIT_ENDORSED |
| fieldType | ISSUE_TIMESTAMP |
| fieldType | NUMBER_OF_DUPLICATES |
| fieldType | MEDICAL_INDICATOR_CODES |
| fieldType | NON_RESIDENT_INDICATOR |
| fieldType | VISA_TYPE |
| fieldType | VISA_VALID_FROM |
| fieldType | VISA_VALID_UNTIL |
| fieldType | DURATION_OF_STAY |
| fieldType | NUMBER_OF_ENTRIES |
| fieldType | DAY |
| fieldType | MONTH |
| fieldType | YEAR |
| fieldType | UNIQUE_CUSTOMER_IDENTIFIER |
| fieldType | COMMERCIAL_VEHICLE_CODES |
| fieldType | AKA_DATE_OF_BIRTH |
| fieldType | AKA_SOCIAL_SECURITY_NUMBER |
| fieldType | AKA_SURNAME |
| fieldType | AKA_GIVEN_NAMES |
| fieldType | AKA_NAME_SUFFIX |
| fieldType | AKA_NAME_PREFIX |
| fieldType | MAILING_ADDRESS_STREET |
| fieldType | MAILING_ADDRESS_CITY |
| fieldType | MAILING_ADDRESS_JURISDICTION_CODE |
| fieldType | MAILING_ADDRESS_POSTAL_CODE |
| fieldType | AUDIT_INFORMATION |
| fieldType | INVENTORY_NUMBER |
| fieldType | RACE_ETHNICITY |
| fieldType | JURISDICTION_VEHICLE_CLASS |
| fieldType | JURISDICTION_ENDORSEMENT_CODE |
| fieldType | JURISDICTION_RESTRICTION_CODE |
| fieldType | FAMILY_NAME |
| fieldType | GIVEN_NAMES_RUS |
| fieldType | VISA_ID_RUS |
| fieldType | FATHERS_NAME |
| fieldType | FATHERS_NAME_RUS |
| fieldType | SURNAME_AND_GIVEN_NAMES_RUS |
| fieldType | PLACE_OF_BIRTH_RUS |
| fieldType | AUTHORITY_RUS |
| fieldType | ISSUING_STATE_CODE_NUMERIC |
| fieldType | NATIONALITY_CODE_NUMERIC |
| fieldType | ENGINE_POWER |
| fieldType | ENGINE_VOLUME |
| fieldType | CHASSIS_NUMBER |
| fieldType | ENGINE_NUMBER |
| fieldType | ENGINE_MODEL |
| fieldType | VEHICLE_CATEGORY |
| fieldType | IDENTITY_CARD_NUMBER |
| fieldType | CONTROL_NUMBER |
| fieldType | PARENTS_GIVEN_NAMES |
| fieldType | SECOND_SURNAME |
| fieldType | MIDDLE_NAME |
| fieldType | REG_CERT_VIN |
| fieldType | REG_CERT_VIN_CHECK_DIGIT |
| fieldType | REG_CERT_VIN_CHECKSUM |
| fieldType | LINE_1_CHECK_DIGIT |
| fieldType | LINE_2_CHECK_DIGIT |
| fieldType | LINE_3_CHECK_DIGIT |
| fieldType | LINE_1_CHECKSUM |
| fieldType | LINE_2_CHECKSUM |
| fieldType | LINE_3_CHECKSUM |
| fieldType | REG_CERT_REG_NUMBER_CHECK_DIGIT |
| fieldType | REG_CERT_REG_NUMBER_CHECKSUM |
| fieldType | REG_CERT_VEHICLE_ITS_CODE |
| fieldType | CARD_ACCESS_NUMBER |
| fieldType | MARITAL_STATUS |
| fieldType | COMPANY_NAME |
| fieldType | SPECIAL_NOTES |
| fieldType | SURNAME_OF_SPOUSE |
| fieldType | TRACKING_NUMBER |
| fieldType | BOOKLET_NUMBER |
| fieldType | CHILDREN |
| fieldType | COPY |
| fieldType | SERIAL_NUMBER |
| fieldType | DOSSIER_NUMBER |
| fieldType | AKA_SURNAME_AND_GIVEN_NAMES |
| fieldType | TERRITORIAL_VALIDITY |
| fieldType | MRZ_STRINGS_WITH_CORRECT_CHECK_SUMS |
| fieldType | DL_CDL_RESTRICTION_CODE |
| fieldType | DL_UNDER_18_DATE |
| fieldType | DL_RECORD_CREATED |
| fieldType | DL_DUPLICATE_DATE |
| fieldType | DL_ISSUE_TYPE |
| fieldType | MILITARY_BOOK_NUMBER |
| fieldType | DESTINATION |
| fieldType | BLOOD_GROUP |
| fieldType | SEQUENCE_NUMBER |
| fieldType | REG_CERT_BODY_TYPE |
| fieldType | REG_CERT_CAR_MARK |
| fieldType | TRANSACTION_NUMBER |
| fieldType | AGE |
| fieldType | FOLIO_NUMBER |
| fieldType | VOTER_KEY |
| fieldType | ADDRESS_MUNICIPALITY |
| fieldType | ADDRESS_LOCATION |
| fieldType | SECTION |
| fieldType | OCR_NUMBER |
| fieldType | FEDERAL_ELECTIONS |
| fieldType | REFERENCE_NUMBER |
| fieldType | OPTIONAL_DATA_CHECKSUM |
| fieldType | OPTIONAL_DATA_CHECK_DIGIT |
| fieldType | VISA_NUMBER |
| fieldType | VISA_NUMBER_CHECKSUM |
| fieldType | VISA_NUMBER_CHECK_DIGIT |
| fieldType | VOTER |
| fieldType | PREVIOUS_TYPE |
| fieldType | FIELD_FROM_MRZ |
| fieldType | CURRENT_DATE |
| fieldType | STATUS_DATE_OF_EXPIRY |
| fieldType | BANKNOTE_NUMBER |
| fieldType | CSC_CODE |
| fieldType | ARTISTIC_NAME |
| fieldType | ACADEMIC_TITLE |
| fieldType | ADDRESS_COUNTRY |
| fieldType | ADDRESS_ZIP_CODE |
| fieldType | E_ID_RESIDENCE_PERMIT_1 |
| fieldType | E_ID_RESIDENCE_PERMIT_2 |
| fieldType | E_ID_PLACE_OF_BIRTH_STREET |
| fieldType | E_ID_PLACE_OF_BIRTH_CITY |
| fieldType | E_ID_PLACE_OF_BIRTH_STATE |
| fieldType | E_ID_PLACE_OF_BIRTH_COUNTRY |
| fieldType | E_ID_PLACE_OF_BIRTH_ZIP_CODE |
| fieldType | CDL_CLASS |
| fieldType | DL_UNDER_19_DATE |
| fieldType | WEIGHT_POUNDS |
| fieldType | LIMITED_DURATION_DOCUMENT_INDICATOR |
| fieldType | ENDORSEMENT_EXPIRATION_DATE |
| fieldType | REVISION_DATE |
| fieldType | COMPLIANCE_TYPE |
| fieldType | FAMILY_NAME_TRUNCATION |
| fieldType | FIRST_NAME_TRUNCATION |
| fieldType | MIDDLE_NAME_TRUNCATION |
| fieldType | EXAM_DATE |
| fieldType | ORGANIZATION |
| fieldType | DEPARTMENT |
| fieldType | PAY_GRADE |
| fieldType | RANK |
| fieldType | BENEFITS_NUMBER |
| fieldType | SPONSOR_SERVICE |
| fieldType | SPONSOR_STATUS |
| fieldType | SPONSOR |
| fieldType | RELATIONSHIP |
| fieldType | USCIS |
| fieldType | CATEGORY |
| fieldType | CONDITIONS |
| fieldType | IDENTIFIER |
| fieldType | CONFIGURATION |
| fieldType | DISCRETIONARY_DATA |
| fieldType | LINE_1_OPTIONAL_DATA |
| fieldType | LINE_2_OPTIONAL_DATA |
| fieldType | LINE_3_OPTIONAL_DATA |
| fieldType | EQV_CODE |
| fieldType | ALT_CODE |
| fieldType | BINARY_CODE |
| fieldType | PSEUDO_CODE |
| fieldType | FEE |
| fieldType | STAMP_NUMBER |
| fieldType | SBH_SECURITY_OPTIONS |
| fieldType | SBH_INTEGRITY_OPTIONS |
| fieldType | DATE_OF_CREATION |
| fieldType | VALIDITY_PERIOD |
| fieldType | PATRON_HEADER_VERSION |
| fieldType | BDB_TYPE |
| fieldType | BIOMETRIC_TYPE |
| fieldType | BIOMETRIC_SUBTYPE |
| fieldType | BIOMETRIC_PRODUCT_ID |
| fieldType | BIOMETRIC_FORMAT_OWNER |
| fieldType | BIOMETRIC_FORMAT_TYPE |
| fieldType | PHONE |
| fieldType | PROFESSION |
| fieldType | TITLE |
| fieldType | PERSONAL_SUMMARY |
| fieldType | OTHER_VALID_ID |
| fieldType | CUSTODY_INFO |
| fieldType | OTHER_NAME |
| fieldType | OBSERVATIONS |
| fieldType | TAX |
| fieldType | DATE_OF_PERSONALIZATION |
| fieldType | PERSONALIZATION_SN |
| fieldType | OTHER_PERSON_NAME |
| fieldType | PERSON_TO_NOTIFY_DATE_OF_RECORD |
| fieldType | PERSON_TO_NOTIFY_NAME |
| fieldType | PERSON_TO_NOTIFY_PHONE |
| fieldType | PERSON_TO_NOTIFY_ADDRESS |
| fieldType | DS_CERTIFICATE_ISSUER |
| fieldType | DS_CERTIFICATE_SUBJECT |
| fieldType | DS_CERTIFICATE_VALID_FROM |
| fieldType | DS_CERTIFICATE_VALID_TO |
| fieldType | VRC_DATA_OBJECT_ENTRY |
| fieldType | TYPE_APPROVAL_NUMBER |
| fieldType | ADMINISTRATIVE_NUMBER |
| fieldType | DOCUMENT_DISCRIMINATOR |
| fieldType | DATA_DISCRIMINATOR |
| fieldType | ISO_ISSUER_ID_NUMBER |
| fieldType | DTC_VERSION |
| fieldType | DTC_ID |
| fieldType | DTC_DATE_OF_EXPIRY |
| fieldType | GNIB_NUMBER |
| fieldType | DEPT_NUMBER |
| fieldType | TELEX_CODE |
| fieldType | ALLERGIES |
| fieldType | SP_CODE |
| fieldType | COURT_CODE |
| fieldType | CTY |
| fieldType | SPONSOR_SSN |
| fieldType | DOD_NUMBER |
| fieldType | MC_NOVICE_DATE |
| fieldType | DUF_NUMBER |
| fieldType | AGY |
| fieldType | PNR_CODE |
| fieldType | FROM_AIRPORT_CODE |
| fieldType | TO_AIRPORT_CODE |
| fieldType | FLIGHT_NUMBER |
| fieldType | DATE_OF_FLIGHT |
| fieldType | SEAT_NUMBER |
| fieldType | DATE_OF_ISSUE_BOARDING_PASS |
| fieldType | CCW_UNTIL |
| fieldType | REFERENCE_NUMBER_CHECKSUM |
| fieldType | REFERENCE_NUMBER_CHECK_DIGIT |
| fieldType | ROOM_NUMBER |
| fieldType | RELIGION |
| fieldType | REMAINDER_TERM |
| fieldType | ELECTRONIC_TICKET_INDICATOR |
| fieldType | COMPARTMENT_CODE |
| fieldType | CHECK_IN_SEQUENCE_NUMBER |
| fieldType | AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER |
| fieldType | AIRLINE_NUMERIC_CODE |
| fieldType | TICKET_NUMBER |
| fieldType | FREQUENT_FLYER_AIRLINE_DESIGNATOR |
| fieldType | FREQUENT_FLYER_NUMBER |
| fieldType | FREE_BAGGAGE_ALLOWANCE |
| fieldType | PDF417_CODEC |
| fieldType | IDENTITY_CARD_NUMBER_CHECKSUM |
| fieldType | IDENTITY_CARD_NUMBER_CHECK_DIGIT |
| fieldType | VETERAN |
| fieldType | DL_CLASS_CODE_A1_FROM |
| fieldType | DL_CLASS_CODE_A1_TO |
| fieldType | DL_CLASS_CODE_A1_NOTES |
| fieldType | DL_CLASS_CODE_A_FROM |
| fieldType | DL_CLASS_CODE_A_TO |
| fieldType | DL_CLASS_CODE_A_NOTES |
| fieldType | DL_CLASS_CODE_B_FROM |
| fieldType | DL_CLASS_CODE_B_TO |
| fieldType | DL_CLASS_CODE_B_NOTES |
| fieldType | DL_CLASS_CODE_C1_FROM |
| fieldType | DL_CLASS_CODE_C1_TO |
| fieldType | DL_CLASS_CODE_C1_NOTES |
| fieldType | DL_CLASS_CODE_C_FROM |
| fieldType | DL_CLASS_CODE_C_TO |
| fieldType | DL_CLASS_CODE_C_NOTES |
| fieldType | DL_CLASS_CODE_D1_FROM |
| fieldType | DL_CLASS_CODE_D1_TO |
| fieldType | DL_CLASS_CODE_D1_NOTES |
| fieldType | DL_CLASS_CODE_D_FROM |
| fieldType | DL_CLASS_CODE_D_TO |
| fieldType | DL_CLASS_CODE_D_NOTES |
| fieldType | DL_CLASS_CODE_BE_FROM |
| fieldType | DL_CLASS_CODE_BE_TO |
| fieldType | DL_CLASS_CODE_BE_NOTES |
| fieldType | DL_CLASS_CODE_C1E_FROM |
| fieldType | DL_CLASS_CODE_C1E_TO |
| fieldType | DL_CLASS_CODE_C1E_NOTES |
| fieldType | DL_CLASS_CODE_CE_FROM |
| fieldType | DL_CLASS_CODE_CE_TO |
| fieldType | DL_CLASS_CODE_CE_NOTES |
| fieldType | DL_CLASS_CODE_D1E_FROM |
| fieldType | DL_CLASS_CODE_D1E_TO |
| fieldType | DL_CLASS_CODE_D1E_NOTES |
| fieldType | DL_CLASS_CODE_DE_FROM |
| fieldType | DL_CLASS_CODE_DE_TO |
| fieldType | DL_CLASS_CODE_DE_NOTES |
| fieldType | DL_CLASS_CODE_M_FROM |
| fieldType | DL_CLASS_CODE_M_TO |
| fieldType | DL_CLASS_CODE_M_NOTES |
| fieldType | DL_CLASS_CODE_L_FROM |
| fieldType | DL_CLASS_CODE_L_TO |
| fieldType | DL_CLASS_CODE_L_NOTES |
| fieldType | DL_CLASS_CODE_T_FROM |
| fieldType | DL_CLASS_CODE_T_TO |
| fieldType | DL_CLASS_CODE_T_NOTES |
| fieldType | DL_CLASS_CODE_AM_FROM |
| fieldType | DL_CLASS_CODE_AM_TO |
| fieldType | DL_CLASS_CODE_AM_NOTES |
| fieldType | DL_CLASS_CODE_A2_FROM |
| fieldType | DL_CLASS_CODE_A2_TO |
| fieldType | DL_CLASS_CODE_A2_NOTES |
| fieldType | DL_CLASS_CODE_B1_FROM |
| fieldType | DL_CLASS_CODE_B1_TO |
| fieldType | DL_CLASS_CODE_B1_NOTES |
| fieldType | SURNAME_AT_BIRTH |
| fieldType | CIVIL_STATUS |
| fieldType | NUMBER_OF_SEATS |
| fieldType | NUMBER_OF_STANDING_PLACES |
| fieldType | MAX_SPEED |
| fieldType | FUEL_TYPE |
| fieldType | EC_ENVIRONMENTAL_TYPE |
| fieldType | POWER_WEIGHT_RATIO |
| fieldType | MAX_MASS_OF_TRAILER_BRAKED |
| fieldType | MAX_MASS_OF_TRAILER_UNBRAKED |
| fieldType | TRANSMISSION_TYPE |
| fieldType | TRAILER_HITCH |
| fieldType | ACCOMPANIED_BY |
| fieldType | POLICE_DISTRICT |
| fieldType | FIRST_ISSUE_DATE |
| fieldType | PAYLOAD_CAPACITY |
| fieldType | NUMBER_OF_AXLES |
| fieldType | PERMISSIBLE_AXLE_LOAD |
| fieldType | PRECINCT |
| fieldType | INVITED_BY |
| fieldType | PURPOSE_OF_ENTRY |
| fieldType | SKIN_COLOR |
| fieldType | COMPLEXION |
| fieldType | AIRPORT_FROM |
| fieldType | AIRPORT_TO |
| fieldType | AIRLINE_NAME |
| fieldType | AIRLINE_NAME_FREQUENT_FLYER |
| fieldType | LICENSE_NUMBER |
| fieldType | IN_TANKS |
| fieldType | EXCEPT_IN_TANKS |
| fieldType | FAST_TRACK |
| fieldType | OWNER |
| fieldType | MRZ_STRINGS_ICAO_RFID |
| fieldType | NUMBER_OF_CARD_ISSUANCE |
| fieldType | NUMBER_OF_CARD_ISSUANCE_CHECKSUM |
| fieldType | NUMBER_OF_CARD_ISSUANCE_CHECK_DIGIT |
| fieldType | CENTURY_DATE_OF_BIRTH |
| fieldType | DL_CLASS_CODE_A3_FROM |
| fieldType | DL_CLASS_CODE_A3_TO |
| fieldType | DL_CLASS_CODE_A3_NOTES |
| fieldType | DL_CLASS_CODE_C2_FROM |
| fieldType | DL_CLASS_CODE_C2_TO |
| fieldType | DL_CLASS_CODE_C2_NOTES |
| fieldType | DL_CLASS_CODE_B2_FROM |
| fieldType | DL_CLASS_CODE_B2_TO |
| fieldType | DL_CLASS_CODE_B2_NOTES |
| fieldType | DL_CLASS_CODE_D2_FROM |
| fieldType | DL_CLASS_CODE_D2_TO |
| fieldType | DL_CLASS_CODE_D2_NOTES |
| fieldType | DL_CLASS_CODE_B2E_FROM |
| fieldType | DL_CLASS_CODE_B2E_TO |
| fieldType | DL_CLASS_CODE_B2E_NOTES |
| fieldType | DL_CLASS_CODE_G_FROM |
| fieldType | DL_CLASS_CODE_G_TO |
| fieldType | DL_CLASS_CODE_G_NOTES |
| fieldType | DL_CLASS_CODE_J_FROM |
| fieldType | DL_CLASS_CODE_J_TO |
| fieldType | DL_CLASS_CODE_J_NOTES |
| fieldType | DL_CLASS_CODE_LC_FROM |
| fieldType | DL_CLASS_CODE_LC_TO |
| fieldType | DL_CLASS_CODE_LC_NOTES |
| fieldType | BANK_CARD_NUMBER |
| fieldType | BANK_CARD_VALID_THRU |
| fieldType | TAX_NUMBER |
| fieldType | HEALTH_NUMBER |
| fieldType | GRANDFATHER_NAME |
| fieldType | SELECTEE_INDICATOR |
| fieldType | MOTHER_SURNAME |
| fieldType | MOTHER_GIVEN_NAME |
| fieldType | FATHER_SURNAME |
| fieldType | FATHER_GIVEN_NAME |
| fieldType | MOTHER_DATE_OF_BIRTH |
| fieldType | FATHER_DATE_OF_BIRTH |
| fieldType | MOTHER_PERSONAL_NUMBER |
| fieldType | FATHER_PERSONAL_NUMBER |
| fieldType | MOTHER_PLACE_OF_BIRTH |
| fieldType | FATHER_PLACE_OF_BIRTH |
| fieldType | MOTHER_COUNTRY_OF_BIRTH |
| fieldType | FATHER_COUNTRY_OF_BIRTH |
| fieldType | DATE_FIRST_RENEWAL |
| fieldType | DATE_SECOND_RENEWAL |
| fieldType | PLACE_OF_EXAMINATION |
| fieldType | APPLICATION_NUMBER |
| fieldType | VOUCHER_NUMBER |
| fieldType | AUTHORIZATION_NUMBER |
| fieldType | FACULTY |
| fieldType | FORM_OF_EDUCATION |
| fieldType | DNI_NUMBER |
| fieldType | RETIREMENT_NUMBER |
| fieldType | PROFESSIONAL_ID_NUMBER |
| fieldType | AGE_AT_ISSUE |
| fieldType | YEARS_SINCE_ISSUE |
| fieldType | DL_CLASS_CODE_BTP_FROM |
| fieldType | DL_CLASS_CODE_BTP_NOTES |
| fieldType | DL_CLASS_CODE_BTP_TO |
| fieldType | DL_CLASS_CODE_C3_FROM |
| fieldType | DL_CLASS_CODE_C3_NOTES |
| fieldType | DL_CLASS_CODE_C3_TO |
| fieldType | DL_CLASS_CODE_E_FROM |
| fieldType | DL_CLASS_CODE_E_NOTES |
| fieldType | DL_CLASS_CODE_E_TO |
| fieldType | DL_CLASS_CODE_F_FROM |
| fieldType | DL_CLASS_CODE_F_NOTES |
| fieldType | DL_CLASS_CODE_F_TO |
| fieldType | DL_CLASS_CODE_FA_FROM |
| fieldType | DL_CLASS_CODE_FA_NOTES |
| fieldType | DL_CLASS_CODE_FA_TO |
| fieldType | DL_CLASS_CODE_FA1_FROM |
| fieldType | DL_CLASS_CODE_FA1_NOTES |
| fieldType | DL_CLASS_CODE_FA1_TO |
| fieldType | DL_CLASS_CODE_FB_FROM |
| fieldType | DL_CLASS_CODE_FB_NOTES |
| fieldType | DL_CLASS_CODE_FB_TO |
| fieldType | DL_CLASS_CODE_G1_FROM |
| fieldType | DL_CLASS_CODE_G1_NOTES |
| fieldType | DL_CLASS_CODE_G1_TO |
| fieldType | DL_CLASS_CODE_H_FROM |
| fieldType | DL_CLASS_CODE_H_NOTES |
| fieldType | DL_CLASS_CODE_H_TO |
| fieldType | DL_CLASS_CODE_I_FROM |
| fieldType | DL_CLASS_CODE_I_NOTES |
| fieldType | DL_CLASS_CODE_I_TO |
| fieldType | DL_CLASS_CODE_K_FROM |
| fieldType | DL_CLASS_CODE_K_NOTES |
| fieldType | DL_CLASS_CODE_K_TO |
| fieldType | DL_CLASS_CODE_LK_FROM |
| fieldType | DL_CLASS_CODE_LK_NOTES |
| fieldType | DL_CLASS_CODE_LK_TO |
| fieldType | DL_CLASS_CODE_N_FROM |
| fieldType | DL_CLASS_CODE_N_NOTES |
| fieldType | DL_CLASS_CODE_N_TO |
| fieldType | DL_CLASS_CODE_S_FROM |
| fieldType | DL_CLASS_CODE_S_NOTES |
| fieldType | DL_CLASS_CODE_S_TO |
| fieldType | DL_CLASS_CODE_TB_FROM |
| fieldType | DL_CLASS_CODE_TB_NOTES |
| fieldType | DL_CLASS_CODE_TB_TO |
| fieldType | DL_CLASS_CODE_TM_FROM |
| fieldType | DL_CLASS_CODE_TM_NOTES |
| fieldType | DL_CLASS_CODE_TM_TO |
| fieldType | DL_CLASS_CODE_TR_FROM |
| fieldType | DL_CLASS_CODE_TR_NOTES |
| fieldType | DL_CLASS_CODE_TR_TO |
| fieldType | DL_CLASS_CODE_TV_FROM |
| fieldType | DL_CLASS_CODE_TV_NOTES |
| fieldType | DL_CLASS_CODE_TV_TO |
| fieldType | DL_CLASS_CODE_V_FROM |
| fieldType | DL_CLASS_CODE_V_NOTES |
| fieldType | DL_CLASS_CODE_V_TO |
| fieldType | DL_CLASS_CODE_W_FROM |
| fieldType | DL_CLASS_CODE_W_NOTES |
| fieldType | DL_CLASS_CODE_W_TO |
| fieldType | URL |
| fieldType | CALIBER |
| fieldType | MODEL |
| fieldType | MAKE |
| fieldType | NUMBER_OF_CYLINDERS |
| fieldType | SURNAME_OF_HUSBAND_AFTER_REGISTRATION |
| fieldType | SURNAME_OF_WIFE_AFTER_REGISTRATION |
| fieldType | DATE_OF_BIRTH_OF_WIFE |
| fieldType | DATE_OF_BIRTH_OF_HUSBAND |
| fieldType | CITIZENSHIP_OF_FIRST_PERSON |
| fieldType | CITIZENSHIP_OF_SECOND_PERSON |
| fieldType | CVV |
| fieldType | DATE_OF_INSURANCE_EXPIRY |
| fieldType | MORTGAGE_BY |
| fieldType | OLD_DOCUMENT_NUMBER |
| fieldType | OLD_DATE_OF_ISSUE |
| fieldType | OLD_PLACE_OF_ISSUE |
| fieldType | DL_CLASS_CODE_LR_FROM |
| fieldType | DL_CLASS_CODE_LR_TO |
| fieldType | DL_CLASS_CODE_LR_NOTES |
| fieldType | DL_CLASS_CODE_MR_FROM |
| fieldType | DL_CLASS_CODE_MR_TO |
| fieldType | DL_CLASS_CODE_MR_NOTES |
| fieldType | DL_CLASS_CODE_HR_FROM |
| fieldType | DL_CLASS_CODE_HR_TO |
| fieldType | DL_CLASS_CODE_HR_NOTES |
| fieldType | DL_CLASS_CODE_HC_FROM |
| fieldType | DL_CLASS_CODE_HC_TO |
| fieldType | DL_CLASS_CODE_HC_NOTES |
| fieldType | DL_CLASS_CODE_MC_FROM |
| fieldType | DL_CLASS_CODE_MC_TO |
| fieldType | DL_CLASS_CODE_MC_NOTES |
| fieldType | DL_CLASS_CODE_RE_FROM |
| fieldType | DL_CLASS_CODE_RE_TO |
| fieldType | DL_CLASS_CODE_RE_NOTES |
| fieldType | DL_CLASS_CODE_R_FROM |
| fieldType | DL_CLASS_CODE_R_TO |
| fieldType | DL_CLASS_CODE_R_NOTES |
| fieldType | DL_CLASS_CODE_CA_FROM |
| fieldType | DL_CLASS_CODE_CA_TO |
| fieldType | DL_CLASS_CODE_CA_NOTES |
| fieldType | CITIZENSHIP_STATUS |
| fieldType | MILITARY_SERVICE_FROM |
| fieldType | MILITARY_SERVICE_TO |
| fieldType | DL_CLASS_CODE_NT_FROM |
| fieldType | DL_CLASS_CODE_NT_TO |
| fieldType | DL_CLASS_CODE_NT_NOTES |
| fieldType | DL_CLASS_CODE_TN_FROM |
| fieldType | DL_CLASS_CODE_TN_TO |
| fieldType | DL_CLASS_CODE_TN_NOTES |
| fieldType | DL_CLASS_CODE_D3_FROM |
| fieldType | DL_CLASS_CODE_D3_TO |
| fieldType | DL_CLASS_CODE_D3_NOTES |
| fieldType | ALT_DATE_OF_EXPIRY |
| fieldType | DL_CLASS_CODE_CD_FROM |
| fieldType | DL_CLASS_CODE_CD_TO |
| fieldType | DL_CLASS_CODE_CD_NOTES |
| fieldType | ISSUER_IDENTIFICATION_NUMBER |
| fieldType | PAYMENT_PERIOD_FROM |
| fieldType | PAYMENT_PERIOD_TO |
| fieldType | VACCINATION_CERTIFICATE_IDENTIFIER |
| fieldType | FIRST_NAME |
| fieldType | DATE_OF_ARRIVAL |
| fieldType | SECOND_NAME |
| fieldType | THIRD_NAME |
| fieldType | FOURTH_NAME |
| fieldType | LAST_NAME |
| fieldType | DL_CLASS_CODE_RM_FROM |
| fieldType | DL_CLASS_CODE_RM_NOTES |
| fieldType | DL_CLASS_CODE_RM_TO |
| fieldType | DL_CLASS_CODE_PW_FROM |
| fieldType | DL_CLASS_CODE_PW_NOTES |
| fieldType | DL_CLASS_CODE_PW_TO |
| fieldType | DL_CLASS_CODE_EB_FROM |
| fieldType | DL_CLASS_CODE_EB_NOTES |
| fieldType | DL_CLASS_CODE_EB_TO |
| fieldType | DL_CLASS_CODE_EC_FROM |
| fieldType | DL_CLASS_CODE_EC_NOTES |
| fieldType | DL_CLASS_CODE_EC_TO |
| fieldType | DL_CLASS_CODE_EC1_FROM |
| fieldType | DL_CLASS_CODE_EC1_NOTES |
| fieldType | DL_CLASS_CODE_EC1_TO |
| fieldType | PLACE_OF_BIRTH_CITY |
| fieldType | YEAR_OF_BIRTH |
| fieldType | YEAR_OF_EXPIRY |
| fieldType | GRANDFATHER_NAME_MATERNAL |
| fieldType | FIRST_SURNAME |
| fieldType | MONTH_OF_BIRTH |
| fieldType | ADDRESS_FLOOR_NUMBER |
| fieldType | ADDRESS_ENTRANCE |
| fieldType | ADDRESS_BLOCK_NUMBER |
| fieldType | ADDRESS_STREET_NUMBER |
| fieldType | ADDRESS_STREET_TYPE |
| fieldType | ADDRESS_CITY_SECTOR |
| fieldType | ADDRESS_COUNTY_TYPE |
| fieldType | ADDRESS_CITY_TYPE |
| fieldType | ADDRESS_BUILDING_TYPE |
| fieldType | DATE_OF_RETIREMENT |
| fieldType | DOCUMENT_STATUS |
| fieldType | SIGNATURE |
| fieldType | FT_UNIQUE_CERTIFICATE_IDENTIFIER |
| fieldType | FT_EMAIL |
| fieldType | FT_DATE_OF_SPECIMEN_COLLECTION |
| fieldType | FT_TYPE_OF_TESTING |
| fieldType | FT_RESULT_OF_TESTING |
| fieldType | FT_METHOD_OF_TESTING |
| fieldType | FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER |
| fieldType | FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT |
| fieldType | EF_CARD_ACCESS |
| fieldType | SHORT_FLIGHT_NUMBER |
| fieldType | AIRLINE_CODE |
| fieldType | FT_MVC_AGENCY |
| fieldType | FT_ISSUING_STATE_CODE_ALPHA2 |
| fieldType | FT_NATIONALITY_CODE_ALPHA2 |
| fieldType | FT_FIRST_ISSUE_DATE_CHECKDIGIT |
| fieldType | FT_FIRST_ISSUE_DATE_CHECKSUM |
| fieldType | FT_COMMERCIAL_INDICATOR |
| fieldType | FT_COMMERCIAL_INDICATOR |
| fieldType | FT_JURISDICTION_SPECIFIC_DATA |
| lcid | LATIN |
| lcid | ARABIC_SAUDI_ARABIA |
| lcid | BULGARIAN |
| lcid | CATALAN |
| lcid | CHINESE_TAIWAN |
| lcid | CZECH |
| lcid | DANISH |
| lcid | GERMAN_GERMANY |
| lcid | GREEK |
| lcid | ENGLISH_US |
| lcid | SPANISH_TRADITIONAL_SORT |
| lcid | FINNISH |
| lcid | FRENCH_FRANCE |
| lcid | HEBREW |
| lcid | HUNGARIAN |
| lcid | ICELANDIC |
| lcid | ITALIAN_ITALY |
| lcid | JAPANESE |
| lcid | KOREAN |
| lcid | DUTCH_NETHERLANDS |
| lcid | NORWEGIAN_BOKMAL |
| lcid | POLISH |
| lcid | RHAETO_ROMANIC |
| lcid | RHAETO_ROMANIC |
| lcid | ROMANIAN |
| lcid | RUSSIAN |
| lcid | CROATIAN |
| lcid | SLOVAK |
| lcid | ALBANIAN |
| lcid | SWEDISH |
| lcid | THAI_THAILAND |
| lcid | TURKISH |
| lcid | URDU |
| lcid | INDONESIAN |
| lcid | UKRAINIAN |
| lcid | BELARUSIAN |
| lcid | SLOVENIAN |
| lcid | ESTONIAN |
| lcid | LATVIAN |
| lcid | LITHUANIAN |
| lcid | TAJIK_CYRILLIC |
| lcid | FARSI |
| lcid | VIETNAMESE |
| lcid | ARMENIAN |
| lcid | AZERI_LATIN |
| lcid | BASQUE |
| lcid | FYRO_MACEDONIAN |
| lcid | AFRIKAANS |
| lcid | GEORGIAN |
| lcid | FAEROESE |
| lcid | HINDI_INDIA |
| lcid | MALTESE |
| lcid | MALAY_MALAYSIA |
| lcid | KAZAKH |
| lcid | KYRGYZ_CYRILICK |
| lcid | SWAHILI |
| lcid | TURKMEN |
| lcid | UZBEK_LATIN |
| lcid | TATAR |
| lcid | BENGALI_INDIA |
| lcid | PUNJABI |
| lcid | GUJARATI |
| lcid | ORIYA |
| lcid | TAMIL |
| lcid | TELUGU |
| lcid | KANNADA |
| lcid | MALAYALAM |
| lcid | ASSAMESE |
| lcid | MARATHI |
| lcid | SANSKRIT |
| lcid | MONGOLIAN_CYRILIC |
| lcid | KHMER |
| lcid | LAO |
| lcid | BURMESE |
| lcid | GALICIAN |
| lcid | KONKANI |
| lcid | SINDHI_INDIA |
| lcid | SYRIAC |
| lcid | SINHALA |
| lcid | AMHARIC |
| lcid | KASHMIRI |
| lcid | NEPALI |
| lcid | PASHTO |
| lcid | DIVEHI |
| lcid | ARABIC_IRAQ |
| lcid | CHINESE |
| lcid | GERMAN_SWITZERLAND |
| lcid | ENGLISH_UK |
| lcid | SPANISH_MEXICO |
| lcid | FRENCH_BELGIUM |
| lcid | ITALIAN_SWITZERLAND |
| lcid | DUTCH_BELGIUM |
| lcid | NORWEGIAN_NYORSK |
| lcid | PORTUGUESE_PORTUGAL |
| lcid | SERBIAN_LATIN |
| lcid | SWEDISH_FINLAND |
| lcid | AZERI_CYRILIC |
| lcid | MALAY_BRUNEI_DARUSSALAM |
| lcid | UZBEK_CYRILIC |
| lcid | BENGALI_BANGLADESH |
| lcid | SINDHI |
| lcid | ARABIC_EGYPT |
| lcid | CHINESE_HONGKONG_SAR |
| lcid | GERMAN_AUSTRIA |
| lcid | ENGLISH_AUSTRALIA |
| lcid | SPANISH_INTERNATIONAL_SORT |
| lcid | FRENCH_CANADA |
| lcid | SERBIAN_CYRILIC |
| lcid | ARABIC |
| lcid | ARABIC_LIBYA |
| lcid | CHINESE_SINGAPORE |
| lcid | GERMAN_LUXEMBOURG |
| lcid | ENGLISH_CANADA |
| lcid | SPANISH_GUATEMALA |
| lcid | FRENCH_SWITZERLAND |
| lcid | ARABIC_ALGERIA |
| lcid | CHINESE_MACAO_SAR |
| lcid | GERMAN_LIECHTENSTEIN |
| lcid | ENGLISH_NEW_ZEALAND |
| lcid | SPANISH_COSTA_RICA |
| lcid | FRENCH_LUXEMBOURG |
| lcid | ARABIC_MOROCCO |
| lcid | ENGLISH_IRELAND |
| lcid | SPANISH_PANAMA |
| lcid | FRENCH_MONACO |
| lcid | ARABIC_TUNISIA |
| lcid | ENGLISH_SOUTH_AFRICA |
| lcid | SPANISH_DOMINICAN_REPUBLIC |
| lcid | ARABIC_OMAN |
| lcid | ENGLISH_JAMAICA |
| lcid | SPANISH_VENEZUELA |
| lcid | ARABIC_YEMEN |
| lcid | ENGLISH_CARRIBEAN |
| lcid | SPANICH_COLOMBIA |
| lcid | BANK_CARD_NUMBER |
| lcid | BANK_CARD_EXPIRY_DATE |
| lcid | BANK_CARD_NAME |
| lcid | BANK_CARD |
| lcid | BANK_CARD_CVV2 |
| lcid | ABKHAZIAN |
| lcid | KARAKALPAK |
| lcid | ARABIC_SYRIA |
| lcid | ENGLISH_BELIZE |
| lcid | SPANISH_PERU |
| lcid | URDU_DETECTION |
| lcid | ARABIC_JORDAN |
| lcid | ENGLISH_TRINIDAD |
| lcid | SPANISH_ARGENTINA |
| lcid | ARABIC_LEBANON |
| lcid | ENGLISH_ZIMBABWE |
| lcid | SPANISH_ECUADOR |
| lcid | ARABIC_KUWAIT |
| lcid | ENGLISH_PHILIPPINES |
| lcid | SPANISH_CHILE |
| lcid | ARABIC_UAE |
| lcid | SPANISH_URUGUAY |
| lcid | ARABIC_BAHRAIN |
| lcid | SPANISH_PARAGUAY |
| lcid | ARABIC_QATAR |
| lcid | SPANISH_BOLIVIA |
| lcid | SPANISH_EL_SALVADOR |
| lcid | SPANISH_HONDURAS |
| lcid | SPANISH_NICARAGUA |
| lcid | SPANISH_PUERTO_RICO |
| lcid | CTC_SIMPLIFIED |
| lcid | CTC_TRADITIONAL |
| status | ERROR |
| status | OK |
| status | WAS_NOT_DONE |
| validityStatus | ERROR |
| validityStatus | OK |
| validityStatus | WAS_NOT_DONE |
FieldRect
{
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bottom | integer(int32) | false | none | none |
| left | integer(int32) | false | none | none |
| right | integer(int32) | false | none | none |
| top | integer(int32) | false | none | none |
GroupActivityReportParam
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"format": "PDF"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | Length: 1 - undefined | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| format | string¦null | false | none | Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF. |
Enumerated Values
| Property | Value |
|---|---|
| format | |
| format | Word |
| format | Excel |
IDNumber
{
"type": "string",
"idNotes": "string",
"number": "string"
}
Identification or registration numbers from national and international authorities.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Type of ID/registration number. |
| idNotes | string¦null | false | none | Notes for the ID/registration number. |
| number | string¦null | false | none | Value of the ID/registration number. |
IDVCountry0
{
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | Supported country codes are AE, AT, AU, BR, CA, CH, CN, DE, DK, ES, FI, FR, GB, GH, HK, IN, IT, JP, KE, MX, NG, NL, NO, NZ, PL, SE, SG, SL, TR, US, ZA.Check GET /id-verification/single/sms-enabled-countries API method for the list of supported countries and their SMS status. |
IDVFaceMatchResultRa
{
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identityDocumentResult | string¦null | false | none | none |
| dataComparisonResult | string¦null | false | none | none |
| documentExpiryResult | string¦null | false | none | none |
| antiTamperResult | string¦null | false | none | none |
| photoLivelinessResult | string¦null | false | none | none |
| faceComparisonResult | string¦null | false | none | none |
| overallResult | string¦null | false | none | none |
| facematchMRZResult | string¦null | false | none | none |
| facematchPortraitAgeResult | string¦null | false | none | none |
| facematchPublicFigureResult | string¦null | false | none | none |
| facematchIDDocLivelinessResult | string¦null | false | none | none |
| facematchOCRData | IDVResultVerificationOCRDataRa¦null | false | none | none |
| firstNameOCRResult | boolean | false | none | none |
| lastNameOCRResult | boolean | false | none | none |
| birthDateOCRResult | boolean | false | none | none |
| idCountry | string¦null | false | none | none |
| idExpiry | string¦null | false | none | none |
| idFrontCompressed | string¦null | false | none | none |
| idBackCompressed | string¦null | false | none | none |
| livenessCompressed | string¦null | false | none | none |
| livenessProbability | string¦null | false | none | none |
| isLivenessVideo1Available | boolean | false | none | none |
| faceMatchCompletedAt | string(date-time)¦null | false | none | none |
IDVHistoryDetail
{
"idvParam": {
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"birthDate": "15/03/1980",
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"clientId": "CLIENT-001",
"includeRiskAssessment": "No",
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "SUB-001",
"parentOrigin": "https://example.com"
},
"idvResult": {
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "user@example.com",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z",
"idvVerificationResult": {
"driverLicenceResult": {
"requestParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"passportResult": {
"requestParam": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"medicareResult": {
"requestParam": {
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{}
]
}
},
"nationalIDResult": [
{
"transactionId": "string",
"reliability": "NotVerified",
"reliabilityCode": "string",
"errorMessage": "string",
"message": "string",
"nationalIdType": "string",
"country": "string",
"verificationResult": [
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "[",
"dataSource": "string",
"message": "string"
}
]
}
]
}
],
"idCheckCompletionTime": "2019-08-24T14:15:22Z",
"idVerificationSources": [
{
"code": "string",
"dataSource": "string"
}
]
},
"faceMatchVerificationResult": {
"processingTime": 0,
"transactionId": "string",
"statusDetails": {
"overallStatus": "ERROR",
"optical": "ERROR",
"rfid": "ERROR",
"detailsOptical": {
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
},
"portrait": "ERROR",
"stopList": "ERROR"
},
"graphicFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"fieldList": [
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": null,
"containerType": null,
"source": null,
"lightIndex": null,
"fieldRect": null,
"originalPageIndex": null,
"pageIndex": null
}
]
}
]
},
"textFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"comparisonStatus": "ERROR",
"dateFormat": "string",
"fieldList": [
{
"comparisonList": [
{
"sourceLeft": null,
"sourceRight": null,
"status": null
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": null,
"status": null
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": null,
"fieldRect": null,
"originalSymbols": null,
"originalValidity": null,
"pageIndex": null,
"probability": null,
"source": null,
"status": null,
"value": null
}
]
}
],
"status": "ERROR",
"validityStatus": "ERROR"
},
"documentTypeDetails": [
{
"authenticityNecessaryLights": 0,
"checkAuthenticity": 0,
"documentName": "string",
"fdsidList": {
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
},
"id": 0,
"necessaryLights": 0,
"oviExp": 0,
"p": 0,
"rfiD_Presence": 0,
"rotated180": true,
"uvExp": 0,
"pageIdx": 0
}
],
"imageQualityDetails": [
{
"count": 0,
"list": [
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
],
"result": "ERROR",
"pageIdx": 0
}
],
"portraitComparison": {
"code": "FACER_OK",
"detections": [
{
"faces": [
{
"faceIndex": null,
"rotationAngle": null,
"crop": null
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
],
"results": [
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
]
},
"securityChecks": [
{
"count": 0,
"list": [
{
"count": 0,
"list": [
{
"elementType": "[",
"elementResult": "[",
"elementDiagnose": "[",
"image": null,
"etalonImage": null,
"percentValue": 0,
"lightIndex": "[",
"sourceImage": null,
"resultImages": null
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
],
"pageIdx": 0
}
],
"livenessDetectionResult": {
"livenessDetectionStatus": 0,
"estimatedAge": 0,
"livenessDetectionTransactionId": "string",
"isLivenessVideoPresent": true
},
"originalImages": [
{
"pageIdx": 0,
"image": "string"
}
],
"faceMatchCompletionTime": "2019-08-24T14:15:22Z"
}
},
"idvFaceMatchStatus": "Pass",
"signatureKey": "string",
"idvUrl": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"idvStatus": "NotVerified",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| idvParam | IDVInputParam¦null | false | none | ID Verification scan parameters. |
| idvResult | IDVResultRa¦null | false | none | none |
| idvFaceMatchStatus | string¦null | false | none | none |
| signatureKey | string¦null | false | none | none |
| idvUrl | string¦null | false | none | Indicates the URL of the ID Verification. |
| organisation | string¦null | false | none | none |
| user | string¦null | false | none | none |
| date | string(date-time) | false | none | none |
| idvStatus | string¦null | false | none | none |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
IDVInputParam
{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"birthDate": "15/03/1980",
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"clientId": "CLIENT-001",
"includeRiskAssessment": "No",
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "SUB-001",
"parentOrigin": "https://example.com"
}
ID Verification scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | Length: 0 - 249 | Person's first or given name - this field is mandatory (unless you are entering an Original Script Name). |
| middleName | string¦null | false | Length: 0 - 255 | Person's middle or second name - if available. |
| lastName | string¦null | false | Length: 0 - 251 | Person's surname or last name - this field is mandatory (unless you are entering an Original Script Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | Person's original script name. |
| birthDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Person's birth date, if available, using the format DD/MM/YYYY. |
| mobileNumber | string¦null | false | none | Person's mobile number to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Person's email address to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| country | IDVCountry0¦null | false | none | Country of source for document and biometric facial-matching verification. Refer to IDVCountry0.code for details of supported country codes. |
| idvType | string¦null | true | none | Type of verification for the person i.e. IDCheck for documentation verification, FaceMatch for biometric facial-matching, or both. |
| idvSubType | string¦null | false | none | Specify the execution or delivery method of the idvType i.e. email or SMS. If this is not defined, the default SMS option will be used. Ensure you enter the mobileNumber or emailAddress depending on the idvSubType. Please only select from the following values IDCheck_Sms, IDCheck_Email, IDCheck_FaceMatch_Sms, IDCheck_FaceMatch_Email, FaceMatch_Sms, FaceMatch_Email. |
| allowDuplicateIDVScan | boolean | false | none | Allow any detected duplicate scans with the same details such as name, date of birth and country of verification which was run within the last 24 hours to proceed. |
| clientId | string¦null | false | Length: 0 - 100 | Reference number to help search and identify the screened individual. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| verificationProcess | string¦null | false | none | Specifies the ID verification process, such as Step by Step check or Comprehensive check. |
| consent | boolean¦null | false | none | Indicates whether consent has been obtained from the document holder to verify their identifying information. |
| idvDataSource | string¦null | false | none | Contains the type of source for the id check verification request. |
| idvAssuranceLevel | string¦null | false | none | Contains the assurance level for the id check verification request. |
| subscriberCode | string¦null | false | none | Contains the subscriber code for the id check process. |
| parentOrigin | string¦null | false | none | Contains the origin of the parent window that initiated the ID verification request. |
Enumerated Values
| Property | Value |
|---|---|
| idvType | IDCheck |
| idvType | IDCheck_FaceMatch |
| idvType | FaceMatch |
| idvSubType | IDCheck_Sms |
| idvSubType | IDCheck_Email |
| idvSubType | IDCheck_FaceMatch_Sms |
| idvSubType | IDCheck_FaceMatch_Email |
| idvSubType | FaceMatch_Sms |
| idvSubType | FaceMatch_Email |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| verificationProcess | StepByStep |
| verificationProcess | Comprehensive |
| idvDataSource | AuGovtVerification |
| idvDataSource | AuGovtRecords |
| idvDataSource | Commercial |
| idvAssuranceLevel | SingleSource |
| idvAssuranceLevel | CrossSource |
IDVResponse
{
"scanId": 0,
"idvUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | false | none | The identifier of this scan. |
| idvUrl | string¦null | false | none | URL to complete the form for IDV scan via a third-party web page. |
IDVResultRa
{
"signatureKey": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"birthDate": "string",
"phone": "string",
"email": "user@example.com",
"country": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"latitude": "string",
"longitude": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"verificationSourceResults": [
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
],
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string",
"quickIdOverallResult": "string",
"overallResult": "string",
"faceMatchResult": {
"identityDocumentResult": "string",
"dataComparisonResult": "string",
"documentExpiryResult": "string",
"antiTamperResult": "string",
"photoLivelinessResult": "string",
"faceComparisonResult": "string",
"overallResult": "string",
"facematchMRZResult": "string",
"facematchPortraitAgeResult": "string",
"facematchPublicFigureResult": "string",
"facematchIDDocLivelinessResult": "string",
"facematchOCRData": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
},
"firstNameOCRResult": true,
"lastNameOCRResult": true,
"birthDateOCRResult": true,
"idCountry": "string",
"idExpiry": "string",
"idFrontCompressed": "string",
"idBackCompressed": "string",
"livenessCompressed": "string",
"livenessProbability": "string",
"isLivenessVideo1Available": true,
"faceMatchCompletedAt": "2019-08-24T14:15:22Z"
},
"quickIDCompletedAt": "2019-08-24T14:15:22Z",
"idvVerificationResult": {
"driverLicenceResult": {
"requestParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"passportResult": {
"requestParam": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"medicareResult": {
"requestParam": {
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"nationalIDResult": [
{
"transactionId": "string",
"reliability": "NotVerified",
"reliabilityCode": "string",
"errorMessage": "string",
"message": "string",
"nationalIdType": "string",
"country": "string",
"verificationResult": [
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "NotVerified",
"dataSource": "string",
"message": "string"
}
]
}
]
}
],
"idCheckCompletionTime": "2019-08-24T14:15:22Z",
"idVerificationSources": [
{
"code": "string",
"dataSource": "string"
}
]
},
"faceMatchVerificationResult": {
"processingTime": 0,
"transactionId": "string",
"statusDetails": {
"overallStatus": "ERROR",
"optical": "ERROR",
"rfid": "ERROR",
"detailsOptical": {
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
},
"portrait": "ERROR",
"stopList": "ERROR"
},
"graphicFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"fieldList": [
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": "string",
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"lightIndex": "OFF",
"fieldRect": {
"bottom": null,
"left": null,
"right": null,
"top": null
},
"originalPageIndex": 0,
"pageIndex": 0
}
]
}
]
},
"textFieldsDetails": {
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"comparisonStatus": "ERROR",
"dateFormat": "string",
"fieldList": [
{
"comparisonList": [
{
"sourceLeft": "MRZ",
"sourceRight": "MRZ",
"status": "ERROR"
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": "string",
"status": "ERROR"
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": "DOCUMENT_IMAGE",
"fieldRect": {
"bottom": null,
"left": null,
"right": null,
"top": null
},
"originalSymbols": [
{
"code": "string",
"probability": 0,
"rect": null
}
],
"originalValidity": 0,
"pageIndex": 0,
"probability": 0,
"source": "string",
"status": "string",
"value": "string"
}
]
}
],
"status": "ERROR",
"validityStatus": "ERROR"
},
"documentTypeDetails": [
{
"authenticityNecessaryLights": 0,
"checkAuthenticity": 0,
"documentName": "string",
"fdsidList": {
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
},
"id": 0,
"necessaryLights": 0,
"oviExp": 0,
"p": 0,
"rfiD_Presence": 0,
"rotated180": true,
"uvExp": 0,
"pageIdx": 0
}
],
"imageQualityDetails": [
{
"count": 0,
"list": [
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
],
"result": "ERROR",
"pageIdx": 0
}
],
"portraitComparison": {
"code": "FACER_OK",
"detections": [
{
"faces": [
{
"faceIndex": 0,
"rotationAngle": 0,
"crop": "string"
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
],
"results": [
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
]
},
"securityChecks": [
{
"count": 0,
"list": [
{
"count": 0,
"list": [
{
"elementType": "BLANK",
"elementResult": "ERROR",
"elementDiagnose": "UNKNOWN",
"image": {
"format": "string",
"image": "string"
},
"etalonImage": {
"format": "string",
"image": "string"
},
"percentValue": 0,
"lightIndex": "OFF",
"sourceImage": {
"format": "string",
"image": "string"
},
"resultImages": {
"count": 0,
"images": [
null
]
}
}
],
"result": "ERROR",
"type": "UV_LUMINESCENCE"
}
],
"pageIdx": 0
}
],
"livenessDetectionResult": {
"livenessDetectionStatus": 0,
"estimatedAge": 0,
"livenessDetectionTransactionId": "string",
"isLivenessVideoPresent": true
},
"originalImages": [
{
"pageIdx": 0,
"image": "string"
}
],
"faceMatchCompletionTime": "2019-08-24T14:15:22Z"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| signatureKey | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| fullName | string¦null | false | none | none |
| birthDate | string¦null | false | none | none |
| phone | string¦null | false | none | none |
| string¦null | false | none | none | |
| country | string¦null | false | none | none |
| unitNo | string¦null | false | none | none |
| addressLine1 | string¦null | false | none | none |
| addressLine2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postalCode | string¦null | false | none | none |
| latitude | string¦null | false | none | none |
| longitude | string¦null | false | none | none |
| nationalId | string¦null | false | none | none |
| nationalIdSecondary | string¦null | false | none | none |
| nationalIdType | string¦null | false | none | none |
| nationalIdSecondaryType | string¦null | false | none | none |
| verificationSourceResults | [IDVResultVerificationSourceRa]¦null | false | none | none |
| nameResult | string¦null | false | none | none |
| birthDateResult | string¦null | false | none | none |
| addressResult | string¦null | false | none | none |
| quickIdOverallResult | string¦null | false | none | none |
| overallResult | string¦null | false | none | none |
| faceMatchResult | IDVFaceMatchResultRa¦null | false | none | none |
| quickIDCompletedAt | string(date-time)¦null | false | none | none |
| idvVerificationResult | IDVVerificationResult¦null | false | none | none |
| faceMatchVerificationResult | FaceMatchVerificationResult¦null | false | none | result.faceMatchVerificationResult from the IDV microservice /verificationresult API.Aligns with OpenAPI FaceMatchVerificationResult; nested types reuse existing Regula DTOs. |
IDVResultVerificationOCRDataRa
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"expiryDate": "string",
"birthDate": "string",
"issueDate": "string",
"issuingAuthority": "string",
"unitNo": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryName": "string",
"countryCode": "string",
"nationalId": "string",
"nationalIdSecondary": "string",
"nationalIdTertiary": "string",
"nationalIdCountryCode": "string",
"nationalIdType": "string",
"nationalIdSecondaryType": "string",
"nationalIdTertiaryType": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| fullName | string¦null | false | none | none |
| expiryDate | string¦null | false | none | none |
| birthDate | string¦null | false | none | none |
| issueDate | string¦null | false | none | none |
| issuingAuthority | string¦null | false | none | none |
| unitNo | string¦null | false | none | none |
| addressLine1 | string¦null | false | none | none |
| addressLine2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postalCode | string¦null | false | none | none |
| countryName | string¦null | false | none | none |
| countryCode | string¦null | false | none | none |
| nationalId | string¦null | false | none | none |
| nationalIdSecondary | string¦null | false | none | none |
| nationalIdTertiary | string¦null | false | none | none |
| nationalIdCountryCode | string¦null | false | none | none |
| nationalIdType | string¦null | false | none | none |
| nationalIdSecondaryType | string¦null | false | none | none |
| nationalIdTertiaryType | string¦null | false | none | none |
IDVResultVerificationSourceRa
{
"source": "string",
"nameResult": "string",
"birthDateResult": "string",
"addressResult": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string¦null | false | none | none |
| nameResult | string¦null | false | none | none |
| birthDateResult | string¦null | false | none | none |
| addressResult | string¦null | false | none | none |
IDVScanInputParam
{
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "AuGovtVerification",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "string",
"parentOrigin": "string"
}
ID Verification scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mobileNumber | string¦null | false | none | Person's mobile number to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| emailAddress | string¦null | false | Length: 0 - 128 Pattern: ^([a-zA... |
Person's email address to receive the verification link to complete the documentation verification, biometric face matching, or both. |
| country | IDVCountry0¦null | false | none | Country of source for document and biometric facial-matching verification. Refer to IDVCountry0.code for details of supported country codes. |
| idvType | string¦null | true | none | Type of verification for the person i.e. IDCheck for documentation verification, FaceMatch for biometric facial-matching, or both. |
| idvSubType | string¦null | false | none | Specify the execution or delivery method of the idvType i.e. email or SMS. If this is not defined, the default SMS option will be used. Ensure you enter the mobileNumber or emailAddress depending on the idvSubType. Please only select from the following values IDCheck_Sms, IDCheck_Email, IDCheck_FaceMatch_Sms, IDCheck_FaceMatch_Email, FaceMatch_Sms, FaceMatch_Email. |
| allowDuplicateIDVScan | boolean | false | none | Allow any detected duplicate scans with the same details such as name, date of birth and country of verification which was run within the last 24 hours to proceed. |
| verificationProcess | string¦null | false | none | Specifies the verification process type or flow being executed. |
| consent | boolean | false | none | Indicates whether consent has been obtained from the document holder to verify their identifying information. |
| idvDataSource | string¦null | false | none | Contains the type of source for the id check verification request. |
| idvAssuranceLevel | string¦null | false | none | Contains the assurance level for the id check verification request. |
| subscriberCode | string¦null | false | none | Contains the subscriber code for the id check process. |
| parentOrigin | string¦null | false | none | Contains the origin of the parent window that initiated the ID verification request. |
Enumerated Values
| Property | Value |
|---|---|
| idvType | IDCheck |
| idvType | IDCheck_FaceMatch |
| idvType | FaceMatch |
| idvSubType | IDCheck_Sms |
| idvSubType | IDCheck_Email |
| idvSubType | IDCheck_FaceMatch_Sms |
| idvSubType | IDCheck_FaceMatch_Email |
| idvSubType | FaceMatch_Sms |
| idvSubType | FaceMatch_Email |
| verificationProcess | StepByStep |
| verificationProcess | Comprehensive |
| idvDataSource | AuGovtVerification |
| idvDataSource | AuGovtRecords |
| idvDataSource | Commercial |
| idvAssuranceLevel | SingleSource |
| idvAssuranceLevel | CrossSource |
IDVVerificationResult
{
"driverLicenceResult": {
"requestParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"passportResult": {
"requestParam": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"medicareResult": {
"requestParam": {
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
},
"nationalIDResult": [
{
"transactionId": "string",
"reliability": "NotVerified",
"reliabilityCode": "string",
"errorMessage": "string",
"message": "string",
"nationalIdType": "string",
"country": "string",
"verificationResult": [
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "NotVerified",
"dataSource": "string",
"message": "string"
}
]
}
]
}
],
"idCheckCompletionTime": "2019-08-24T14:15:22Z",
"idVerificationSources": [
{
"code": "string",
"dataSource": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| driverLicenceResult | DLResult¦null | false | none | none |
| passportResult | PPResult¦null | false | none | none |
| medicareResult | MCResult¦null | false | none | none |
| nationalIDResult | [NationalIDResult]¦null | false | none | none |
| idCheckCompletionTime | string(date-time)¦null | false | none | none |
| idVerificationSources | [DataSourceIndicator]¦null | false | none | [Represents a single datasource indicator for a country verification.] |
IdCheckDriverLicence
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| dateOfBirth | string¦null | false | none | none |
IdCheckMedicare
{
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameLine1 | string¦null | false | none | none |
| nameLine2 | string¦null | false | none | none |
| nameLine3 | string¦null | false | none | none |
| nameLine4 | string¦null | false | none | none |
| dateOfBirth | string¦null | false | none | none |
IdCheckPassport
{
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| dateOfBirth | string¦null | false | none | none |
Identifier
{
"type": "string",
"country": "string",
"value": "string",
"issuer": "string",
"issueDate": "string",
"expirationDate": "string"
}
Identification or registration numbers from national and international authorities.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Type of identity including registration number, registration date and status e.g. Business Registration Number, Business Registration Date, Business Registration Status, OFAC Unique ID, SIC Number, DUNS number, Corporate Identification Number, VAT/Tax Number etc. |
| country | string¦null | false | none | Country where identity was issued, if available. Note: Only LexisNexis |
| value | string¦null | false | none | Value of the associated identity. |
| issuer | string¦null | false | none | The agency that issued the identity, if available. Note: New in v9.6; Only LexisNexis |
| issueDate | string¦null | false | none | The date that the identity was issued, if available. Note: New in v9.6; Only LexisNexis |
| expirationDate | string¦null | false | none | The date that the identity expires, if available. Note: New in v9.6; Only LexisNexis |
ImageDetails
{
"format": "string",
"image": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| format | string¦null | false | none | none |
| image | string¦null | false | none | none |
ImageQualityCheckListDetails
{
"count": 0,
"list": [
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
],
"result": "ERROR",
"pageIdx": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | false | none | none |
| list | [ImageQualityCheckListItem]¦null | false | none | none |
| result | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| pageIdx | integer(int32) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| result | ERROR |
| result | OK |
| result | WAS_NOT_DONE |
ImageQualityCheckListItem
{
"type": "ImageGlares",
"featureType": "BLANK",
"result": "ERROR",
"mean": 0,
"probability": 0,
"stddev": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Represents image quality and content checks performed on a document image. - ImageGlares: Signals glare presence on the image. - ImageFocus: Signals whether the image is in focus. - ImageResolution: Signals if image resolution is below threshold. - ImageColorness: Signals if image is colorless. - Perspective: Signals if document has perspective distortion above threshold. - Bounds: Signals if document is not fully present in the image. - Portrait: Signals if a portrait is present. - Handwritten: Signals if the document contains handwritten text in scanned fields. - Brightness: Signals if the document image is bright enough. - Occlusion: Signals if the document image has occlusion. |
| featureType | string¦null | false | none | none |
| result | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| mean | number(double) | false | none | none |
| probability | integer(int32) | false | none | none |
| stddev | number(double) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | ImageGlares |
| type | ImageFocus |
| type | ImageResolution |
| type | ImageColorness |
| type | Perspective |
| type | Bounds |
| type | Portrait |
| type | Handwritten |
| type | Brightness |
| type | Occlusion |
| featureType | BLANK |
| featureType | FILL |
| featureType | PHOTO |
| featureType | MRZ |
| featureType | FALSE_LUMINESCENCE |
| featureType | HOLO_SIMPLE |
| featureType | HOLO_VERIFY_STATIC |
| featureType | HOLO_VERIFY_MULTI_STATIC |
| featureType | HOLO_VERIFY_DYNAMIC |
| featureType | PATTERN_NOT_INTERRUPTED |
| featureType | PATTERN_NOT_SHIFTED |
| featureType | PATTERN_SAME_COLORS |
| featureType | PATTERN_IR_INVISIBLE |
| featureType | PHOTO_SIZE_CHECK |
| featureType | PORTRAIT_COMPARISON_VS_GHOST |
| featureType | PORTRAIT_COMPARISON_VS_RFID |
| featureType | PORTRAIT_COMPARISON_VS_VISUAL |
| featureType | BARCODE |
| featureType | PATTERN_DIFFERENT_LINES_THICKNESS |
| featureType | PORTRAIT_COMPARISON_VS_CAMERAMAIN |
| featureType | PORTRAIT_COMPARISON_RFID_VS_CAMERA |
| featureType | GHOST_PHOTO |
| featureType | CLEAR_GHOST_PHOTO |
| featureType | INVISIBLE_OBJECT |
| featureType | LOW_CONTRAST_OBJECT |
| featureType | PHOTO_COLOR |
| featureType | PHOTO_SHAPE |
| featureType | PHOTO_CORNERS |
| featureType | OCR |
| featureType | PORTRAIT_COMPARISON_EXT_VS_VISUAL |
| featureType | PORTRAIT_COMPARISON_EXT_VS_RFID |
| featureType | PORTRAIT_COMPARISON_EXT_VS_CAMERA |
| featureType | LIVENESS_DEPTH |
| featureType | MICRO_TEXT |
| featureType | FLUORESCENT_OBJECT |
| featureType | LANDMARK_CHECK |
| featureType | FACE_PRESENCE |
| featureType | FACE_ABSENCE |
| featureType | LIVENESS_SCREEN_CAPTURE |
| featureType | LIVENESS_ELECTRONIC_DEVICE |
| featureType | LIVENESS_OVI |
| featureType | BARCODE_SIZE_CHECK |
| featureType | LASINK |
| featureType | LIVENESS_MLI |
| featureType | LIVENESS_BARCODE_BACKGROUND |
| featureType | PORTRAIT_COMPARISON_VS_BARCODE |
| featureType | PORTRAIT_COMPARISON_RFID_VS_BARCODE |
| featureType | PORTRAIT_COMPARISON_EXT_VS_BARCODE |
| featureType | PORTRAIT_COMPARISON_BARCODE_VS_CAMERA |
| featureType | CHECK_DIGITAL_SIGNATURE |
| featureType | CONTACT_CHIP_CLASSIFICATION |
| featureType | HEAD_POSITION_CHECK |
| featureType | LIVENESS_BLACK_AND_WHITE_COPY_CHECK |
| featureType | LIVENESS_DYNAPRINT |
| featureType | LIVENESS_GEOMETRY_CHECK |
| featureType | AGE_CHECK |
| featureType | SEX_CHECK |
| result | ERROR |
| result | OK |
| result | WAS_NOT_DONE |
ImagesDetails
{
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"fieldList": [
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": "string",
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"lightIndex": "OFF",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalPageIndex": 0,
"pageIndex": 0
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| availableSourceList | [AvailableSourceItem]¦null | false | none | none |
| fieldList | [ImagesFieldItem]¦null | false | none | none |
ImagesFieldItem
{
"fieldName": "string",
"fieldType": "PORTRAIT",
"valueList": [
{
"value": "string",
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"lightIndex": "OFF",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalPageIndex": 0,
"pageIndex": 0
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldName | string¦null | false | none | none |
| fieldType | string¦null | false | none | Represents the type of image or biometric data extracted from a document. - PORTRAIT: Document holder photo. - FINGERPRINT: Fingerprint of document holder. - EYE: Image of the iris of document holder. - SIGNATURE: Signature of document holder. - BAR_CODE: Barcode image. - PROOF_OF_CITIZENSHIP: Image of document confirming owner citizenship. - DOCUMENT_FRONT: Cropped and perspective-corrected front side of a document. - DOCUMENT_REAR: Image of the rear side of the document. - COLOR_DYNAMIC: Area with dynamic color change. - GHOST_PORTRAIT: Additional portrait. - STAMP: Stamp. - PORTRAIT_OF_CHILD: Portrait of child. - CONTACT_CHIP: Contact chip. - OTHER: Undefined image type. - FINGER_LEFT_THUMB: Fingerprint (thumb, left hand). - FINGER_LEFT_INDEX: Fingerprint (index, left hand). - FINGER_LEFT_MIDDLE: Fingerprint (middle, left hand). - FINGER_LEFT_RING: Fingerprint (ring, left hand). - FINGER_LEFT_LITTLE: Fingerprint (little, left hand). - FINGER_RIGHT_THUMB: Fingerprint (thumb, right hand). - FINGER_RIGHT_INDEX: Fingerprint (index, right hand). - FINGER_RIGHT_MIDDLE: Fingerprint (middle, right hand). - FINGER_RIGHT_RING: Fingerprint (ring, right hand). - FINGER_RIGHT_LITTLE: Fingerprint (little, right hand). - FINGER_RIGHT_FOUR_FINGERS: Fingerprint (four fingers without thumb, right hand). - FINGER_LEFT_FOUR_FINGERS: Fingerprint (four fingers without thumb, left hand). - FINGER_TWO_THUMBS: Fingerprint (two thumbs). |
| valueList | [ImagesValueListItem]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| fieldType | PORTRAIT |
| fieldType | FINGERPRINT |
| fieldType | EYE |
| fieldType | SIGNATURE |
| fieldType | BAR_CODE |
| fieldType | PROOF_OF_CITIZENSHIP |
| fieldType | DOCUMENT_FRONT |
| fieldType | DOCUMENT_REAR |
| fieldType | COLOR_DYNAMIC |
| fieldType | GHOST_PORTRAIT |
| fieldType | STAMP |
| fieldType | PORTRAIT_OF_CHILD |
| fieldType | CONTACT_CHIP |
| fieldType | OTHER |
| fieldType | FINGER_LEFT_THUMB |
| fieldType | FINGER_LEFT_INDEX |
| fieldType | FINGER_LEFT_MIDDLE |
| fieldType | FINGER_LEFT_RING |
| fieldType | FINGER_LEFT_LITTLE |
| fieldType | FINGER_RIGHT_THUMB |
| fieldType | FINGER_RIGHT_INDEX |
| fieldType | FINGER_RIGHT_MIDDLE |
| fieldType | FINGER_RIGHT_RING |
| fieldType | FINGER_RIGHT_LITTLE |
| fieldType | FINGER_RIGHT_FOUR_FINGERS |
| fieldType | FINGER_LEFT_FOUR_FINGERS |
| fieldType | FINGER_TWO_THUMBS |
ImagesValueListItem
{
"value": "string",
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"lightIndex": "OFF",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalPageIndex": 0,
"pageIndex": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| containerType | string¦null | false | none | Specifies the type of result container returned in the response. Each type corresponds to a specific data extraction or verification step. - DOCUMENT_IMAGE: Cropped/rotated document image with perspective compensation (ID: 1). - MRZ_TEXT: MRZ OCR results (ID: 3). - BARCODES: Raw information about barcodes (ID: 5). - VISUAL_GRAPHICS: Graphic fields from the Visual zone like signatures/photos (ID: 6). - MRZ_TEST_QUALITY: Result of the MRZ quality assessment (ID: 7). - DOCUMENT_TYPE_CANDIDATES: Potential document matches with probabilities (ID: 8). - DOCUMENT_TYPE: The finalized determined document type (ID: 9). - LEXICAL_ANALYSIS: Cross-source comparison (legacy; use TEXT) (ID: 15). - RAW_UNCROPPED_IMAGE: The original unedited input images (ID: 16). - VISUAL_TEXT: Data extracted from the visual zone (ID: 17). - BARCODE_TEXT: Text-based results from parsed barcodes (ID: 18). - BARCODE_GRAPHICS: Visual results from parsed barcodes (ID: 19). - AUTHENTICITY: Results of security and authenticity checks (ID: 20). - MAGNETIC_STRIPE_TEXT_DATA: Data from the magnetic stripe (ID: 26). - IMAGE_QUALITY: Detailed quality check of the input images (ID: 30). - LIVE_PORTRAIT: Data regarding the live portrait/selfie (ID: 32). - STATUS: Consolidated check statuses by source (ID: 33). - PORTRAIT_COMPARISON: Match results between document and live portraits (ID: 34). - EXT_PORTRAIT: Extended portrait/graphics info (ID: 35). - TEXT: Unified text fields with cross-source validation (ID: 36). - IMAGES: Unified image container for all sources (ID: 37). - FINGERPRINTS: Fingerprint data container (ID: 38). - FINGERPRINT_COMPARISON: Match results for fingerprints (ID: 39). - ENCRYPTED_RCL: Encrypted result data (ID: 49). - LICENSE: Current license status (ID: 50). - MRZ_POSITION: Coordinates for the MRZ area (ID: 61). - BARCODE_POSITION: Coordinates for the barcode area (ID: 62). - DOCUMENT_POSITION: Global coordinates, center, and angle of the document (ID: 85). - MRZ_DETECTOR: Low-level MRZ detection results (ID: 87). - FACE_DETECTION: Location and properties of faces in the image (ID: 97). - RFID_RAW_DATA: Unprocessed RFID chip data (ID: 101). - RFID_TEXT: Text extracted from the RFID chip (ID: 102). - RFID_GRAPHICS: Graphics extracted from the RFID chip (ID: 103). - RFID_BINARY_DATA: Binary files from the RFID chip (ID: 104). - RFID_ORIGINAL_GRAPHICS: Original uncompressed RFID graphics (ID: 105). - DTC_VC: Digital Travel Credential data (ID: 109). - MDL_PARSED_RESPONSE: Parsed mobile Driver's License response (ID: 121). - VDS_NC: Result of Visible Digital Seal for Non-Electronic Documents (ID: 124). - VDS: Result of Visible Digital Seal (ID: 125). |
| source | string¦null | false | none | none |
| lightIndex | string¦null | false | none | Represents illumination types used during document image capture. - OFF: No light. - WHITE_TOP: Upper/lower white light. - WHITE_SIDE: Side white light. - WHITE: White light. - IR: Infrared light. - UV: Ultraviolet light. - AXIAL_WHITE: Axial white light. |
| fieldRect | FieldRect¦null | false | none | none |
| originalPageIndex | integer(int32) | false | none | none |
| pageIndex | integer(int32) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| containerType | DOCUMENT_IMAGE |
| containerType | MRZ_TEXT |
| containerType | BARCODES |
| containerType | VISUAL_GRAPHICS |
| containerType | MRZ_TEST_QUALITY |
| containerType | DOCUMENT_TYPE_CANDIDATES |
| containerType | DOCUMENT_TYPE |
| containerType | LEXICAL_ANALYSIS |
| containerType | RAW_UNCROPPED_IMAGE |
| containerType | VISUAL_TEXT |
| containerType | BARCODE_TEXT |
| containerType | BARCODE_GRAPHICS |
| containerType | AUTHENTICITY |
| containerType | MAGNETIC_STRIPE_TEXT_DATA |
| containerType | IMAGE_QUALITY |
| containerType | LIVE_PORTRAIT |
| containerType | STATUS |
| containerType | PORTRAIT_COMPARISON |
| containerType | EXT_PORTRAIT |
| containerType | TEXT |
| containerType | IMAGES |
| containerType | FINGERPRINTS |
| containerType | FINGERPRINT_COMPARISON |
| containerType | ENCRYPTED_RCL |
| containerType | LICENSE |
| containerType | MRZ_POSITION |
| containerType | BARCODE_POSITION |
| containerType | DOCUMENT_POSITION |
| containerType | MRZ_DETECTOR |
| containerType | FACE_DETECTION |
| containerType | RFID_RAW_DATA |
| containerType | RFID_TEXT |
| containerType | RFID_GRAPHICS |
| containerType | RFID_BINARY_DATA |
| containerType | RFID_ORIGINAL_GRAPHICS |
| containerType | DTC_VC |
| containerType | MDL_PARSED_RESPONSE |
| containerType | VDS_NC |
| containerType | VDS |
| lightIndex | OFF |
| lightIndex | WHITE_TOP |
| lightIndex | WHITE_SIDE |
| lightIndex | WHITE |
| lightIndex | IR |
| lightIndex | UV |
| lightIndex | AXIAL_WHITE |
KYBActivity
{
"description": "string"
}
Represents the activity of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | none | Description of the activity. |
KYBAddresses
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
Represents the address of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | The country of the company address. |
| type | string¦null | false | none | Type of the company address. |
| addressInOneLine | string¦null | false | none | Full address of the company. |
| postCode | string¦null | false | none | PostCode of the company address. |
| cityTown | string¦null | false | none | Provides the city name. |
KYBCompanyInputParam
{
"countryCode": "AU",
"companyName": "Example Corporation Pty Ltd",
"registrationNumber": "",
"clientId": "CLIENT-001",
"allowDuplicateKYBScan": false,
"includeRiskAssessment": "No"
}
KYB company search input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryCode | string | true | Length: 2 - 6 | The country code or subdivision code if the country has state registries. |
| companyName | string¦null | false | Length: 0 - 255 | The company name you want to search. |
| registrationNumber | string¦null | false | Length: 0 - 100 | The business registration number, if supported by the registry. If both companyName and registrationNumber are provided, the companyName will be used for searching. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the entity. This is not used in KYB scanning. |
| allowDuplicateKYBScan | boolean | false | none | Allow any detected duplicate scans with the same details such as country, company name or company registration number which was run within the last 24 hours to proceed. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
Enumerated Values
| Property | Value |
|---|---|
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
KYBCompanyProfileInputParam
{
"companyCode": "string"
}
KYB company enhanced profile input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | Length: 1 - undefined | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBCompanyScanHistory
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "user@example.com",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
Details of company information and enahnced profile and list of documents.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| completedProductCount | integer(int32) | false | none | Provides count of the completed products of the company. |
| totalProductCount | integer(int32) | false | none | Provides count of all requested products of the company. |
| productResults | [KYBProductHistoryResult]¦null | false | none | List of the company products. |
| companyProfile | KYBEnhancedProfileResult¦null | false | none | Provides details of the company-enhanced profile including UBO, shareholder and directorship information. |
| companyCode | string¦null | false | none | A unique code for that entity that will be used for ordering a company profile or retrieving product documents. |
| companyNumber | string¦null | false | none | The registration number of the company. |
| date | string¦null | false | none | The date of the company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| legalStatusDescription | string¦null | false | none | Additional information on the legal status of the company. |
| address | string¦null | false | none | The address of the company. |
KYBCountryResult
{
"code": "string",
"name": "string",
"hasStates": true,
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true,
"serviceAvailable": true
}
KYB Country information elements.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The ISO 3166 2-letter country code. |
| name | string¦null | false | none | Name of the country. |
| hasStates | boolean | false | none | Indicates whether the country has registry subdivisions such as states or provinces. |
| supportsRegistrationNumber | boolean | false | none | Denotes whether the country registry supports searching by business registration number. |
| companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the country. |
| productAvailable | boolean | false | none | Indicates whether the document products are available in the country. |
| serviceAvailable | boolean | false | none | Indicates whether the document products or enhanced profile service are available for the country. |
KYBEnhancedProfileCreditChargeResult
{
"enhancedProfilePrice": 0,
"basicInformation": true,
"representatives": true,
"shareholders": true,
"uboDeclaration": true
}
Represents the credit charge result data of company enhanced profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enhancedProfilePrice | number(double) | false | none | Provides the price of the enhanced profile. |
| basicInformation | boolean | false | none | Indicates if basic information of the company is available. |
| representatives | boolean | false | none | Indicates if representatives of the company are available. |
| shareholders | boolean | false | none | Indicates if shareholders of the company are available. |
| uboDeclaration | boolean | false | none | Indicates if UBO declarations of the company are available. |
KYBEnhancedProfileResult
{
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "user@example.com",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
}
Represents the result data of the company enhanced profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| activity | [KYBActivity]¦null | false | none | List of activities of the company. |
| addresses | [KYBAddresses]¦null | false | none | List of addresses of the company. |
| directorShips | [DirectorShip]¦null | false | none | List of directorShips of the company. |
| code | string¦null | false | none | Code of the company. |
| date | string¦null | false | none | Date of the company. |
| foundationDate | string¦null | false | none | Foundation date of the company. |
| legalForm | string¦null | false | none | Provides legal form of the company. |
| legalStatus | string¦null | false | none | Identifies the legal status of the company. |
| name | string¦null | false | none | This provides full name of the company. |
| mailingAddress | string¦null | false | none | This provides mailing address of the company. |
| telephoneNumber | string¦null | false | none | Telephone number of the company. |
| faxNumber | string¦null | false | none | Fax number of the company. |
| string¦null | false | none | Email of the company. | |
| websiteURL | string¦null | false | none | Website URL of the company. |
| registrationNumber | string¦null | false | none | Registration number of company. |
| registrationAuthority | string¦null | false | none | Registration authority of the company. |
| legalFormDetails | string¦null | false | none | Provides legal form details of the company. |
| legalFormDeclaration | string¦null | false | none | Provides legal form declaration of the company. |
| registrationDate | string¦null | false | none | Registration date of the company. |
| vatNumber | string¦null | false | none | VAT number of the company. |
| agentName | string¦null | false | none | Provides the agent name of the company. |
| agentAddress | string¦null | false | none | Provides the address of the agent. |
| enhancedProfilePrice | number(double) | false | none | Provides the price of the company enhanced profile. |
| personsOfSignificantControl | [KYBPersonsOfSignificantControl]¦null | false | none | Lists the person having control over a company. |
KYBInputInfo
{
"country": "string",
"state": "string"
}
Details of the Know Your Business input fields.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | Provides name of the Country provided at the time of scan. |
| state | string¦null | false | none | Provides name of the State provided at the time of scan. |
KYBInputParam
{
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
}
KYB input scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countryCode | string¦null | false | Length: 0 - 6 | The country code or subdivision code if the country has state registries. |
| registrationNumberSearch | boolean | false | none | The business registration number, if supported by the registry. If both companyName and registrationNumber are provided, the companyName will be used for searching. |
| allowDuplicateKYBScan | boolean | false | none | Allow any detected duplicate scans with the same details such as country, company name or company registration number which was run within the last 24 hours to proceed. |
KYBPersonsOfSignificantControl
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
Represents the details of the significant control persons/UBO of the company.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| natureOfControl | [string]¦null | false | none | Provides details of ownership shares, voting rights and right to appoint the person. |
| name | string¦null | false | none | Provides name of the person. |
| nationality | string¦null | false | none | Provides the nationality of the person. |
| countryOfResidence | string¦null | false | none | The residence country of the person. |
| address | string¦null | false | none | The address of the person. |
| notifiedOn | string¦null | false | none | The notified date of the person. |
| birthDate | string¦null | false | read-only | The birth date of the person. |
KYBPricingParam
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes",
"pageIndex": 0,
"pageSize": 20
}
KYB pricing parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | Length: 1 - undefined | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| productStatus | string¦null | false | none | Indicates document product order status. It may contains Requested, Pending, Completed, Failed and Cancelled statuses. |
| includeEnhancedProfile | string¦null | false | none | Indicates enhanced profile includes or not. |
| pageIndex | integer(int32) | false | none | The page index of results. |
| pageSize | integer(int32) | false | none | The number of items or results per page or request. |
Enumerated Values
| Property | Value |
|---|---|
| productStatus | Requested |
| productStatus | Pending |
| productStatus | Completed |
| productStatus | Failed |
| productStatus | Cancelled |
| productStatus | All |
| includeEnhancedProfile | No |
| includeEnhancedProfile | Yes |
KYBPricingReportParam
{
"fundIDs": "",
"from": "01/01/2025",
"to": "31/12/2025",
"productStatus": "All",
"includeEnhancedProfile": "Yes"
}
KYB pricing report parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fundIDs | string | true | Length: 1 - undefined | FundID of the selected organisations. It could be a single value or comma-separated values. |
| from | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date from (DD/MM/YYYY). |
| to | string | true | Length: 0 - 10 Pattern: ^((0?[1... |
Scan date to (DD/MM/YYYY). |
| productStatus | string¦null | false | none | Indicates document product order status. It may contains Requested, Pending, Completed, Failed and Cancelled statuses. |
| includeEnhancedProfile | string¦null | false | none | Indicates enhanced profile includes or not. |
Enumerated Values
| Property | Value |
|---|---|
| productStatus | Requested |
| productStatus | Pending |
| productStatus | Completed |
| productStatus | Failed |
| productStatus | Cancelled |
| productStatus | All |
| includeEnhancedProfile | No |
| includeEnhancedProfile | Yes |
KYBPricingReportResult
{
"scanDate": "string",
"orgNameWithFundID": "string",
"countryCode": "string",
"companyName": "string",
"productTitle": "string",
"orderId": "string",
"creditCharge": 0,
"creditCostPrice": "string",
"price": "string",
"requestedDate": "string",
"downloadedDate": "string",
"status": "string",
"enhancedProfileRequested": true
}
Represents details of the KYB pricing report.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanDate | string¦null | false | none | Provides the scan date. |
| orgNameWithFundID | string¦null | false | none | Provides the organisation name and org id. |
| countryCode | string¦null | false | none | Provides the code of the country. |
| companyName | string¦null | false | none | Provides the full name of the company. |
| productTitle | string¦null | false | none | The title of the document product. |
| orderId | string¦null | false | none | The order reference of the document product. |
| creditCharge | number(double) | false | none | Provides the credit charge of the document or enhanced profile. |
| creditCostPrice | string¦null | false | none | Provides the credit cost price of the document or enhanced profile. |
| price | string¦null | false | none | Provides the price of the document or enhanced profile. |
| requestedDate | string¦null | false | none | Provides the requested date of the document or enhanced profile. |
| downloadedDate | string¦null | false | none | Provides the downloaded date of the document or enhanced profile. |
| status | string¦null | false | none | Provides the status of the document product. |
| enhancedProfileRequested | boolean | false | none | Identifies enhanced profile is requested or not. |
KYBProductHistoryResult
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
Represents details of product information.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productId | integer(int32) | false | none | The identifier of a specific product. The kyb/{scanId}/products/order API method response class returns this identifier in productId. |
| companyNumber | string¦null | false | none | Provides the registration number of company. |
| companyName | string¦null | false | none | This provides the full name of the company. |
| creationDate | string(date-time) | false | none | Identifies the creation date of the product. |
| status | string¦null | false | none | Identifies the status of the product. |
| completionDate | string(date-time)¦null | false | none | The completion date of the product. |
| productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| currency | string¦null | false | none | The currency of the document product. |
| productFormat | string¦null | false | none | The format of the document product. |
| productTitle | string¦null | false | none | The title of the document product. |
| deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| productInfo | string¦null | false | none | Provides the document product information. |
| price | number(double) | false | none | The price of the document product. |
| isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
KYBProductInputParam
{
"companyCode": "string"
}
KYB product search input parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | Length: 0 - 1024 | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBProductOrderInputParam
{
"companyCode": "string",
"productEntityId": "string"
}
Specify document products for purchase.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyCode | string | true | Length: 0 - 1024 | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
| productEntityId | string | true | Length: 0 - 1024 | The unique product key used to order a document product. The POST /kyb/{scanId}/products API method response class returns this identifier in productResults.productEntityId. |
KYBProductOrderResult
{
"companyId": 0,
"productId": 0,
"message": "string",
"status": "Requested"
}
Results of the document product order.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyId | integer(int32) | false | none | The identifier of a specific company. The POST /kyb/{scanId}/products/order or POST /kyb/{scanId}/company/profile API method response class returns this identifier in companyId. |
| productId | integer(int32) | false | none | The identifier of the specific document product. The kyb/{scanId}/products/order API method response class returns this identifier in productid. |
| message | string¦null | false | none | Acknowledgement of the document order. This may indicate successful receipt of the request or cancellation or failure in the order due to registry and document availability. |
| status | string¦null | false | none | Indicates document product order status. It contains Requested, Pending, Completed, Failed and Cancelled statuses. |
Enumerated Values
| Property | Value |
|---|---|
| status | Requested |
| status | Pending |
| status | Completed |
| status | Failed |
| status | Cancelled |
KYBProductResult
{
"productResults": [
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyCode": "string"
}
Lists the document products available for the company profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productResults | [ProductResult]¦null | false | none | Lists the document products available for the company profile. |
| companyCode | string¦null | false | none | The unique code identifier of a specific company. The POST /kyb/company API method response class returns this identifier in companyResults.companyCode. |
KYBScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountry": "string",
"watchLists": [
"string"
],
"watchlistsNote": "string",
"kybCountryCode": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"addressPolicy": "Ignore",
"blankAddress": "ApplyDefaultCountry",
"companyName": "string",
"registrationNumber": "string",
"entityNumber": "string",
"clientId": "string",
"address": "string",
"country": [
"AU",
"NZ",
"DE",
"ID",
"OM"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"includeJurisdictionRisk": "No",
"kybParam": {
"countryCode": "string",
"registrationNumberSearch": true,
"allowDuplicateKYBScan": true
},
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "RegistrationNumber"
},
"companyResults": [
{
"companyId": 0,
"completedProductCount": 0,
"totalProductCount": 0,
"productResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"companyProfile": {
"companyId": 0,
"activity": [
{
"description": "string"
}
],
"addresses": [
{
"country": "string",
"type": "string",
"addressInOneLine": "string",
"postCode": "string",
"cityTown": "string"
}
],
"directorShips": [
{
"id": "string",
"parentId": "string",
"role": "string",
"name": "string",
"type": "string",
"holdings": "string",
"address": "string",
"appointDate": "string"
}
],
"code": "string",
"date": "string",
"foundationDate": "string",
"legalForm": "string",
"legalStatus": "string",
"name": "string",
"mailingAddress": "string",
"telephoneNumber": "string",
"faxNumber": "string",
"email": "user@example.com",
"websiteURL": "string",
"registrationNumber": "string",
"registrationAuthority": "string",
"legalFormDetails": "string",
"legalFormDeclaration": "string",
"registrationDate": "string",
"vatNumber": "string",
"agentName": "string",
"agentAddress": "string",
"enhancedProfilePrice": 0,
"personsOfSignificantControl": [
{
"natureOfControl": [
"string"
],
"name": "string",
"nationality": "string",
"countryOfResidence": "string",
"address": "string",
"notifiedOn": "string",
"birthDate": "string"
}
]
},
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
],
"documentResults": [
{
"productId": 0,
"companyNumber": "string",
"companyName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"status": "Requested",
"completionDate": "2019-08-24T14:15:22Z",
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
],
"kybParam": {
"country": "string",
"state": "string"
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
Details of the scan settings applied and a list of companies where documents or UBO enhanced-profiles were purchased.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | CorpScanInputParamHistory¦null | false | none | Scan parameters and company information used to scan. |
| companyResults | [KYBCompanyScanHistory]¦null | false | none | List of company results. |
| documentResults | [KYBProductHistoryResult]¦null | false | none | List of product results. |
| kybParam | KYBInputInfo¦null | false | none | Scan parameters and company information used to scan. |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
KYBScanResult
{
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"enhancedProfilePrice": 0,
"companyResults": [
{
"companyCode": "string",
"companyNumber": "string",
"date": "string",
"companyName": "string",
"legalStatus": "string",
"legalStatusDescription": "string",
"address": "string"
}
]
}
Lists of company profiles found for the company search.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The metadata about result. |
| scanId | integer(int32) | false | none | The identifier of the scan. It should be used when requesting the GET /kyb/{scanId} API methods to get details of this company scan. |
| enhancedProfilePrice | number(double) | false | none | Cost of the Enhanced Profile information for the company. Prices are in USD. |
| companyResults | [CompanyResult]¦null | false | none | List of company details. |
KYBStateResult
{
"code": "string",
"name": "string",
"supportsRegistrationNumber": true,
"companyProfileAvailable": true,
"productAvailable": true,
"serviceAvailable": true
}
Lists the KYB state results.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The code for the registry subdivision. This is a combination of the ISO 3166 country and state codes. |
| name | string¦null | false | none | Name of the subdivision (state or province). |
| supportsRegistrationNumber | boolean | false | none | Denotes whether the subdivision registry supports searching by business Registration Number. |
| companyProfileAvailable | boolean | false | none | Indicates whether the company details and UBO information are available in the state. |
| productAvailable | boolean | false | none | Indicates whether the document products are available in the state. |
| serviceAvailable | boolean | false | none | Indicates whether the document products or enhanced profile service are available for the state. |
LinkedProfiles
{
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedIndividualsOld": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
]
}
Returns the Linked Individual profiles with suggested risks.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| linkedIndividuals | [AssociatePerson]¦null | false | none | Represents the Linked Individuals of an entity. |
| linkedIndividualsOld | [AssociatePerson]¦null | false | none | Represents the old Linked Individuals of an entity. This is only available if entity has been Updated in monitoring. |
LivenessDetectionResult
{
"livenessDetectionStatus": 0,
"estimatedAge": 0,
"livenessDetectionTransactionId": "string",
"isLivenessVideoPresent": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| livenessDetectionStatus | integer(int32) | false | none | none |
| estimatedAge | integer(int32) | false | none | none |
| livenessDetectionTransactionId | string¦null | false | none | none |
| isLivenessVideoPresent | boolean | false | none | none |
Location
{
"country": "string",
"countryCode": "string",
"city": "string",
"address": "string",
"type": "string"
}
Represents Country, Region (State/Province), City, and address where information is available.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string¦null | false | none | Location country. |
| countryCode | string¦null | false | none | The ISO 3166-2 country code (alpha-2 code) of the location. |
| city | string¦null | false | none | Location city. |
| address | string¦null | false | none | Location address. |
| type | string¦null | false | none | Location type. |
MCResult
{
"requestParam": {
"nameLine1": "string",
"nameLine2": "string",
"nameLine3": "string",
"nameLine4": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| requestParam | IdCheckMedicare¦null | false | none | none |
| result | DvsResult¦null | false | none | none |
MailConfig
{
"fromEmail": "string",
"supportEmail": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fromEmail | string¦null | false | none | none |
| supportEmail | string¦null | false | none | none |
Metadata
{
"message": "string",
"advancedMediaError": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| message | string¦null | false | none | A message that describe result of operation. |
| advancedMediaError | string¦null | false | none | Advanced Media Search workflow error. |
MonitoringItems
{
"clientIds": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| clientIds | [string] | true | none | none |
MonitoringListCorpItem
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"lastMonitored": "2019-08-24",
"clientId": "string",
"companyName": "string",
"address": "string",
"country": "string",
"registrationNumber": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier for the company assigned by the system within the monitoring list. |
| monitor | boolean | false | none | Status of monitoring for the company i.e. actively monitored (true) or disabled from monitoring (false). |
| addedBy | string¦null | false | none | User who added the company to the monitoring list during a scan. |
| dateAdded | string(date-time) | false | none | Date the company was first added to the monitoring list. |
| lastMonitored | string(date)¦null | false | none | Last monitored date of company in the monitoring list. |
| clientId | string¦null | false | none | The unique Client ID for the company entered during scans. |
| companyName | string¦null | false | none | The name scanned for the company. |
| address | string¦null | false | none | The address scanned for the company. |
| country | string¦null | false | none | The country scanned for the company. |
| registrationNumber | string¦null | false | none | The Registration Number scanned for the company. |
MonitoringListMemberItem
{
"id": 0,
"monitor": true,
"addedBy": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"lastMonitored": "2019-08-24",
"clientId": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"gender": "string",
"address": "string",
"country": "string",
"nationality": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier for the member assigned by the system within the monitoring list. |
| monitor | boolean | false | none | Status of monitoring for the member i.e. actively monitored (true) or disabled from monitoring (false). |
| addedBy | string¦null | false | none | User who added the member to the monitoring list during a scan. |
| dateAdded | string(date-time) | false | none | Date the member was first added to the monitoring list. |
| lastMonitored | string(date)¦null | false | none | Last monitored date of member in the monitoring list. |
| clientId | string¦null | false | none | The unique Client ID entered for the member during scans. |
| firstName | string¦null | false | none | The first name scanned for the member. |
| middleName | string¦null | false | none | The middle name scanned for the member. |
| lastName | string¦null | false | none | The last name scanned for the member. |
| scriptNameFullName | string¦null | false | none | The original script / full name scanned for the member. |
| dob | string¦null | false | none | The date of birth scanned for the member. |
| gender | string¦null | false | none | The gender scanned for the member. |
| address | string¦null | false | none | The address scanned for the member. |
| country | string¦null | false | none | The country scanned for the member. |
| nationality | string¦null | false | none | The nationality scanned for the member. |
MonitoringScanHistoryLog
{
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalMembersMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No"
}
Represents details of the automated member monitoring scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string¦null | false | none | Monitoring Scan or Rescan. |
| totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| 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. |
| matchType | string¦null | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| residence | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
MonitoringScanResults
{
"organisation": "string",
"user": "string",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"categoryResults": [
{
"category": "string",
"matchedMembers": 0,
"numberOfMatches": 0
}
],
"dataSources": "Acuris",
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
],
"monitoringScanId": 0,
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"totalMembersMonitored": 0,
"newMatches": 0,
"updatedEntities": 0,
"removedMatches": 0,
"status": "string",
"reviewStatus": "string",
"membersReviewed": 0,
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No"
}
Represents member batch scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | The Organisation performing the scan. |
| user | string¦null | false | none | The User performing the scan. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| categoryResults | [CategoryResults]¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| dataSources | string¦null | false | none | Scan against selected data sources. This is useful for organisations that may choose to change Data Sources between scans. |
| watchlistsScanned | [string]¦null | false | none | List of the watchlists against which the batch file was scanned. This is useful for organisations that may choose to change List Access between scans. |
| watchlistsNote | string¦null | false | none | none |
| entities | [ScanHistoryLog0]¦null | false | none | List of matched entities. |
| monitoringScanId | integer(int32) | false | none | The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan. |
| date | string(date-time) | false | none | Date the monitoring scan was run. |
| scanType | string¦null | false | none | Monitoring Scan or Rescan. |
| totalMembersMonitored | integer(int32) | false | none | Total number of members being actively monitored in the monitoring list. |
| 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. |
| matchType | string¦null | false | none | Match type scanned. |
| closeMatchRateThreshold | integer(int32)¦null | false | none | Close Match Rate threshold. |
| whitelist | string¦null | false | none | Whitelist policy scanned. |
| residence | string¦null | false | none | Address policy scanned. |
| blankAddress | string¦null | false | none | Blank address policy scanned. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction scanned. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
MyProfile
{
"passwordExpiryDays": 0,
"agreementRequiredOrganisations": [
"string"
],
"acceptedAgreementFileName": "string",
"appLogo": "string",
"appLogoMini": "string",
"userRoles": [
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
],
"userStatuses": [
"Inactive"
],
"rights": [
"string"
],
"notifications": [
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
],
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| passwordExpiryDays | integer(int32)¦null | false | none | none |
| agreementRequiredOrganisations | [string]¦null | false | none | none |
| acceptedAgreementFileName | string¦null | false | none | none |
| appLogo | string¦null | false | none | none |
| appLogoMini | string¦null | false | none | none |
| userRoles | [UserRole]¦null | false | none | none |
| userStatuses | [string]¦null | false | none | none |
| rights | [string]¦null | false | none | none |
| notifications | [UserNotification]¦null | false | none | none |
| apiKey | string¦null | false | none | The API key associated with the user. |
| address | string¦null | false | none | The user's physical address. |
| postalAddress | string¦null | false | none | The user's postal address. |
| phoneNumber | string¦null | false | none | The user's primary phone number (optional). |
| faxNumber | string¦null | false | none | The user's fax number (optional). |
| failedLoginDate | string(date-time)¦null | false | none | The date and time of the last failed login attempt. |
| mfaType | string¦null | false | none | The user's Multi-Factor Authentication type. |
| accessRights | [UserAccessRight]¦null | false | none | A list of access rights granted to the user (up to 50 items). |
| assignedOrganisations | [UserOrganisation]¦null | false | none | A list of organisations assigned to the user (up to 200 items). |
| isSSOEnabled | boolean | false | none | Indicates whether Single Sign-On (SSO) is enabled for the user. |
| userSsoSettings | [UserSsoSettings]¦null | false | none | A list of SSO settings for the user. |
| id | integer(int32) | false | none | The unique identifier for the user account. |
| username | string¦null | false | none | The unique username for the user account. |
| firstName | string¦null | false | none | The user's first name. |
| lastName | string¦null | false | none | The user's last name. |
| role | UserRole¦null | false | none | The role assigned to the user. |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| status | string¦null | false | none | The current status of the user account. |
| creationDate | string(date-time)¦null | false | none | The date and time when the user account was created. |
| lastLoginDate | string(date-time)¦null | false | none | The date and time of the user's last successful login. |
| lastActiveDate | string(date-time)¦null | false | none | The date and time when the user was last active. |
| dateTimeZone | string¦null | false | none | The preferred datetime timezone for the user. |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
MyProfileMfaSetupCode
{
"tokenExpiry": 0,
"manualEntryKey": "string",
"qrCodeSetupImageUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tokenExpiry | integer(int32) | false | none | none |
| manualEntryKey | string¦null | false | none | none |
| qrCodeSetupImageUrl | string¦null | false | none | none |
MyProfileSecurity
{
"currentPassword": "Current@Password123",
"newPassword": "NewSecure@Password123",
"mfaType": "Disabled",
"mfaVerificationCode": ""
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentPassword | string¦null | false | none | none |
| newPassword | string¦null | false | Length: 0 - 100 Pattern: ^(?=.&#... |
none |
| mfaType | string¦null | false | none | none |
| mfaVerificationCode | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
NameDetail
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string"
}
Represents details of the person's name including original script name, spelling variations and aliases.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nameType | string¦null | false | none | Type of name e.g. Original Script Name, Name Spelling Variation, Nickname etc. |
| firstName | string¦null | false | none | First name of the person. |
| middleName | string¦null | false | none | Middle name of the person. |
| lastName | string¦null | false | none | Last name of the person. |
NationalIDResult
{
"transactionId": "string",
"reliability": "NotVerified",
"reliabilityCode": "string",
"errorMessage": "string",
"message": "string",
"nationalIdType": "string",
"country": "string",
"verificationResult": [
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "NotVerified",
"dataSource": "string",
"message": "string"
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| transactionId | string¦null | false | none | none |
| reliability | string¦null | false | none | none |
| reliabilityCode | string¦null | false | none | none |
| errorMessage | string¦null | false | none | none |
| message | string¦null | false | none | none |
| nationalIdType | string¦null | false | none | none |
| country | string¦null | false | none | none |
| verificationResult | [NationalIDResultDetails]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| reliability | NotVerified |
| reliability | Verified |
| reliability | Pass |
| reliability | PartialPass |
| reliability | Fail |
| reliability | Pending |
| reliability | Incomplete |
| reliability | NotRequested |
| reliability | ReviewRequired |
| reliability | InvalidData |
| reliability | TechnicalError |
| reliability | All |
NationalIDResultDetails
{
"field": "string",
"value": "string",
"results": [
{
"matchStatus": "NotVerified",
"dataSource": "string",
"message": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string¦null | false | none | none |
| value | string¦null | false | none | none |
| results | [NationalIDResultSourceDetail]¦null | false | none | none |
NationalIDResultSourceDetail
{
"matchStatus": "NotVerified",
"dataSource": "string",
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchStatus | string¦null | false | none | none |
| dataSource | string¦null | false | none | none |
| message | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchStatus | NotVerified |
| matchStatus | ReviewRequired |
| matchStatus | Verified |
| matchStatus | NotPerformed |
| matchStatus | TechnicalError |
OfficialList
{
"keyword": "string",
"category": "string",
"description": "string",
"country": "string",
"origin": "string",
"measures": "string",
"types": "string",
"isCurrent": true
}
Information of the official list entity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| keyword | string¦null | false | none | Name of the official list. |
| category | string¦null | false | none | Watchlist category of the official list. |
| description | string¦null | false | none | Name of the official list. |
| country | string¦null | false | none | Country of the official list.Note: Decommissioned on 1 July 2020. |
| origin | string¦null | false | none | The country or region of the official list. |
| measures | string¦null | false | none | List of measures enforced by the official sanctioning body, if available. |
| types | string¦null | false | none | Types of sanction classified by the official list, if available. Examples include: Counter Narcotics, Human Rights, Non-Proliferation, Territorial Violation, Terrorism. |
| isCurrent | boolean | false | none | Indicates if the Official List is still current (true) or outdated (false). |
OneCandidateDetails
{
"authenticityNecessaryLights": 0,
"checkAuthenticity": 0,
"documentName": "string",
"fdsidList": {
"count": 0,
"icaoCode": "string",
"list": [
0
],
"dCountryName": "string",
"dFormat": "ID1",
"dmrz": true,
"dType": "NOT_DEFINED",
"dDescription": "string",
"dYear": "string",
"isDeprecated": true,
"dStateCode": "string",
"dStateName": "string"
},
"id": 0,
"necessaryLights": 0,
"oviExp": 0,
"p": 0,
"rfiD_Presence": 0,
"rotated180": true,
"uvExp": 0,
"pageIdx": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| authenticityNecessaryLights | integer(int32) | false | none | none |
| checkAuthenticity | integer(int32) | false | none | none |
| documentName | string¦null | false | none | none |
| fdsidList | FDSIDListDetail¦null | false | none | none |
| id | integer(int32) | false | none | none |
| necessaryLights | integer(int32) | false | none | none |
| oviExp | integer(int32) | false | none | none |
| p | number(double) | false | none | none |
| rfiD_Presence | integer(int32) | false | none | none |
| rotated180 | boolean | false | none | none |
| uvExp | integer(int32) | false | none | none |
| pageIdx | integer(int32) | false | none | none |
OrgAgreementSetting
{
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayAgreement | boolean | false | none | none |
| acceptedBy | string¦null | false | none | none |
| acceptedOn | string¦null | false | none | none |
| fileName | string¦null | false | none | none |
OrgCorporateAutoScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string¦null | false | none | none |
| addressPolicy | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddressPolicy | ApplyDefaultCountry |
| blankAddressPolicy | Ignore |
OrgCorporateScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true,
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"RegistrationNumber": "No"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| stopwords | string¦null | false | Length: 0 - 4000 | none |
| whitelistPolicy | string¦null | false | none | none |
| defaultScanResult | string¦null | false | none | none |
| addressPolicy | string¦null | false | none | none |
| defaultCountry | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
| maxExactScanResult | integer(int32) | false | none | none |
| maxCloseScanResult | integer(int32) | false | none | none |
| watchlists | [string]¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
| webSearch | string¦null | false | none | none |
| advancedMediaSearch | string¦null | false | none | none |
| fatfJurisdictionRisk | string¦null | false | none | none |
| ignoreBlankPolicy | object¦null | false | none | none |
| » RegistrationNumber | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| defaultScanResult | NoMatchesFound |
| defaultScanResult | MatchesFound |
| addressPolicy | Ignore |
| addressPolicy | ApplyAll |
| blankAddressPolicy | ApplyDefaultCountry |
| blankAddressPolicy | Ignore |
| webSearch | No |
| webSearch | Yes |
| advancedMediaSearch | No |
| advancedMediaSearch | Yes |
| fatfJurisdictionRisk | No |
| fatfJurisdictionRisk | Yes |
| RegistrationNumber | No |
| RegistrationNumber | Yes |
| RegistrationNumber | UserDefined |
OrgCountry
{
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| timeZoneId | string¦null | false | none | none |
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
| nationality | string¦null | false | none | none |
OrgCountry0
{
"name": "string",
"code": "strin",
"nationality": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
| nationality | string¦null | false | none | none |
OrgCustomList
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| description | string¦null | false | none | none |
| dataType | string¦null | false | none | none |
| updateType | string¦null | false | none | none |
| status | string¦null | false | none | none |
| selected | boolean | false | none | none |
| inherited | boolean | false | none | none |
| lastUpdate | string(date-time)¦null | false | none | none |
| files | [OrgCustomListFile]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dataType | Individual |
| dataType | Corporate |
| updateType | Full |
| updateType | Incremental |
OrgCustomListFile
{
"id": "string",
"name": "string",
"type": "Individual"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| name | string¦null | false | none | none |
| type | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | Individual |
| type | Corporate |
OrgDetails
{
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"enableEmailNotification": true,
"scanEmailsSendToCO": true,
"emailNotificationAddress": "string",
"webhookNotification": {
"enable": true,
"url": "string",
"service": "None",
"channelName": "string"
},
"emailPreferences": "None",
"logoImage": "string",
"appLogoImage": "string",
"appLogoMiniImage": "string",
"isBatchValidationActive": true,
"subscriptionSettings": {
"startDate": "DD/MM/YYYY",
"renewalDate": "string",
"terminationDate": "DD/MM/YYYY"
},
"agreementSettings": {
"displayAgreement": true,
"acceptedBy": "string",
"acceptedOn": "string",
"fileName": "string"
},
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"DOB": "No",
"Gender": "No",
"IDNumber": "No",
"Nationality": "No"
}
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"stopwords": "string",
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"addressPolicy": "Ignore",
"defaultCountry": "string",
"blankAddressPolicy": "ApplyDefaultCountry",
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"isKybActive": true,
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"RegistrationNumber": "No"
}
},
"monitoringSettings": {
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankNationalityActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
},
"idvSettings": {
"countries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"defaultCountry": {
"name": "string",
"code": "strin",
"nationality": "string"
},
"idVerificationProcess": "StepByStep",
"idvCountriesType": "All",
"subscriberCodes": [
{
"code": "string"
}
],
"idvDataSource": "AuGovtVerification",
"idvCountries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"idvAssuranceLevel": "SingleSource"
},
"assignedUsers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"allowListAccesses": [
0
],
"customLists": [
{
"id": 0,
"name": "string",
"description": "string",
"dataType": "Individual",
"updateType": "Full",
"status": "string",
"selected": true,
"inherited": true,
"lastUpdate": "2019-08-24T14:15:22Z",
"files": [
{
"id": "string",
"name": "string",
"type": "Individual"
}
]
}
],
"riskLevels": [
{
"categoryId": 0,
"risk": 0,
"isCustomList": true
}
],
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"isResellerCO": true,
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "user@example.com",
"creationDate": "2019-08-24T14:15:22Z",
"dataSources": "MemberCheck",
"isDataSourceEditable": true,
"isIdvActive": true,
"isFaceMatchActive": true,
"isIDCheckActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"isWatchlistActive": true,
"isRiskAssessmentActive": true,
"riskAssessmentEnabled": "UserDefined",
"isBatchAMSActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address | string¦null | false | none | none |
| phoneNumber | string¦null | false | none | none |
| faxNumber | string¦null | false | none | none |
| enableEmailNotification | boolean¦null | false | none | none |
| scanEmailsSendToCO | boolean¦null | false | none | none |
| emailNotificationAddress | string¦null | false | none | none |
| webhookNotification | MbrChk.Business.WebhookNotification¦null | false | none | none |
| emailPreferences | string¦null | false | none | none |
| logoImage | string¦null | false | none | Image data as a Base64 string. |
| appLogoImage | string¦null | false | none | App image data as a Base64 string. |
| appLogoMiniImage | string¦null | false | none | App mini image data as a Base64 string. |
| isBatchValidationActive | boolean¦null | false | none | none |
| subscriptionSettings | OrgSubscriptionSetting¦null | false | none | none |
| agreementSettings | OrgAgreementSetting¦null | false | none | none |
| memberScanSettings | OrgMemberScanSetting¦null | false | none | none |
| corporateScanSettings | OrgCorporateScanSetting¦null | false | none | none |
| monitoringSettings | OrgMonitoringSetting¦null | false | none | none |
| idvSettings | OrgIDVSetting¦null | false | none | none |
| assignedUsers | [OrgUser]¦null | false | none | none |
| allowListAccesses | [integer]¦null | false | none | Watchlists access assigned to organisation. Refer to /organisations/allListAccesses api for access list data. |
| customLists | [OrgCustomList]¦null | false | none | none |
| riskLevels | [OrgRiskLevel]¦null | false | none | none |
| name | string¦null | false | none | none |
| displayName | string¦null | false | none | none |
| parentOrg | OrgInfo0¦null | false | none | none |
| isResellerCO | boolean¦null | false | none | none |
| country | OrgCountry¦null | false | none | none |
| complianceOfficers | [OrgUser]¦null | false | none | none |
| accountManager | OrgUser¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| creationDate | string(date-time)¦null | false | none | none |
| dataSources | string¦null | false | none | none |
| isDataSourceEditable | boolean¦null | false | none | none |
| isIdvActive | boolean¦null | false | none | none |
| isFaceMatchActive | boolean¦null | false | none | none |
| isIDCheckActive | boolean¦null | false | none | none |
| isMonitoringActive | boolean¦null | false | none | none |
| isApiActive | boolean¦null | false | none | none |
| status | string¦null | false | none | none |
| isAIAnalysisActive | boolean¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
| isWatchlistActive | boolean¦null | false | none | none |
| isRiskAssessmentActive | boolean¦null | false | none | none |
| riskAssessmentEnabled | string¦null | false | none | none |
| isBatchAMSActive | boolean¦null | false | none | none |
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| emailPreferences | None |
| emailPreferences | SingleScanMatchFound |
| emailPreferences | BatchScanCompleted |
| emailPreferences | UpdateDetectedFromMonitoring |
| emailPreferences | MonitoringRescanResult |
| emailPreferences | UpcomingMonitoringRescan |
| emailPreferences | SubscriptionRenewalReminder |
| emailPreferences | AccountScanServiceChange |
| emailPreferences | AccountActivityNotification |
| emailPreferences | AccountDeactivationReminder |
| emailPreferences | IDVScanCompleted |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| status | Inactive |
| status | Active |
| status | Deleted |
| riskAssessmentEnabled | UserDefined |
| riskAssessmentEnabled | No |
| riskAssessmentEnabled | Yes |
OrgIDVCountry
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| selected | boolean¦null | false | none | none |
| name | string¦null | false | none | none |
| code | string¦null | false | Length: 0 - 5 | none |
| nationality | string¦null | false | none | none |
OrgIDVCountrySubscriberCode
{
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | none |
OrgIDVSetting
{
"countries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"defaultCountry": {
"name": "string",
"code": "strin",
"nationality": "string"
},
"idVerificationProcess": "StepByStep",
"idvCountriesType": "All",
"subscriberCodes": [
{
"code": "string"
}
],
"idvDataSource": "AuGovtVerification",
"idvCountries": [
{
"selected": true,
"name": "string",
"code": "strin",
"nationality": "string"
}
],
"idvAssuranceLevel": "SingleSource"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| countries | [OrgIDVCountry]¦null | false | none | none |
| defaultCountry | OrgCountry0¦null | false | none | none |
| idVerificationProcess | string¦null | false | none | none |
| idvCountriesType | string¦null | false | none | none |
| subscriberCodes | [OrgIDVCountrySubscriberCode]¦null | false | none | none |
| idvDataSource | string¦null | false | none | none |
| idvCountries | [OrgIDVCountry]¦null | false | none | none |
| idvAssuranceLevel | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| idVerificationProcess | StepByStep |
| idVerificationProcess | Comprehensive |
| idvCountriesType | All |
| idvCountriesType | Exclude |
| idvCountriesType | Include |
| idvDataSource | AuGovtVerification |
| idvDataSource | AuGovtRecords |
| idvDataSource | Commercial |
| idvAssuranceLevel | SingleSource |
| idvAssuranceLevel | CrossSource |
OrgInfo
{
"name": "string",
"displayName": "string",
"parentOrg": {
"id": "string",
"fullPath": "string",
"isReseller": true
},
"isResellerCO": true,
"country": {
"timeZoneId": "string",
"name": "string",
"code": "strin",
"nationality": "string"
},
"complianceOfficers": [
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
],
"accountManager": {
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
},
"email": "user@example.com",
"creationDate": "2019-08-24T14:15:22Z",
"dataSources": "MemberCheck",
"isDataSourceEditable": true,
"isIdvActive": true,
"isFaceMatchActive": true,
"isIDCheckActive": true,
"isMonitoringActive": true,
"isApiActive": true,
"status": "Inactive",
"isAIAnalysisActive": true,
"isKybActive": true,
"isWatchlistActive": true,
"isRiskAssessmentActive": true,
"riskAssessmentEnabled": "UserDefined",
"isBatchAMSActive": true,
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| displayName | string¦null | false | none | none |
| parentOrg | OrgInfo0¦null | false | none | none |
| isResellerCO | boolean¦null | false | none | none |
| country | OrgCountry¦null | false | none | none |
| complianceOfficers | [OrgUser]¦null | false | none | none |
| accountManager | OrgUser¦null | false | none | none |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
none | |
| creationDate | string(date-time)¦null | false | none | none |
| dataSources | string¦null | false | none | none |
| isDataSourceEditable | boolean¦null | false | none | none |
| isIdvActive | boolean¦null | false | none | none |
| isFaceMatchActive | boolean¦null | false | none | none |
| isIDCheckActive | boolean¦null | false | none | none |
| isMonitoringActive | boolean¦null | false | none | none |
| isApiActive | boolean¦null | false | none | none |
| status | string¦null | false | none | none |
| isAIAnalysisActive | boolean¦null | false | none | none |
| isKybActive | boolean¦null | false | none | none |
| isWatchlistActive | boolean¦null | false | none | none |
| isRiskAssessmentActive | boolean¦null | false | none | none |
| riskAssessmentEnabled | string¦null | false | none | none |
| isBatchAMSActive | boolean¦null | false | none | none |
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| status | Inactive |
| status | Active |
| status | Deleted |
| riskAssessmentEnabled | UserDefined |
| riskAssessmentEnabled | No |
| riskAssessmentEnabled | Yes |
OrgInfo0
{
"id": "string",
"fullPath": "string",
"isReseller": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| fullPath | string¦null | false | none | none |
| isReseller | boolean¦null | false | none | none |
OrgListAccess
{
"id": 0,
"name": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| subLists | [OrgSubList]¦null | false | none | none |
OrgMemberAutoScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankNationalityActive": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string¦null | false | none | none |
| residencePolicy | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
| pepJurisdictionPolicy | string¦null | false | none | none |
| excludeDeceasedPersons | string¦null | false | none | none |
| isIgnoreBlankNationalityActive | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| residencePolicy | Ignore |
| residencePolicy | ApplyPEP |
| residencePolicy | ApplySIP |
| residencePolicy | ApplyRCA |
| residencePolicy | ApplyPOI |
| residencePolicy | ApplyAll |
| blankAddressPolicy | ApplyResidenceCountry |
| blankAddressPolicy | Ignore |
| pepJurisdictionPolicy | Apply |
| pepJurisdictionPolicy | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
OrgMemberScanSetting
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"defaultScanResult": "NoMatchesFound",
"residencePolicy": "Ignore",
"defaultCountryOfResidence": "string",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"excludeDeceasedPersons": "No",
"isScriptNameFullNameSearchActive": true,
"dobTolerance": 0,
"maxExactScanResult": 200,
"maxCloseScanResult": 200,
"watchlists": [
"string"
],
"webSearch": "No",
"advancedMediaSearch": "No",
"fatfJurisdictionRisk": "No",
"ignoreBlankPolicy": {
"DOB": "No",
"Gender": "No",
"IDNumber": "No",
"Nationality": "No"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | none |
| closeMatchRateThreshold | integer(int32) | false | none | none |
| defaultCloseMatchRateThreshold | integer(int32) | false | none | none |
| whitelistPolicy | string¦null | false | none | none |
| defaultScanResult | string¦null | false | none | none |
| residencePolicy | string¦null | false | none | none |
| defaultCountryOfResidence | string¦null | false | none | none |
| blankAddressPolicy | string¦null | false | none | none |
| pepJurisdictionPolicy | string¦null | false | none | none |
| pepJurisdictionCountries | string¦null | false | none | none |
| isPepJurisdictionExclude | boolean¦null | false | none | none |
| excludeDeceasedPersons | string¦null | false | none | none |
| isScriptNameFullNameSearchActive | boolean | false | none | none |
| dobTolerance | integer(int32)¦null | false | none | none |
| maxExactScanResult | integer(int32) | false | none | none |
| maxCloseScanResult | integer(int32) | false | none | none |
| watchlists | [string]¦null | false | none | none |
| webSearch | string¦null | false | none | none |
| advancedMediaSearch | string¦null | false | none | none |
| fatfJurisdictionRisk | string¦null | false | none | none |
| ignoreBlankPolicy | object¦null | false | none | none |
| » DOB | string | false | none | none |
| » Gender | string | false | none | none |
| » IDNumber | string | false | none | none |
| » Nationality | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelistPolicy | Apply |
| whitelistPolicy | Ignore |
| defaultScanResult | NoMatchesFound |
| defaultScanResult | MatchesFound |
| residencePolicy | Ignore |
| residencePolicy | ApplyPEP |
| residencePolicy | ApplySIP |
| residencePolicy | ApplyRCA |
| residencePolicy | ApplyPOI |
| residencePolicy | ApplyAll |
| blankAddressPolicy | ApplyResidenceCountry |
| blankAddressPolicy | Ignore |
| pepJurisdictionPolicy | Apply |
| pepJurisdictionPolicy | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| webSearch | No |
| webSearch | Yes |
| advancedMediaSearch | No |
| advancedMediaSearch | Yes |
| fatfJurisdictionRisk | No |
| fatfJurisdictionRisk | Yes |
| DOB | No |
| DOB | Yes |
| DOB | UserDefined |
| Gender | No |
| Gender | Yes |
| Gender | UserDefined |
| IDNumber | No |
| IDNumber | Yes |
| IDNumber | UserDefined |
| Nationality | No |
| Nationality | Yes |
| Nationality | UserDefined |
OrgMonitoringSetting
{
"isEmailNotificationActive": true,
"isCallbackUrlNotificationActive": true,
"notificationCallbackUrl": "string",
"isClearOnRenewalActive": true,
"updateMemberMonitoringListPolicy": "UserDefined_No",
"updateCorporateMonitoringListPolicy": "UserDefined_No",
"interval": "Daily",
"lastMemberMonitoredDate": "2019-08-24T14:15:22Z",
"lastCorporateMonitoredDate": "2019-08-24T14:15:22Z",
"monitoringReviewEnabled": true,
"memberScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"residencePolicy": "Ignore",
"blankAddressPolicy": "ApplyResidenceCountry",
"pepJurisdictionPolicy": "Apply",
"excludeDeceasedPersons": "No",
"isIgnoreBlankNationalityActive": true
},
"corporateScanSettings": {
"matchType": "Close",
"closeMatchRateThreshold": 80,
"defaultCloseMatchRateThreshold": 80,
"whitelistPolicy": "Apply",
"addressPolicy": "Ignore",
"blankAddressPolicy": "ApplyDefaultCountry"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isEmailNotificationActive | boolean¦null | false | none | none |
| isCallbackUrlNotificationActive | boolean¦null | false | none | none |
| notificationCallbackUrl | string¦null | false | none | none |
| isClearOnRenewalActive | boolean¦null | false | none | none |
| updateMemberMonitoringListPolicy | string¦null | false | none | none |
| updateCorporateMonitoringListPolicy | string¦null | false | none | none |
| interval | string¦null | false | none | none |
| lastMemberMonitoredDate | string(date-time)¦null | false | none | none |
| lastCorporateMonitoredDate | string(date-time)¦null | false | none | none |
| monitoringReviewEnabled | boolean¦null | false | none | none |
| memberScanSettings | OrgMemberAutoScanSetting¦null | false | none | none |
| corporateScanSettings | OrgCorporateAutoScanSetting¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| updateMemberMonitoringListPolicy | UserDefined_No |
| updateMemberMonitoringListPolicy | UserDefined_Yes |
| updateMemberMonitoringListPolicy | No |
| updateMemberMonitoringListPolicy | Yes |
| updateCorporateMonitoringListPolicy | UserDefined_No |
| updateCorporateMonitoringListPolicy | UserDefined_Yes |
| updateCorporateMonitoringListPolicy | No |
| updateCorporateMonitoringListPolicy | Yes |
| interval | Daily |
| interval | Weekly |
| interval | Fortnightly |
| interval | Monthly |
| interval | Quarterly |
| interval | SemiAnnual |
OrgRiskLevel
{
"categoryId": 0,
"risk": 0,
"isCustomList": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryId | integer(int32) | false | none | none |
| risk | integer(int32) | false | none | none |
| isCustomList | boolean | false | none | none |
OrgSubList
{
"id": 0,
"name": "string",
"description": "string",
"subLists": [
{
"id": 0,
"name": "string",
"description": "string",
"subLists": []
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| description | string¦null | false | none | none |
| subLists | [OrgSubList]¦null | false | none | none |
OrgSubscriptionSetting
{
"startDate": "DD/MM/YYYY",
"renewalDate": "string",
"terminationDate": "DD/MM/YYYY"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
| renewalDate | string¦null | false | none | none |
| terminationDate | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
none |
OrgTimeZone
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| name | string¦null | false | none | none |
OrgUser
{
"id": 0,
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"username": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"status": "Inactive",
"singleOrgAssigned": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| firstName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| username | string¦null | false | none | none |
| role | UserRole¦null | false | none | none |
| status | string¦null | false | none | none |
| singleOrgAssigned | boolean¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
OriginalImageDetails
{
"pageIdx": 0,
"image": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pageIdx | integer(int32) | false | none | none |
| image | string¦null | false | none | none |
OriginalSymbolDetail
{
"code": "string",
"probability": 0,
"rect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | none |
| probability | integer(int32) | false | none | none |
| rect | FieldRect¦null | false | none | none |
PPResult
{
"requestParam": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string"
},
"result": {
"message": "string",
"result": "NotVerified",
"verificationRequestNumber": "string",
"errors": [
{
"field": "string",
"message": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| requestParam | IdCheckPassport¦null | false | none | none |
| result | DvsResult¦null | false | none | none |
PortraitComparisionDetectionsItem
{
"faces": [
{
"faceIndex": 0,
"rotationAngle": 0,
"crop": "string"
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| faces | [PortraitComparisionFacesItem]¦null | false | none | none |
| imageIndex | integer(int32) | false | none | none |
| status | string¦null | false | none | The enumeration contains result codes from Core lib. - FACER_OK: No issues. The process completed successfully. - FR_IMAGE_EMPTY: Cannot read image. The file may not be a valid image format or could be corrupted. - FR_FACE_NOT_DETECTED: Face not detected. - FR_LANDMARKS_NOT_DETECTED: Landmarks not detected. - FR_FACE_ALIGHNER_FAILED: Face aligner failed. - FR_DESCRIPTOR_EXTRACTOR_ERROR: Descriptor extraction error. - FR_IMAGE_DECODE_ERROR: Cannot read image (for example, the image is corrupted). - FR_INTERNAL_ERROR: Internal processing error. - FACER_CONFIG_ERROR: Configuration error. - FACER_NO_LICENSE: No appropriate license. Please ensure that you have a valid license with the necessary features enabled and that your environment is correctly configured. - FACER_IS_NOT_INITIALIZED: The system is not initialized. - FACER_COMMAND_IS_NOT_SUPPORTED: Incorrect parameters in the request. Please check that your request corresponds to the specification. - FACER_COMMAND_PARAMS_READ_ERROR: Worker failed due to invalid request parameters. Please ensure that your request follows the correct format. - FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: While using Match, fewer than two images were provided. - FACER_VIDEO_DECODE_ERROR: Video decoding error. - FACER_NOT_ENOUGH_FRAMES: Not enough frames for processing. - FACER_OUTPUT_IS_NOT_DEFINED: Output is not defined. - FACER_CLOSED_EYES_DETECTED: Closed eyes detected. - FACER_LOW_QUALITY: Low-quality image detected. - FACER_HIGH_ASYMMETRY: High facial asymmetry detected. - FACER_FACE_OVER_EMOTIONAL: Face expression is overly emotional. - FACER_SUNGLASSES_DETECTED: Sunglasses detected. - FACER_SMALL_AGE: Age is below acceptable threshold. - FACER_HEADDRESS_DETECTED: Headwear detected. - FACER_FACES_NOT_MATCHED: Faces do not match. - FACER_IMAGES_COUNT_LIMIT_EXCEEDED: For the Match function, only two images of the same type are allowed. - FACER_MEDICINE_MASK_DETECTED: Medical mask detected. - FACER_OCCLUSION_DETECTED: Liveness spoofing attempt detected. - FACER_FOREHEAD_GLASSES_DETECTED: Liveness spoofing attempt detected. - FACER_MOUTH_OPENED: Liveness spoofing attempt detected. - FACER_ART_MASK_DETECTED: Liveness spoofing attempt detected. - FACER_ELECTRONIC_DEVICE_DETECTED: Liveness spoofing attempt detected. - FACER_TRACK_BREAK: Liveness spoofing attempt detected. - FACER_WRONG_GEO: Liveness spoofing attempt detected. - FACER_WRONG_OF: Liveness spoofing attempt detected. - FACER_WRONG_VIEW: Liveness spoofing attempt detected. - FACER_TIMEOUT_LIVENESS_TRANSACTION: The user did not complete the liveness verification within the allowed time. - FACER_FAILED_LIVENESS_TRANSACTION: A system error occurred during the liveness verification process. - FACER_ABORTED_LIVENESS_TRANSACTION: The user aborted the liveness verification process by closing the application. - FACER_GENERAL_ERROR: Liveness spoofing attempt detected. - FACER_PASSIVE_LIVENESS_FAIL: Liveness spoofing attempt detected. - FACER_PRINTED_FACE_DETECTED: Liveness spoofing attempt detected. |
Enumerated Values
| Property | Value |
|---|---|
| status | FACER_OK |
| status | FR_IMAGE_EMPTY |
| status | FR_FACE_NOT_DETECTED |
| status | FR_LANDMARKS_NOT_DETECTED |
| status | FR_FACE_ALIGHNER_FAILED |
| status | FR_DESCRIPTOR_EXTRACTOR_ERROR |
| status | FR_IMAGE_DECODE_ERROR |
| status | FR_INTERNAL_ERROR |
| status | FACER_CONFIG_ERROR |
| status | FACER_NO_LICENSE |
| status | FACER_IS_NOT_INITIALIZED |
| status | FACER_COMMAND_IS_NOT_SUPPORTED |
| status | FACER_COMMAND_PARAMS_READ_ERROR |
| status | FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST |
| status | FACER_VIDEO_DECODE_ERROR |
| status | FACER_NOT_ENOUGH_FRAMES |
| status | FACER_OUTPUT_IS_NOT_DEFINED |
| status | FACER_CLOSED_EYES_DETECTED |
| status | FACER_LOW_QUALITY |
| status | FACER_HIGH_ASYMMETRY |
| status | FACER_FACE_OVER_EMOTIONAL |
| status | FACER_SUNGLASSES_DETECTED |
| status | FACER_SMALL_AGE |
| status | FACER_HEADDRESS_DETECTED |
| status | FACER_FACES_NOT_MATCHED |
| status | FACER_IMAGES_COUNT_LIMIT_EXCEEDED |
| status | FACER_MEDICINE_MASK_DETECTED |
| status | FACER_OCCLUSION_DETECTED |
| status | FACER_FOREHEAD_GLASSES_DETECTED |
| status | FACER_MOUTH_OPENED |
| status | FACER_ART_MASK_DETECTED |
| status | FACER_ELECTRONIC_DEVICE_DETECTED |
| status | FACER_TRACK_BREAK |
| status | FACER_WRONG_GEO |
| status | FACER_WRONG_OF |
| status | FACER_WRONG_VIEW |
| status | FACER_TIMEOUT_LIVENESS_TRANSACTION |
| status | FACER_FAILED_LIVENESS_TRANSACTION |
| status | FACER_ABORTED_LIVENESS_TRANSACTION |
| status | FACER_GENERAL_ERROR |
| status | FACER_PASSIVE_LIVENESS_FAIL |
| status | FACER_PRINTED_FACE_DETECTED |
PortraitComparisionFacesItem
{
"faceIndex": 0,
"rotationAngle": 0,
"crop": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| faceIndex | integer(int32) | false | none | none |
| rotationAngle | integer(int32) | false | none | none |
| crop | string¦null | false | none | none |
PortraitComparisionResult
{
"code": "FACER_OK",
"detections": [
{
"faces": [
{
"faceIndex": 0,
"rotationAngle": 0,
"crop": "string"
}
],
"imageIndex": 0,
"status": "FACER_OK"
}
],
"results": [
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The enumeration contains result codes from Core lib. - FACER_OK: No issues. The process completed successfully. - FR_IMAGE_EMPTY: Cannot read image. The file may not be a valid image format or could be corrupted. - FR_FACE_NOT_DETECTED: Face not detected. - FR_LANDMARKS_NOT_DETECTED: Landmarks not detected. - FR_FACE_ALIGHNER_FAILED: Face aligner failed. - FR_DESCRIPTOR_EXTRACTOR_ERROR: Descriptor extraction error. - FR_IMAGE_DECODE_ERROR: Cannot read image (for example, the image is corrupted). - FR_INTERNAL_ERROR: Internal processing error. - FACER_CONFIG_ERROR: Configuration error. - FACER_NO_LICENSE: No appropriate license. Please ensure that you have a valid license with the necessary features enabled and that your environment is correctly configured. - FACER_IS_NOT_INITIALIZED: The system is not initialized. - FACER_COMMAND_IS_NOT_SUPPORTED: Incorrect parameters in the request. Please check that your request corresponds to the specification. - FACER_COMMAND_PARAMS_READ_ERROR: Worker failed due to invalid request parameters. Please ensure that your request follows the correct format. - FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: While using Match, fewer than two images were provided. - FACER_VIDEO_DECODE_ERROR: Video decoding error. - FACER_NOT_ENOUGH_FRAMES: Not enough frames for processing. - FACER_OUTPUT_IS_NOT_DEFINED: Output is not defined. - FACER_CLOSED_EYES_DETECTED: Closed eyes detected. - FACER_LOW_QUALITY: Low-quality image detected. - FACER_HIGH_ASYMMETRY: High facial asymmetry detected. - FACER_FACE_OVER_EMOTIONAL: Face expression is overly emotional. - FACER_SUNGLASSES_DETECTED: Sunglasses detected. - FACER_SMALL_AGE: Age is below acceptable threshold. - FACER_HEADDRESS_DETECTED: Headwear detected. - FACER_FACES_NOT_MATCHED: Faces do not match. - FACER_IMAGES_COUNT_LIMIT_EXCEEDED: For the Match function, only two images of the same type are allowed. - FACER_MEDICINE_MASK_DETECTED: Medical mask detected. - FACER_OCCLUSION_DETECTED: Liveness spoofing attempt detected. - FACER_FOREHEAD_GLASSES_DETECTED: Liveness spoofing attempt detected. - FACER_MOUTH_OPENED: Liveness spoofing attempt detected. - FACER_ART_MASK_DETECTED: Liveness spoofing attempt detected. - FACER_ELECTRONIC_DEVICE_DETECTED: Liveness spoofing attempt detected. - FACER_TRACK_BREAK: Liveness spoofing attempt detected. - FACER_WRONG_GEO: Liveness spoofing attempt detected. - FACER_WRONG_OF: Liveness spoofing attempt detected. - FACER_WRONG_VIEW: Liveness spoofing attempt detected. - FACER_TIMEOUT_LIVENESS_TRANSACTION: The user did not complete the liveness verification within the allowed time. - FACER_FAILED_LIVENESS_TRANSACTION: A system error occurred during the liveness verification process. - FACER_ABORTED_LIVENESS_TRANSACTION: The user aborted the liveness verification process by closing the application. - FACER_GENERAL_ERROR: Liveness spoofing attempt detected. - FACER_PASSIVE_LIVENESS_FAIL: Liveness spoofing attempt detected. - FACER_PRINTED_FACE_DETECTED: Liveness spoofing attempt detected. |
| detections | [PortraitComparisionDetectionsItem]¦null | false | none | none |
| results | [PortraitComparisionResultsItem]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| code | FACER_OK |
| code | FR_IMAGE_EMPTY |
| code | FR_FACE_NOT_DETECTED |
| code | FR_LANDMARKS_NOT_DETECTED |
| code | FR_FACE_ALIGHNER_FAILED |
| code | FR_DESCRIPTOR_EXTRACTOR_ERROR |
| code | FR_IMAGE_DECODE_ERROR |
| code | FR_INTERNAL_ERROR |
| code | FACER_CONFIG_ERROR |
| code | FACER_NO_LICENSE |
| code | FACER_IS_NOT_INITIALIZED |
| code | FACER_COMMAND_IS_NOT_SUPPORTED |
| code | FACER_COMMAND_PARAMS_READ_ERROR |
| code | FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST |
| code | FACER_VIDEO_DECODE_ERROR |
| code | FACER_NOT_ENOUGH_FRAMES |
| code | FACER_OUTPUT_IS_NOT_DEFINED |
| code | FACER_CLOSED_EYES_DETECTED |
| code | FACER_LOW_QUALITY |
| code | FACER_HIGH_ASYMMETRY |
| code | FACER_FACE_OVER_EMOTIONAL |
| code | FACER_SUNGLASSES_DETECTED |
| code | FACER_SMALL_AGE |
| code | FACER_HEADDRESS_DETECTED |
| code | FACER_FACES_NOT_MATCHED |
| code | FACER_IMAGES_COUNT_LIMIT_EXCEEDED |
| code | FACER_MEDICINE_MASK_DETECTED |
| code | FACER_OCCLUSION_DETECTED |
| code | FACER_FOREHEAD_GLASSES_DETECTED |
| code | FACER_MOUTH_OPENED |
| code | FACER_ART_MASK_DETECTED |
| code | FACER_ELECTRONIC_DEVICE_DETECTED |
| code | FACER_TRACK_BREAK |
| code | FACER_WRONG_GEO |
| code | FACER_WRONG_OF |
| code | FACER_WRONG_VIEW |
| code | FACER_TIMEOUT_LIVENESS_TRANSACTION |
| code | FACER_FAILED_LIVENESS_TRANSACTION |
| code | FACER_ABORTED_LIVENESS_TRANSACTION |
| code | FACER_GENERAL_ERROR |
| code | FACER_PASSIVE_LIVENESS_FAIL |
| code | FACER_PRINTED_FACE_DETECTED |
PortraitComparisionResultsItem
{
"firstIndex": 0,
"firstFaceIndex": 0,
"first": "DOCUMENT_PRINTED",
"secondIndex": 0,
"secondFaceIndex": 0,
"second": "DOCUMENT_PRINTED",
"score": 0,
"similarity": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstIndex | integer(int32) | false | none | none |
| firstFaceIndex | integer(int32) | false | none | none |
| first | string¦null | false | none | The enumeration contains face photo image source types. - DOCUMENT_PRINTED: Image from a visual zone “document“. - DOCUMENT_RFID: Image from the RFID document. - LIVE: Live picture from a web camera. - DOCUMENT_WITH_LIVE: Compares all faces on one image with each other, for example, a photo of a person showing their passport (or any other document) photo. - EXTERNAL: Any other type or type is not defined. - GHOST: Shadow image. - BARCODE: Image from the barcode. Note that the image type identification result depends on the quality of the image. |
| secondIndex | integer(int32) | false | none | none |
| secondFaceIndex | integer(int32) | false | none | none |
| second | string¦null | false | none | The enumeration contains face photo image source types. - DOCUMENT_PRINTED: Image from a visual zone “document“. - DOCUMENT_RFID: Image from the RFID document. - LIVE: Live picture from a web camera. - DOCUMENT_WITH_LIVE: Compares all faces on one image with each other, for example, a photo of a person showing their passport (or any other document) photo. - EXTERNAL: Any other type or type is not defined. - GHOST: Shadow image. - BARCODE: Image from the barcode. Note that the image type identification result depends on the quality of the image. |
| score | number(double) | false | none | none |
| similarity | number(double) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| first | DOCUMENT_PRINTED |
| first | DOCUMENT_RFID |
| first | LIVE |
| first | DOCUMENT_WITH_LIVE |
| first | EXTERNAL |
| first | GHOST |
| first | BARCODE |
| second | DOCUMENT_PRINTED |
| second | DOCUMENT_RFID |
| second | LIVE |
| second | DOCUMENT_WITH_LIVE |
| second | EXTERNAL |
| second | GHOST |
| second | BARCODE |
ProductResult
{
"productEntityId": "string",
"currency": "string",
"productFormat": "string",
"productTitle": "string",
"deliveryTimeMinutes": "string",
"productInfo": "string",
"price": 0,
"isSampleFileExists": true
}
Represents the result data of the product.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productEntityId | string¦null | false | none | The unique product key used to order a document product. |
| currency | string¦null | false | none | The currency of the document product. |
| productFormat | string¦null | false | none | The format of the document product. |
| productTitle | string¦null | false | none | The title of the document product. |
| deliveryTimeMinutes | string¦null | false | none | Provides the estimated time of product delivery in minutes. Null indicates close to real-time delivery. |
| productInfo | string¦null | false | none | Provides the document product information. |
| price | number(double) | false | none | The price of the document product. |
| isSampleFileExists | boolean | false | none | Indicates whether a sample document exists. |
ProfileOfInterest
{
"category": "string",
"positions": [
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
]
}
Represents details of the Profile of Interest (POI).
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | The category of the POI. |
| positions | [ProfileOfInterestPosition]¦null | false | none | The positions held by the POI, if available. |
ProfileOfInterestPosition
{
"position": "string",
"segment": "string",
"country": "string",
"from": "string",
"to": "string"
}
Represents the position details of the Profile of Interest (POI).
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| position | string¦null | false | none | The job or role of the POI. |
| segment | string¦null | false | none | The category of in scope positions of the POI. |
| country | string¦null | false | none | Country of the term of office for the particular position. |
| from | string¦null | false | none | The Start date of the term of office for the particular position. |
| to | string¦null | false | none | The End date of the term of office in the particular position. |
ReCaptchaConfig
{
"globalUrl": "string",
"publicKey": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| globalUrl | string¦null | false | none | none |
| publicKey | string¦null | false | none | none |
ResultImageItem
{
"count": 0,
"images": [
{
"format": "string",
"image": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer(int32) | false | none | none |
| images | [ImageDetails]¦null | false | none | none |
RiskAssessmentDetail
{
"id": "string",
"question": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"category": "string",
"controlType": "Text",
"isRequired": true
}
Represents a risk assessment detail, including its category, available options, control type, and required status.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | Unique identifier of the risk assessment question. |
| question | string¦null | false | none | Provides risk assessment question. |
| options | [RiskAssessmentOption]¦null | false | none | List of options associated with the risk assessment question. |
| category | string¦null | false | none | Specifies the category of the risk assessment question. |
| controlType | string¦null | false | none | Specifies the input control type for the question. |
| isRequired | boolean | false | none | Indicates whether answering the question is mandatory. If true, the question must be answered; otherwise, it is optional. |
Enumerated Values
| Property | Value |
|---|---|
| controlType | Text |
| controlType | Radio |
| controlType | Select |
| controlType | MultiSelect |
RiskAssessmentHistoryDetail
{
"riskAssessmentParam": {
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"residentStatusId": 0,
"clientVisitId": 0,
"professionId": 0,
"subProfessionId": 0,
"sourceofFundsId": "string",
"nationalityCode": "string",
"domicileCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"isPEP": true,
"isSanctioned": true,
"hasAdverseMedia": true
},
"riskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
},
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
},
"riskAssessmentServiceEnabled": true
}
Details of the member scan parameters and information used to scan, and risk assessment result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| riskAssessmentParam | RiskAssessmentParamHistory¦null | false | none | Scan parameters and member risk assessment information that were scanned. |
| riskAssessmentResult | RiskAssessmentResult¦null | false | none | The result of the individual risk assessment check. |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
| riskAssessmentServiceEnabled | boolean | false | none | Indicates whether the risk assessment service is enabled. |
RiskAssessmentInputParam
{
"firstName": "John",
"middleName": "Michael",
"lastName": "Smith",
"scriptNameFullName": "",
"clientId": "CLIENT-001",
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}
Represents risk assessment input scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| middleName | string¦null | false | none | Member's Middle Name - if available. |
| lastName | string¦null | false | none | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | none | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This field is mandatory, unless you are entering a First and Last Name. |
| clientId | string¦null | false | none | Your Customer Reference, Client or Account ID to uniquely identify the entity. |
| residentStatusId | integer(int32) | true | none | The resident status ID of the individual, used to determine risk. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the individual, used to determine risk. |
| professionId | integer(int32) | true | none | The profession ID of the individual, used to determine risk. |
| subProfessionId | integer(int32) | true | none | The sub-profession ID of the individual, used to determine risk. |
| sourceofFundsId | string¦null | false | none | The source of funds ID of the individual, used to determine risk. |
| nationalityCode | string | true | Length: 1 - undefined | The nationality code of the individual, used to determine risk. |
| domicileCountryCode | string | true | Length: 1 - undefined | The domicile country code of the individual, used to determine risk. |
| productId | integer(int32) | true | none | The product ID associated with the individual, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the individual, used to determine risk. |
| isPEP | boolean | true | none | Indicates whether the individual is a Politically Exposed Person (PEP). |
| isSanctioned | boolean | true | none | Indicates whether the individual is listed on any sanctions lists. |
| hasAdverseMedia | boolean | true | none | Indicates whether the individual is associated with adverse media coverage. |
RiskAssessmentInputParamHistory
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string¦null | false | none | Member's First Name. |
| middleName | string¦null | false | none | Member's Middle Name. |
| lastName | string¦null | false | none | Member's Last Name. |
| scriptNameFullName | string¦null | false | none | Member's Script Full Name. |
| clientId | string¦null | false | none | The client ID associated with the scan. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | The date and time when the scan was performed. |
| updatedDate | string(date-time) | false | none | The date and time when the scan information was last updated. |
RiskAssessmentItem
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
Details of the member risk assessment.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string¦null | false | none | Risk assessment question category. |
| question | string¦null | false | none | Risk assessment question. |
| answer | string¦null | false | none | The answer provided for the corresponding risk assessment question. |
| score | integer(int32)¦null | false | none | The score associated with the answer, if applicable. |
RiskAssessmentOption
{
"value": "string",
"label": "string"
}
Represents an individual option for a risk assessment question, including its value and label.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | The value associated with risk assessment option. |
| label | string¦null | false | none | The label associated with risk assessment option. |
RiskAssessmentParamHistory
{
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"residentStatusId": 0,
"clientVisitId": 0,
"professionId": 0,
"subProfessionId": 0,
"sourceofFundsId": "string",
"nationalityCode": "string",
"domicileCountryCode": "string",
"productId": 0,
"deliveryChannelId": 0,
"isPEP": true,
"isSanctioned": true,
"hasAdverseMedia": true
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | The date and time when the scan was performed. |
| updatedDate | string(date-time) | false | none | The date and time when the scan information was last updated. |
| firstName | string¦null | false | none | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| middleName | string¦null | false | none | Member's Middle Name - if available. |
| lastName | string¦null | false | none | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | none | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This field is mandatory, unless you are entering a First and Last Name. |
| clientId | string¦null | false | none | Your Customer Reference, Client or Account ID to uniquely identify the entity. |
| residentStatusId | integer(int32) | true | none | The resident status ID of the individual, used to determine risk. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the individual, used to determine risk. |
| professionId | integer(int32) | true | none | The profession ID of the individual, used to determine risk. |
| subProfessionId | integer(int32) | true | none | The sub-profession ID of the individual, used to determine risk. |
| sourceofFundsId | string¦null | false | none | The source of funds ID of the individual, used to determine risk. |
| nationalityCode | string | true | Length: 1 - undefined | The nationality code of the individual, used to determine risk. |
| domicileCountryCode | string | true | Length: 1 - undefined | The domicile country code of the individual, used to determine risk. |
| productId | integer(int32) | true | none | The product ID associated with the individual, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the individual, used to determine risk. |
| isPEP | boolean | true | none | Indicates whether the individual is a Politically Exposed Person (PEP). |
| isSanctioned | boolean | true | none | Indicates whether the individual is listed on any sanctions lists. |
| hasAdverseMedia | boolean | true | none | Indicates whether the individual is associated with adverse media coverage. |
RiskAssessmentResult
{
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
Represents individual risk assessment result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalScore | integer(int32) | false | none | Represents the total score calculated based on all risk assessment responses. |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
| riskResult | [RiskAssessmentItem]¦null | false | none | List of individual risk assessment result. |
Enumerated Values
| Property | Value |
|---|---|
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
RiskAssessmentScanResult
{
"scanId": 0,
"riskAssessmentParam": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"clientId": "string",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"updatedDate": "2019-08-24T14:15:22Z"
},
"riskAssessmentResult": {
"totalScore": 0,
"amlRiskLevel": "None",
"riskResult": [
{
"category": "string",
"question": "string",
"answer": "string",
"score": 0
}
]
}
}
Represents member risk assessment scan result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | false | none | The identifier of this scan. It should be used when requesting the GET /riskassessment/member-scans/{scanId} API method to get details of this member scan. |
| riskAssessmentParam | RiskAssessmentInputParamHistory¦null | false | none | Scan parameters and member risk assessment information that were scanned. |
| riskAssessmentResult | RiskAssessmentResult¦null | false | none | The result of the individual risk assessment check. |
RiskAssessmentUpdateParam
{
"residentStatusId": 1,
"clientVisitId": 2,
"professionId": 1,
"subProfessionId": 1,
"sourceofFundsId": "",
"nationalityCode": "AU",
"domicileCountryCode": "AU",
"productId": 2,
"deliveryChannelId": 3,
"isPEP": false,
"isSanctioned": false,
"hasAdverseMedia": false
}
Represents risk assessment input scan parameters.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| residentStatusId | integer(int32) | true | none | The resident status ID of the individual, used to determine risk. |
| clientVisitId | integer(int32) | true | none | The client visit ID of the individual, used to determine risk. |
| professionId | integer(int32) | true | none | The profession ID of the individual, used to determine risk. |
| subProfessionId | integer(int32) | true | none | The sub-profession ID of the individual, used to determine risk. |
| sourceofFundsId | string¦null | false | none | The source of funds ID of the individual, used to determine risk. |
| nationalityCode | string | true | Length: 1 - undefined | The nationality code of the individual, used to determine risk. |
| domicileCountryCode | string | true | Length: 1 - undefined | The domicile country code of the individual, used to determine risk. |
| productId | integer(int32) | true | none | The product ID associated with the individual, used to determine risk. |
| deliveryChannelId | integer(int32) | true | none | The delivery channel ID used by the individual, used to determine risk. |
| isPEP | boolean | true | none | Indicates whether the individual is a Politically Exposed Person (PEP). |
| isSanctioned | boolean | true | none | Indicates whether the individual is listed on any sanctions lists. |
| hasAdverseMedia | boolean | true | none | Indicates whether the individual is associated with adverse media coverage. |
RiskResult
{
"categoryRisks": [
{
"category": "string",
"subCategory": "string",
"risk": "Unallocated"
}
],
"overAllRisk": "Unallocated"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryRisks | [CategoryRisk]¦null | false | none | none |
| overAllRisk | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| overAllRisk | Unallocated |
| overAllRisk | Low |
| overAllRisk | Med |
| overAllRisk | High |
Role
{
"title": "string",
"segment": "string",
"type": "string",
"status": "string",
"country": "string",
"from": "string",
"to": "string"
}
Represents the details of the PEP roles.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | Represents the Job/Role of the PEP in the particular PEP Position. |
| segment | string¦null | false | none | The category of in scope positions of the PEP for a particular country. |
| type | string¦null | false | none | Represents the standard PEP Position held by the PEP.Note: Decommissioned on 1 July 2020. |
| status | string¦null | false | none | Represent whether the particular role is Current or Former. There can be more than one Current and Former roles held by the PEP. |
| country | string¦null | false | none | Country of the term of office for the particular role. |
| from | string¦null | false | none | The Start date of the term of office for the particular role. |
| to | string¦null | false | none | The End date of the term of office in the particular role. |
SanctionedCountryResult
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
Details of the Sanctioned country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isPrimaryLocation | boolean¦null | false | none | Indicates whether the sanctioned country is primary location of the entity. |
| countryCode | string¦null | false | none | Indicates 2-letter country code. |
| comment | string¦null | false | none | Description of sanctioned country. |
| url | string¦null | false | none | The reference link for sanctioned country. |
| isBlackList | boolean | false | none | Identifies whether the country is in BlackList or not. |
| isGreyList | boolean | false | none | Identifies whether the country is in GreyList or not. |
ScanEntity
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
},
"monitoringStatus": "NewMatches",
"matchedFields": "string",
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"matchRate": 0,
"dob": "string",
"primaryLocation": "string",
"decisionDetail": {
"text": "string",
"matchDecision": "Match",
"assessedRisk": "Unallocated",
"comment": "string"
},
"aiAnalysisQuestionCount": 0,
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
Represents the results data of the member scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| resultId | integer(int32) | true | none | The identifier of each matched entity. It should be used when requesting the GET /member-scans/single/results/{id} API method to get the entity profile information. |
| uniqueId | integer(int32) | false | none | The unique identifier of matched entity. |
| resultEntity | Entity¦null | false | none | Represents detail profile of matched entiry. |
| monitoredOldEntity | Entity¦null | false | none | Represents old detail profile of monitored entity. This only available if monitoringStatus is UpdatedMatches. |
| monitoringStatus | string¦null | false | none | Indicates monitoring update status (if available). |
| matchedFields | string¦null | false | none | Indicates matched fields. Contains combination of AKA, PrimaryName, FullPrimaryName, ScriptName, FullScriptName, Gender, DOB, YOB, ApproximateYOB, Country, IDNumber and Nationality values. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string | true | Length: 1 - undefined | The first name of the matched entity. |
| middleName | string | true | Length: 1 - undefined | The middle name of the matched entity. |
| lastName | string | true | Length: 1 - undefined | The last name of the matched entity. |
| matchRate | integer(int32)¦null | false | none | For Close match scans only. Indicates the Close Match Rate for each matched entity. Values are from 1 (not close) to 100 (exact or very close). |
| dob | string¦null | false | none | The date of birth of the matched entity. |
| primaryLocation | string¦null | false | none | The primary location of the matched entity. |
| decisionDetail | DecisionDetail¦null | false | none | List of due diligence decision, match decision and assessed risk of a member or corporate entity. (If clientId was not included in the scan, decision will not available). |
| aiAnalysisQuestionCount | integer(int32)¦null | false | none | Number of AIAnalysis questions asked for matched entity. |
| taxHavenCountryResults | [TaxHavenCountryResult]¦null | false | none | Provides tax haven information if country is identified as tax haven based on primary location and nationalities. |
| sanctionedCountryResults | [SanctionedCountryResult]¦null | false | none | Provides sanctioned information if country is identified as sanctioned based on primary location and nationalities. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
ScanHistoryDetail
{
"scanParam": {
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"watchLists": [
"string"
],
"watchlistsNote": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"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",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "AuGovtVerification",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "string",
"parentOrigin": "string"
},
"includeJurisdictionRisk": "No",
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "DOB"
},
"scanResult": {
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"idvUrl": "string",
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"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",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
},
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
}
}
Details of the scan parameters and member information used to scan, and list of possible matches.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanParam | ScanInputParamHistory¦null | false | none | Scan parameters and member information that were scanned. |
| scanResult | ScanResult¦null | false | none | Lists of Found Entities identified from the Watchlists as possible matches. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
ScanHistoryLog
{
"date": "2019-08-24T14:15:22Z",
"scanType": "Single",
"matchType": "Close",
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"scanService": "PepAndSanction",
"idvStatus": "NotVerified",
"idvFaceMatchStatus": "Pass",
"supportingDocumentNames": [
"string"
],
"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",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
Represents member scan history data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date-time) | true | none | Date of scan. |
| scanType | string¦null | false | none | Scan type. |
| matchType | string¦null | false | none | Match type scanned. |
| whitelist | string¦null | false | none | Whitelist policy used for scan. |
| residence | string¦null | false | none | Address policy used for scan. |
| blankAddress | string¦null | false | none | Blank address policy used for scan. |
| pepJurisdiction | string¦null | false | none | PEP jurisdiction used for scan. |
| excludeDeceasedPersons | string¦null | false | none | Exclude deceased persons policy used for scan. |
| scanService | string¦null | 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. |
| supportingDocumentNames | [string]¦null | false | none | List of supporting document names of a specific scan. |
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string¦null | false | none | The member first name scanned. |
| middleName | string¦null | false | none | The member middle name scanned (if available). |
| lastName | string¦null | false | none | The member last name scanned. |
| scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| dob | string¦null | false | none | The member date of birth scanned. |
| 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). |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
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 |
| scanService | RiskAssessment |
| idvStatus | NotVerified |
| idvStatus | Verified |
| idvStatus | Pass |
| idvStatus | PartialPass |
| idvStatus | Fail |
| idvStatus | Pending |
| idvStatus | Incomplete |
| idvStatus | NotRequested |
| idvStatus | ReviewRequired |
| idvStatus | InvalidData |
| idvStatus | TechnicalError |
| idvStatus | All |
| idvFaceMatchStatus | Pass |
| idvFaceMatchStatus | Review |
| idvFaceMatchStatus | Fail |
| idvFaceMatchStatus | Pending |
| idvFaceMatchStatus | Incomplete |
| idvFaceMatchStatus | NotRequested |
| idvFaceMatchStatus | Verified |
| idvFaceMatchStatus | NotVerified |
| idvFaceMatchStatus | All |
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
ScanHistoryLog0
{
"scanId": 0,
"matches": 0,
"decisions": {
"match": 0,
"noMatch": 0,
"notSure": 0,
"notReviewed": 0,
"risk": "string"
},
"category": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"scriptNameFullName": "string",
"dob": "string",
"clientId": "string",
"monitor": true,
"monitoringStatus": "NewMatches",
"monitoringReviewStatus": true,
"amlRiskLevel": "None"
}
Represents the scan history data scanned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| matches | integer(int32)¦null | false | none | Number of matches found for the member. |
| decisions | DecisionInfo¦null | false | none | The due diligence decisions count and risk information. |
| category | string¦null | false | none | The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, POI, SIP, RCA. |
| firstName | string¦null | false | none | The member first name scanned. |
| middleName | string¦null | false | none | The member middle name scanned (if available). |
| lastName | string¦null | false | none | The member last name scanned. |
| scriptNameFullName | string¦null | false | none | The member original script / full name scanned. |
| dob | string¦null | false | none | The member date of birth scanned. |
| 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). |
| amlRiskLevel | string¦null | false | none | Represents the risk level based on risk assessment analysis. |
Enumerated Values
| Property | Value |
|---|---|
| monitoringStatus | NewMatches |
| monitoringStatus | UpdatedMatches |
| monitoringStatus | RemovedMatches |
| monitoringStatus | NoChanges |
| monitoringStatus | All |
| amlRiskLevel | None |
| amlRiskLevel | Low |
| amlRiskLevel | Medium |
| amlRiskLevel | High |
| amlRiskLevel | Sanctions |
ScanInputParam
{
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "ApplyAll",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "Yes",
"clientId": "CLIENT-001",
"firstName": "Anthony",
"middleName": "",
"lastName": "Albanese",
"scriptNameFullName": "",
"gender": "Male",
"dob": "02/03/1963",
"dobTolerance": 2,
"idNumber": "",
"address": "123 Example St, Sydney NSW 2000",
"country": [
"AU"
],
"nationality": [
"AU"
],
"includeResultEntities": "Yes",
"updateMonitoringList": "No",
"includeWebSearch": "No",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "john.smith@example.com"
},
"idvParam": {
"mobileNumber": "+61412345678",
"emailAddress": "john.smith@example.com",
"country": {
"code": "AU"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Email",
"allowDuplicateIDVScan": false,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "Commercial",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "ABCXYZ",
"parentOrigin": "https://example.com"
},
"includeJurisdictionRisk": "No",
"watchlists": [],
"dataSources": "Acuris",
"includeRiskAssessment": "No",
"ignoreBlankPolicy": ""
}
Scan parameters, which include match type and policy options, to be applied to each scan.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. This is optional if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. |
| firstName | string¦null | false | Length: 0 - 249 | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). To specify a mononym (single name), enter a dash (-) in this parameter and the mononym in lastName. |
| middleName | string¦null | false | Length: 0 - 255 | Member's Middle Name - if available. |
| lastName | string¦null | false | Length: 0 - 251 | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This parameter has multiple uses and supports either the individual's full name in original script text (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name if you are unable to separate based on First, Middle and Last Name. This field is mandatory, unless you are entering a First and Last Name. |
| gender | string¦null | false | Length: 0 - 15 | Member's gender - if available. Male, Female and blank are acceptable values. |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Member's Date of Birth - if available, using the format DD/MM/YYYY or YYYY. Matching is performed on date of birth, for exact matches, if it is entered. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| idNumber | string¦null | false | Length: 0 - 100 | Member identifier - such as National ID, Passport Number, Professional Registration ID, VAT/Tax Number, Insolvency ID or equivalent. If you enter an ID Number, it will be used in the matching process and matches will only be returned if the ID Number is 'contained' in the watchlist record. Profiles that do not have any registered identifiers will not be returned as a match. This should be used with care and is useful for filtering potentially large number of results when screening popular and commonly used names. |
| address | string¦null | false | Length: 0 - 255 | Member's Address - there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. |
| country | [string]¦null | false | none | Member's Country of residence - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| nationality | [string]¦null | false | none | Member's Nationality - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the member to the Monitoring List if clientId/memberNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing member with the same clientId/memberNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeAdvancedMedia | string¦null | false | none | Used for including advanced media results. |
| dataBreachCheckParam | DataBreachCheckInputParam¦null | false | none | Data Breach Check parameter - includes Email Address. |
| idvParam | IDVScanInputParam¦null | false | none | Member's ID Verification parameters - if required, which includes mobile number and the country which member is verified for. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | 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 organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
ScanInputParamHistory
{
"scanType": "Single",
"scanService": "PepAndSanction",
"organisation": "string",
"user": "string",
"date": "2019-08-24T14:15:22Z",
"defaultCountryOfResidence": "string",
"pepJurisdictionCountries": "string",
"isPepJurisdictionExclude": true,
"watchLists": [
"string"
],
"watchlistsNote": "string",
"matchType": "Close",
"closeMatchRateThreshold": 80,
"whitelist": "Apply",
"residence": "Ignore",
"blankAddress": "ApplyResidenceCountry",
"pepJurisdiction": "Apply",
"excludeDeceasedPersons": "No",
"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",
"includeAdvancedMedia": "No",
"dataBreachCheckParam": {
"emailAddress": "string"
},
"idvParam": {
"mobileNumber": "string",
"emailAddress": "string",
"country": {
"code": "string"
},
"idvType": "IDCheck",
"idvSubType": "IDCheck_Sms",
"allowDuplicateIDVScan": true,
"verificationProcess": "StepByStep",
"consent": true,
"idvDataSource": "AuGovtVerification",
"idvAssuranceLevel": "SingleSource",
"subscriberCode": "string",
"parentOrigin": "string"
},
"includeJurisdictionRisk": "No",
"dataSources": "Acuris",
"watchlists": [
"string"
],
"includeRiskAssessment": "No",
"ignoreBlankPolicy": "DOB"
}
More scan parameters, which include organisation, user and date.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scanType | string¦null | false | none | Type of scan. |
| scanService | string¦null | false | none | Type of scan service. |
| organisation | string¦null | false | none | Organisation of scan. |
| user | string¦null | false | none | User of scan. |
| date | string(date-time) | false | none | Date of scan. |
| defaultCountryOfResidence | string¦null | false | none | Default country of residence of scan. |
| pepJurisdictionCountries | string¦null | false | none | Excluded/Included countries if pepJurisdiction not ignored. |
| isPepJurisdictionExclude | boolean | false | none | If pepJurisdiction countries has been Excluded (or Included). |
| watchLists | [string]¦null | false | none | Scan against selected watchlists. This selection can be changed by the Compliance Officer in Administration > Organisations > List Access tab. |
| watchlistsNote | string¦null | false | none | none |
| matchType | string¦null | false | none | Used to determine how closely a watchlist entity name must match a member before being considered a match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer about the Organisation's Scan Settings. See below for supported values. |
| closeMatchRateThreshold | integer(int32)¦null | false | Pattern: ^(\d?[1... | Used to refine Close Match results by setting a Close Match Rate threshold (1 to 100). This is only applicable if matchType is Close. |
| whitelist | string¦null | false | none | Used for eliminating match results previously determined to not be a true match. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| residence | string¦null | false | none | Used for eliminating match results where the member and matching entity have a different Country of Residence. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| blankAddress | string¦null | false | none | Used in conjunction with the preset Default Country of Residence in the Organisation's Scan Settings in the web application to apply the default Country if member addresses are blank. |
| pepJurisdiction | string¦null | false | none | Used for eliminating/including match results where the matching watchlist entity is a PEP whose country of Jurisdiction is selected for exclusion/inclusion in the organisation's settings. This is mandatory to be defined if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| excludeDeceasedPersons | string¦null | false | none | Used for eliminating deceased persons in match results. This is optional if the Organisation's Scan Settings in the web application is set to User Defined.Please check with your Compliance Officer of the Organisation's Scan Settings. |
| clientId | string¦null | false | Length: 0 - 100 | Your Customer Reference, Client or Account ID to uniquely identify the individual. This is required if you wish to record due diligence decisions for any matched entities. |
| firstName | string¦null | false | Length: 0 - 249 | Member's First Name - this field is mandatory (unless you are entering an Script Name / Full Name). To specify a mononym (single name), enter a dash (-) in this parameter and the mononym in lastName. |
| middleName | string¦null | false | Length: 0 - 255 | Member's Middle Name - if available. |
| lastName | string¦null | false | Length: 0 - 251 | Member's Last Name - this field is mandatory (unless you are entering an Script Name / Full Name). |
| scriptNameFullName | string¦null | false | Length: 0 - 255 | This parameter is available if the Compliance Officer has enabled the setting Original Script Search/Full Name in the Organisation Settings.This parameter has multiple uses and supports either the individual's full name in original script text (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name if you are unable to separate based on First, Middle and Last Name. This field is mandatory, unless you are entering a First and Last Name. |
| gender | string¦null | false | Length: 0 - 15 | Member's gender - if available. Male, Female and blank are acceptable values. |
| dob | string¦null | false | Length: 0 - 10 Pattern: ^((0?[1... |
Member's Date of Birth - if available, using the format DD/MM/YYYY or YYYY. Matching is performed on date of birth, for exact matches, if it is entered. |
| dobTolerance | integer(int32)¦null | false | Pattern: ^(\d?[0... | Allowance for date of birth variations: The tolerance will be ± [X] years around the member's year of birth, taking into account possible discrepancies. There is a maximum tolerance variation of 9 years. |
| idNumber | string¦null | false | Length: 0 - 100 | Member identifier - such as National ID, Passport Number, Professional Registration ID, VAT/Tax Number, Insolvency ID or equivalent. If you enter an ID Number, it will be used in the matching process and matches will only be returned if the ID Number is 'contained' in the watchlist record. Profiles that do not have any registered identifiers will not be returned as a match. This should be used with care and is useful for filtering potentially large number of results when screening popular and commonly used names. |
| address | string¦null | false | Length: 0 - 255 | Member's Address - there are no restrictions imposed on the format. No matching is performed on address but it is used for comparing country of residence when the Residence Policy is applied. |
| country | [string]¦null | false | none | Member's Country of residence - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| nationality | [string]¦null | false | none | Member's Nationality - Supports multiple values up to a maximum of 5. Format should be ISO 3166-1 alpha-2. |
| includeResultEntities | string¦null | false | none | Include full profile information of all matched entities to be returned in resultEntity. This is enabled by default if not explicitly defined. |
| updateMonitoringList | string¦null | false | none | Used for adding the member to the Monitoring List if clientId/memberNumber is specified and the Monitoring setting for the organisation and the user access rights are enabled. Please ask your Compliance Officer to check these Organisation and User Access Rights settings via the web application. Please note that if an existing member with the same clientId/memberNumber exists in the Monitoring List, it can be replaced with the new scan with the option ForceUpdate. |
| includeWebSearch | string¦null | false | none | Used for including adverse media results on the web using Google search engine. |
| includeAdvancedMedia | string¦null | false | none | Used for including advanced media results. |
| dataBreachCheckParam | DataBreachCheckInputParam¦null | false | none | Data Breach Check parameter - includes Email Address. |
| idvParam | IDVScanInputParam¦null | false | none | Member's ID Verification parameters - if required, which includes mobile number and the country which member is verified for. |
| includeJurisdictionRisk | string¦null | false | none | Used for including FATF Jurisdiction Risk ratings for technical compliance and efficiency, based on FATF recommendations, for countries linked to matched profiles. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| watchlists | [string]¦null | false | none | 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 organisation's list access will be used as default. |
| includeRiskAssessment | string¦null | false | none | Indicates whether a risk assessment check is included. |
| ignoreBlankPolicy | string¦null | false | none | Used for filtering result profiles with blank related entries. |
Enumerated Values
| Property | Value |
|---|---|
| scanType | Single |
| scanType | Batch |
| scanType | Automatic |
| scanType | MonitoringRescan |
| scanService | PepAndSanction |
| scanService | IDVerification |
| scanService | RiskAssessment |
| matchType | Close |
| matchType | Exact |
| matchType | ExactMidName |
| whitelist | Apply |
| whitelist | Ignore |
| residence | Ignore |
| residence | ApplyPEP |
| residence | ApplySIP |
| residence | ApplyRCA |
| residence | ApplyPOI |
| residence | ApplyAll |
| blankAddress | ApplyResidenceCountry |
| blankAddress | Ignore |
| pepJurisdiction | Apply |
| pepJurisdiction | Ignore |
| excludeDeceasedPersons | No |
| excludeDeceasedPersons | Yes |
| includeResultEntities | Yes |
| includeResultEntities | No |
| updateMonitoringList | ForceUpdate |
| updateMonitoringList | No |
| updateMonitoringList | Yes |
| includeWebSearch | No |
| includeWebSearch | Yes |
| includeAdvancedMedia | No |
| includeAdvancedMedia | Yes |
| includeJurisdictionRisk | No |
| includeJurisdictionRisk | Yes |
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
| includeRiskAssessment | No |
| includeRiskAssessment | Yes |
| ignoreBlankPolicy | DOB |
| ignoreBlankPolicy | Gender |
| ignoreBlankPolicy | IDNumber |
| ignoreBlankPolicy | Nationality |
ScanResult
{
"metadata": {
"message": "string",
"advancedMediaError": "string"
},
"scanId": 0,
"resultUrl": "string",
"dataSources": "Acuris",
"matchedNumber": 0,
"idvUrl": "string",
"matchedEntities": [
{
"resultId": 0,
"uniqueId": 0,
"resultEntity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"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"
}
],
"advancedMediaResults": [
{
"articleId": 0,
"siteId": 0,
"wordCount": "string",
"author": "string",
"link": "string",
"title": "string",
"publishedDate": "string",
"sourceName": "string",
"summary": "string",
"body": "string",
"readCount": "string",
"articleImages": [
"string"
],
"bookmarkId": 0,
"isBookmarked": true
}
],
"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",
"fatfBlackGreyRisk": 0,
"countryCode": "string"
}
],
"monitoringReviewStatus": true,
"monitoringReviewSummary": "string",
"supportingDocumentDetails": {
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
}
Lists the scan match results for the member's details.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| metadata | Metadata¦null | false | none | The matada about result. |
| scanId | integer(int32) | true | none | The identifier of this scan. It should be used when requesting the GET /member-scans/single/{id} API method to get details of this member scan. |
| resultUrl | string | true | Length: 1 - undefined | This URL provides a link to view the scan information and details of the matched companies. Valid credentials are required as well as authorisation to view the scan results. |
| dataSources | string¦null | false | none | DataSources of scan. Used when the organisation DataSources selection during screening is enabled. The option can be configured in Organisation List Access settings. The acceptable values depend on the selected DataSources of the Organisation. |
| matchedNumber | integer(int32) | true | none | Number of matched entities found. 0 means no matches found. |
| idvUrl | string¦null | false | none | URL to complete the form for IDV scan via a third-party web page. |
| matchedEntities | [ScanEntity] | true | none | List of matched entities. |
| webSearchResults | [WebSearchResult]¦null | false | none | List of adverse media results on the web using Google search engine. |
| advancedMediaResults | [AdvancedMediaResult]¦null | false | none | List of Advanced Media results. |
| dataBreachCheckResults | [DataBreachCheckResult]¦null | false | none | List of email breaches found. |
| fatfJurisdictionRiskResults | [FATFJurisdictionRiskInfo]¦null | false | none | List of jurisdiction risk results. |
| monitoringReviewStatus | boolean¦null | false | none | Monitoring Review Status. |
| monitoringReviewSummary | string¦null | false | none | Monitoring Review Summary message. |
| supportingDocumentDetails | SupportingDocumentDetails¦null | false | none | Provides details of the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| dataSources | MemberCheck |
| dataSources | Acuris |
| dataSources | LexisNexis |
SingleScanCorpResultDetail
{
"id": 0,
"entity": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"primaryName": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"entityName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Represents details of a single corporate scan result.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier of the single corporate scan result. |
| entity | EntityCorp¦null | false | none | The details of the identified matching company. |
SingleScanResultDetail
{
"id": 0,
"person": {
"uniqueId": 0,
"dataSource": "string",
"category": "string",
"categories": "string",
"subcategory": "string",
"suggestedRisk": "Unallocated",
"gender": "string",
"deceased": "string",
"primaryFirstName": "string",
"primaryMiddleName": "string",
"primaryLastName": "string",
"position": "string",
"dateOfBirth": "string",
"deceasedDate": "string",
"placeOfBirth": "string",
"primaryLocation": "string",
"images": [
"string"
],
"generalInfo": {
"property1": "string",
"property2": "string"
},
"furtherInformation": "string",
"lastReviewed": "string",
"descriptions": [
{
"description1": "string",
"description2": "string",
"description3": "string"
}
],
"nameDetails": [
{
"nameType": "string",
"firstName": "string",
"middleName": "string",
"lastName": "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",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
],
"linkedIndividuals": [
{
"id": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"linkedCompanies": [
{
"id": 0,
"name": "string",
"category": "string",
"subcategories": "string",
"description": "string",
"suggestedRisk": "Unallocated"
}
],
"taxHavenCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
],
"sanctionedCountryResults": [
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string",
"isBlackList": true,
"isGreyList": true
}
]
}
}
Represents a single member scan result details.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier of the single member scan result. |
| person | Entity¦null | false | none | The details of the matched person. |
Source
{
"url": "string",
"categories": "string",
"details": [
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
],
"type": "string"
}
Details of public sources used to build the full profile.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string¦null | false | none | Link to original source or website. |
| categories | string¦null | false | none | List of source categories. Possible values are: PEP, PEP by Association, Profile Of Interest, Sanctions, Regulatory Enforcement List, Disqualified Director, Insolvency, Reputational Risk Exposure, Identity, Gambling Risk Intelligence, Corporate/Business, State-Owned Enterprise.Note: Only Acuris |
| details | [SourceDetails]¦null | false | none | List of details for the dates the source was recorded or captured. Note: Only Acuris |
| type | string¦null | false | none | Type of the source. |
SourceDetails
{
"id": "string",
"categories": "string",
"originalUrl": "string",
"title": "string",
"credibility": "string",
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"assetUrl": "string",
"isCopyrighted": true
}
Details of each date the source was recorded or captured.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | The unique identifier of the source. |
| categories | string¦null | false | none | List of source categories. Possible values are: PEP, PEP by Association, Profile Of Interest, Sanctions, Regulatory Enforcement List, Disqualified Director, Insolvency, Reputational Risk Exposure, Identity, Gambling Risk Intelligence, Corporate/Business, State-Owned Enterprise. |
| originalUrl | string¦null | false | none | Link to original source or website. |
| title | string¦null | false | none | The title captured from the source. |
| credibility | string¦null | false | none | The credibility of the source. |
| language | string¦null | false | none | The ISO 639-3 code for the language of the source. |
| summary | string¦null | false | none | A text snippet from the source, if available. |
| keywords | string¦null | false | none | The keywords associated with the source. |
| captureDate | string¦null | false | none | The date that the source was recorded or captured. |
| publicationDate | string¦null | false | none | The date that the source was originally published. |
| assetUrl | string¦null | false | none | The URL link to the PDF version of the source, if available. |
| isCopyrighted | boolean | false | none | Indicates if the source is protected under copyright laws. |
SsoSettings
{
"callbackUrl": "string",
"signOutUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callbackUrl | string¦null | false | none | none |
| signOutUrl | string¦null | false | none | none |
StatusDetails
{
"overallStatus": "ERROR",
"optical": "ERROR",
"rfid": "ERROR",
"detailsOptical": {
"overallStatus": "ERROR",
"docType": "ERROR",
"expiry": "ERROR",
"imageQA": "ERROR",
"mrz": "ERROR",
"pagesCount": 0,
"security": "ERROR",
"text": "ERROR",
"vds": "ERROR"
},
"portrait": "ERROR",
"stopList": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| overallStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| optical | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| rfid | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| detailsOptical | DetailsOptical¦null | false | none | none |
| portrait | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| stopList | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| overallStatus | ERROR |
| overallStatus | OK |
| overallStatus | WAS_NOT_DONE |
| optical | ERROR |
| optical | OK |
| optical | WAS_NOT_DONE |
| rfid | ERROR |
| rfid | OK |
| rfid | WAS_NOT_DONE |
| portrait | ERROR |
| portrait | OK |
| portrait | WAS_NOT_DONE |
| stopList | ERROR |
| stopList | OK |
| stopList | WAS_NOT_DONE |
SupportingDocumentConfig
{
"maximumFilesAllowed": 0,
"maximumFileSize": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maximumFilesAllowed | integer(int32) | false | none | none |
| maximumFileSize | integer(int32) | false | none | none |
SupportingDocumentDetails
{
"documents": [
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
],
"historyAvailable": true
}
Represents the details of supporting documents, including their results and history availability status.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| documents | [SupportingDocumentResult]¦null | false | none | List of supporting document results. |
| historyAvailable | boolean | false | none | Indicates whether the supporting document history is available. |
SupportingDocumentFile
{
"file": "string",
"comment": "string",
"documentTypeId": 0
}
Represents a supporting document with its associated metadata.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| file | string(binary) | true | none | The uploaded supporting document file. |
| comment | string¦null | false | none | Comments associated with the supporting document. |
| documentTypeId | integer(int32) | false | none | The identifier of the selected document type for the supporting document. |
SupportingDocumentHistoryResult
{
"fileName": "string",
"date": "2019-08-24T14:15:22Z",
"uploadedBy": "string",
"action": "Uploaded"
}
Represents the history of actions performed on a supporting document.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fileName | string¦null | false | none | The name of the supporting document. |
| date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| action | string¦null | false | none | The action performed on the supporting document. |
Enumerated Values
| Property | Value |
|---|---|
| action | Uploaded |
| action | Downloaded |
| action | Overwritten |
| action | Deleted |
SupportingDocumentResponse
{
"uploadedFileResult": [
{
"fileName": "string",
"supportingDocumentId": 0
}
]
}
Represents the response containing the details of uploaded supporting documents.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uploadedFileResult | [SupportingDocumentUploadedFiles]¦null | false | none | A list of uploaded supporting document details. |
SupportingDocumentResult
{
"id": 0,
"fileName": "string",
"uploadedBy": "string",
"fileSize": 0,
"date": "2019-08-24T14:15:22Z",
"comment": "string",
"isPinned": true,
"documentType": "string",
"documentTypeDescription": "string"
}
Represents the details of a supporting document.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier of the supporting document. |
| fileName | string¦null | false | none | The file name of the supporting document. |
| uploadedBy | string¦null | false | none | The name of the user who uploaded the supporting document. |
| fileSize | integer(int32) | false | none | The size of the supporting document in bytes. |
| date | string(date-time) | false | none | The date and time when the supporting document was uploaded. |
| comment | string¦null | false | none | Any comments associated with the supporting document. |
| isPinned | boolean | false | none | Indicates whether the supporting document is pinned (true if pinned). |
| documentType | string¦null | false | none | The type of the supporting document. |
| documentTypeDescription | string¦null | false | none | The description of the document type. |
SupportingDocumentType
{
"id": 0,
"name": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The identifier of Supporting Document Type. |
| name | string¦null | false | none | The name of Supporting Document Type. |
| description | string¦null | false | none | The description of Supporting Document Type. |
SupportingDocumentUploadedFiles
{
"fileName": "string",
"supportingDocumentId": 0
}
Represents the details of an uploaded supporting document.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fileName | string¦null | false | none | The file name of the uploaded supporting document. |
| supportingDocumentId | integer(int32) | false | none | The unique identifier of the uploaded supporting document. |
SystemPublicSettings
{
"reCaptchaSettings": {
"globalUrl": "string",
"publicKey": "string"
},
"mailSettings": {
"fromEmail": "string",
"supportEmail": "string"
},
"supportingDocumentSettings": {
"maximumFilesAllowed": 0,
"maximumFileSize": 0
},
"serverTimezone": "string",
"isSSOEnabled": true,
"isFeedbackRatingEnabled": true,
"idvStorageFileStorageType": "string",
"idvEventOrigin": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reCaptchaSettings | ReCaptchaConfig¦null | false | none | none |
| mailSettings | MailConfig¦null | false | none | none |
| supportingDocumentSettings | SupportingDocumentConfig¦null | false | none | none |
| serverTimezone | string¦null | false | none | none |
| isSSOEnabled | boolean | false | none | none |
| isFeedbackRatingEnabled | boolean | false | none | none |
| idvStorageFileStorageType | string¦null | false | none | none |
| idvEventOrigin | string¦null | false | none | none |
TaxHavenCountryResult
{
"isPrimaryLocation": true,
"countryCode": "string",
"comment": "string",
"url": "string"
}
Details of the TaxHaven country.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isPrimaryLocation | boolean¦null | false | none | Indicates whether the tax haven country is primary location of the entity. |
| countryCode | string¦null | false | none | Indicates 2-letter country code. |
| comment | string¦null | false | none | Description of tax haven country. |
| url | string¦null | false | none | The reference link for tax haven country. |
TextDetails
{
"availableSourceList": [
{
"containerType": "DOCUMENT_IMAGE",
"source": "string",
"validityStatus": "ERROR"
}
],
"comparisonStatus": "ERROR",
"dateFormat": "string",
"fieldList": [
{
"comparisonList": [
{
"sourceLeft": "MRZ",
"sourceRight": "MRZ",
"status": "ERROR"
}
],
"comparisonStatus": "ERROR",
"fieldName": "string",
"fieldType": "DOCUMENT_CLASS_CODE",
"lcid": "LATIN",
"lcidName": "string",
"status": "ERROR",
"validityList": [
{
"source": "string",
"status": "ERROR"
}
],
"validityStatus": "ERROR",
"value": "string",
"valueList": [
{
"containerType": "DOCUMENT_IMAGE",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalSymbols": [
{
"code": "string",
"probability": 0,
"rect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
}
],
"originalValidity": 0,
"pageIndex": 0,
"probability": 0,
"source": "string",
"status": "string",
"value": "string"
}
]
}
],
"status": "ERROR",
"validityStatus": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| availableSourceList | [AvailableSourceItem]¦null | false | none | none |
| comparisonStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| dateFormat | string¦null | false | none | none |
| fieldList | [FieldItem]¦null | false | none | none |
| status | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
| validityStatus | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| comparisonStatus | ERROR |
| comparisonStatus | OK |
| comparisonStatus | WAS_NOT_DONE |
| status | ERROR |
| status | OK |
| status | WAS_NOT_DONE |
| validityStatus | ERROR |
| validityStatus | OK |
| validityStatus | WAS_NOT_DONE |
UserAccessRight
{
"id": 0,
"name": "string",
"allow": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| allow | boolean | false | none | none |
UserAccessRight0
{
"id": 0,
"allow": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | none |
| allow | boolean | false | none | none |
UserDetails
{
"apiKey": "string",
"address": "string",
"postalAddress": "string",
"phoneNumber": "string",
"faxNumber": "string",
"failedLoginDate": "2019-08-24T14:15:22Z",
"mfaType": "Disabled",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
],
"assignedOrganisations": [
{
"name": "string",
"id": "string"
}
],
"isSSOEnabled": true,
"userSsoSettings": [
{
"identity": "string",
"clientId": "string"
}
],
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| apiKey | string¦null | false | none | The API key associated with the user. |
| address | string¦null | false | none | The user's physical address. |
| postalAddress | string¦null | false | none | The user's postal address. |
| phoneNumber | string¦null | false | none | The user's primary phone number (optional). |
| faxNumber | string¦null | false | none | The user's fax number (optional). |
| failedLoginDate | string(date-time)¦null | false | none | The date and time of the last failed login attempt. |
| mfaType | string¦null | false | none | The user's Multi-Factor Authentication type. |
| accessRights | [UserAccessRight]¦null | false | none | A list of access rights granted to the user (up to 50 items). |
| assignedOrganisations | [UserOrganisation]¦null | false | none | A list of organisations assigned to the user (up to 200 items). |
| isSSOEnabled | boolean | false | none | Indicates whether Single Sign-On (SSO) is enabled for the user. |
| userSsoSettings | [UserSsoSettings]¦null | false | none | A list of SSO settings for the user. |
| id | integer(int32) | false | none | The unique identifier for the user account. |
| username | string¦null | false | none | The unique username for the user account. |
| firstName | string¦null | false | none | The user's first name. |
| lastName | string¦null | false | none | The user's last name. |
| role | UserRole¦null | false | none | The role assigned to the user. |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| status | string¦null | false | none | The current status of the user account. |
| creationDate | string(date-time)¦null | false | none | The date and time when the user account was created. |
| lastLoginDate | string(date-time)¦null | false | none | The date and time of the user's last successful login. |
| lastActiveDate | string(date-time)¦null | false | none | The date and time when the user was last active. |
| dateTimeZone | string¦null | false | none | The preferred datetime timezone for the user. |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
UserEditDetails
{
"apiKey": "API-KEY-123456789",
"mfaType": "Email",
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 0,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| apiKey | string¦null | false | none | New user's apiKey. This new value generated by reset-api-key API for this user and set here for assign to this user as new apiKey. |
| mfaType | string¦null | false | none | The user's Multi-Factor Authentication type (optional). |
| assignedOrganisations | [UserOrganisation0]¦null | false | none | A list of organisations assigned to the user (up to 200 items). |
| username | string | true | Length: 1 - undefined | The unique username for the user account. |
| firstName | string | true | Length: 1 - undefined | The user's first name. |
| lastName | string | true | Length: 1 - undefined | The user's last name. |
| string | true | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| address | string¦null | false | none | The user's physical address (optional). |
| postalAddress | string¦null | false | none | The user's postal address (if different from physical address). |
| phoneNumber | string¦null | false | none | The user's primary phone number (optional). |
| faxNumber | string¦null | false | none | The user's fax number (optional). |
| role | UserRole0 | true | none | The role assigned to the user. |
| accessRights | [UserAccessRight0]¦null | false | none | A list of access rights granted to the user (up to 50 items). |
| isSSOEnabled | boolean | false | none | Indicates whether Single Sign-On (SSO) is enabled for the user. |
| userSsoSettings | [UserSsoSettings]¦null | false | none | A list of SSO settings for the user (optional). |
Enumerated Values
| Property | Value |
|---|---|
| mfaType | Disabled |
| mfaType | |
| mfaType | VirtualMfaDevice |
UserInfo
{
"id": 0,
"username": "string",
"firstName": "string",
"lastName": "string",
"role": {
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
},
"email": "user@example.com",
"status": "Inactive",
"creationDate": "2019-08-24T14:15:22Z",
"lastLoginDate": "2019-08-24T14:15:22Z",
"lastActiveDate": "2019-08-24T14:15:22Z",
"dateTimeZone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique identifier for the user account. |
| username | string¦null | false | none | The unique username for the user account. |
| firstName | string¦null | false | none | The user's first name. |
| lastName | string¦null | false | none | The user's last name. |
| role | UserRole¦null | false | none | The role assigned to the user. |
| string¦null | false | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| status | string¦null | false | none | The current status of the user account. |
| creationDate | string(date-time)¦null | false | none | The date and time when the user account was created. |
| lastLoginDate | string(date-time)¦null | false | none | The date and time of the user's last successful login. |
| lastActiveDate | string(date-time)¦null | false | none | The date and time when the user was last active. |
| dateTimeZone | string¦null | false | none | The preferred datetime timezone for the user. |
Enumerated Values
| Property | Value |
|---|---|
| status | Inactive |
| status | Active |
| status | Deleted |
| status | Locked |
| status | Pending |
UserNewDetails
{
"username": "jsmith",
"firstName": "John",
"lastName": "Smith",
"email": "j@exfund.com",
"address": "123 User St, Sydney NSW 2000",
"postalAddress": "PO Box 123, Sydney NSW 2000",
"phoneNumber": "+61412345678",
"faxNumber": "+61291234568",
"role": {
"id": 1
},
"accessRights": [
{
"id": 1,
"allow": true
},
{
"id": 2,
"allow": true
}
],
"assignedOrganisations": [
{
"id": ""
}
],
"isSSOEnabled": false,
"userSsoSettings": [
{
"identity": "",
"clientId": ""
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| username | string | true | Length: 1 - undefined | The unique username for the user account. |
| firstName | string | true | Length: 1 - undefined | The user's first name. |
| lastName | string | true | Length: 1 - undefined | The user's last name. |
| string | true | Length: 0 - 125 Pattern: ^([a-zA... |
User email address. | |
| address | string¦null | false | none | The user's physical address (optional). |
| postalAddress | string¦null | false | none | The user's postal address (if different from physical address). |
| phoneNumber | string¦null | false | none | The user's primary phone number (optional). |
| faxNumber | string¦null | false | none | The user's fax number (optional). |
| role | UserRole0 | true | none | The role assigned to the user. |
| accessRights | [UserAccessRight0]¦null | false | none | A list of access rights granted to the user (up to 50 items). |
| assignedOrganisations | [UserOrganisation0] | true | none | A list of organisations assigned to the user (up to 200 items). |
| isSSOEnabled | boolean | false | none | Indicates whether Single Sign-On (SSO) is enabled for the user. |
| userSsoSettings | [UserSsoSettings]¦null | false | none | A list of SSO settings for the user (optional). |
UserNotification
{
"id": 0,
"name": "string",
"value": "string",
"type": "System",
"mode": "Note",
"creationDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"status": "New"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| value | string¦null | false | none | none |
| type | string¦null | false | none | none |
| mode | string¦null | false | none | none |
| creationDate | string(date-time)¦null | false | none | none |
| expiryDate | string(date-time)¦null | false | none | none |
| status | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | System |
| type | User |
| mode | Note |
| mode | Alert |
| mode | Banner |
| status | New |
| status | Read |
| status | Deleted |
UserOrganisation
{
"name": "string",
"id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | none | none |
| id | string¦null | false | none | none |
UserOrganisation0
{
"id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | Length: 1 - undefined | none |
UserRole
{
"id": 0,
"name": "string",
"label": "string",
"accessRights": [
{
"id": 0,
"name": "string",
"allow": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string¦null | false | none | none |
| label | string¦null | false | none | none |
| accessRights | [UserAccessRight]¦null | false | none | none |
UserRole0
{
"id": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | none |
UserSsoSettings
{
"identity": "string",
"clientId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identity | string¦null | false | none | none |
| clientId | string¦null | false | none | none |
ValidityItem
{
"source": "string",
"status": "ERROR"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | string¦null | false | none | none |
| status | string¦null | false | none | Represents the result of a performed check. - ERROR: Check was performed and result is negative. - OK: Check was performed and result is positive. - WAS_NOT_DONE: Check was not performed. |
Enumerated Values
| Property | Value |
|---|---|
| status | ERROR |
| status | OK |
| status | WAS_NOT_DONE |
ValueItem
{
"containerType": "DOCUMENT_IMAGE",
"fieldRect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
},
"originalSymbols": [
{
"code": "string",
"probability": 0,
"rect": {
"bottom": 0,
"left": 0,
"right": 0,
"top": 0
}
}
],
"originalValidity": 0,
"pageIndex": 0,
"probability": 0,
"source": "string",
"status": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| containerType | string¦null | false | none | Specifies the type of result container returned in the response. Each type corresponds to a specific data extraction or verification step. - DOCUMENT_IMAGE: Cropped/rotated document image with perspective compensation (ID: 1). - MRZ_TEXT: MRZ OCR results (ID: 3). - BARCODES: Raw information about barcodes (ID: 5). - VISUAL_GRAPHICS: Graphic fields from the Visual zone like signatures/photos (ID: 6). - MRZ_TEST_QUALITY: Result of the MRZ quality assessment (ID: 7). - DOCUMENT_TYPE_CANDIDATES: Potential document matches with probabilities (ID: 8). - DOCUMENT_TYPE: The finalized determined document type (ID: 9). - LEXICAL_ANALYSIS: Cross-source comparison (legacy; use TEXT) (ID: 15). - RAW_UNCROPPED_IMAGE: The original unedited input images (ID: 16). - VISUAL_TEXT: Data extracted from the visual zone (ID: 17). - BARCODE_TEXT: Text-based results from parsed barcodes (ID: 18). - BARCODE_GRAPHICS: Visual results from parsed barcodes (ID: 19). - AUTHENTICITY: Results of security and authenticity checks (ID: 20). - MAGNETIC_STRIPE_TEXT_DATA: Data from the magnetic stripe (ID: 26). - IMAGE_QUALITY: Detailed quality check of the input images (ID: 30). - LIVE_PORTRAIT: Data regarding the live portrait/selfie (ID: 32). - STATUS: Consolidated check statuses by source (ID: 33). - PORTRAIT_COMPARISON: Match results between document and live portraits (ID: 34). - EXT_PORTRAIT: Extended portrait/graphics info (ID: 35). - TEXT: Unified text fields with cross-source validation (ID: 36). - IMAGES: Unified image container for all sources (ID: 37). - FINGERPRINTS: Fingerprint data container (ID: 38). - FINGERPRINT_COMPARISON: Match results for fingerprints (ID: 39). - ENCRYPTED_RCL: Encrypted result data (ID: 49). - LICENSE: Current license status (ID: 50). - MRZ_POSITION: Coordinates for the MRZ area (ID: 61). - BARCODE_POSITION: Coordinates for the barcode area (ID: 62). - DOCUMENT_POSITION: Global coordinates, center, and angle of the document (ID: 85). - MRZ_DETECTOR: Low-level MRZ detection results (ID: 87). - FACE_DETECTION: Location and properties of faces in the image (ID: 97). - RFID_RAW_DATA: Unprocessed RFID chip data (ID: 101). - RFID_TEXT: Text extracted from the RFID chip (ID: 102). - RFID_GRAPHICS: Graphics extracted from the RFID chip (ID: 103). - RFID_BINARY_DATA: Binary files from the RFID chip (ID: 104). - RFID_ORIGINAL_GRAPHICS: Original uncompressed RFID graphics (ID: 105). - DTC_VC: Digital Travel Credential data (ID: 109). - MDL_PARSED_RESPONSE: Parsed mobile Driver's License response (ID: 121). - VDS_NC: Result of Visible Digital Seal for Non-Electronic Documents (ID: 124). - VDS: Result of Visible Digital Seal (ID: 125). |
| fieldRect | FieldRect¦null | false | none | none |
| originalSymbols | [OriginalSymbolDetail]¦null | false | none | none |
| originalValidity | integer(int32) | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| probability | integer(int32) | false | none | none |
| source | string¦null | false | none | none |
| status | string¦null | false | none | none |
| value | string¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| containerType | DOCUMENT_IMAGE |
| containerType | MRZ_TEXT |
| containerType | BARCODES |
| containerType | VISUAL_GRAPHICS |
| containerType | MRZ_TEST_QUALITY |
| containerType | DOCUMENT_TYPE_CANDIDATES |
| containerType | DOCUMENT_TYPE |
| containerType | LEXICAL_ANALYSIS |
| containerType | RAW_UNCROPPED_IMAGE |
| containerType | VISUAL_TEXT |
| containerType | BARCODE_TEXT |
| containerType | BARCODE_GRAPHICS |
| containerType | AUTHENTICITY |
| containerType | MAGNETIC_STRIPE_TEXT_DATA |
| containerType | IMAGE_QUALITY |
| containerType | LIVE_PORTRAIT |
| containerType | STATUS |
| containerType | PORTRAIT_COMPARISON |
| containerType | EXT_PORTRAIT |
| containerType | TEXT |
| containerType | IMAGES |
| containerType | FINGERPRINTS |
| containerType | FINGERPRINT_COMPARISON |
| containerType | ENCRYPTED_RCL |
| containerType | LICENSE |
| containerType | MRZ_POSITION |
| containerType | BARCODE_POSITION |
| containerType | DOCUMENT_POSITION |
| containerType | MRZ_DETECTOR |
| containerType | FACE_DETECTION |
| containerType | RFID_RAW_DATA |
| containerType | RFID_TEXT |
| containerType | RFID_GRAPHICS |
| containerType | RFID_BINARY_DATA |
| containerType | RFID_ORIGINAL_GRAPHICS |
| containerType | DTC_VC |
| containerType | MDL_PARSED_RESPONSE |
| containerType | VDS_NC |
| containerType | VDS |
VerificationResultError
{
"field": "string",
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string¦null | false | none | none |
| message | string¦null | false | none | none |
WebSearchResult
{
"title": "string",
"snippet": "string",
"mime": "string",
"link": "string",
"kind": "string",
"htmlTitle": "string",
"htmlSnippet": "string",
"htmlFormattedUrl": "string",
"formattedUrl": "string",
"fileFormat": "string",
"displayLink": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string¦null | false | none | none |
| snippet | string¦null | false | none | none |
| mime | string¦null | false | none | none |
| link | string¦null | false | none | none |
| kind | string¦null | false | none | none |
| htmlTitle | string¦null | false | none | none |
| htmlSnippet | string¦null | false | none | none |
| htmlFormattedUrl | string¦null | false | none | none |
| formattedUrl | string¦null | false | none | none |
| fileFormat | string¦null | false | none | none |
| displayLink | string¦null | false | none | none |