NAV Navbar
Logo
Shell HTTP JavaScript Ruby Python Java Go

MemberCheck API Reference v1

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

v7.3.12 Updated: Saturday March 13, 2021.

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://app.membercheck.net/api/v1/...

Demo URL: https://demo.membercheck.com/api/v1/...

Authentication

Authenticate your account when using the API by including your secret API key in the request. Your API keys are specific to the environment and are different on the DEMO and PRODUCTION systems. You can manage your API keys in your profile via the web application once logged in. 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.membercheck.com/api/v1/member-scans/single?pageIndex=1&pageSize=10
GET https://demo.membercheck.com/api/v1/member-scans/single?pageIndex=1&pageSize=10 HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
api-key: your-api-key
<script>
  $.ajax({
    url: 'https://demo.membercheck.com/api/v1/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.membercheck.com/api/v1/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.membercheck.com/api/v1/member-scans/single?pageIndex=1&pageSize=10', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single?pageIndex=1&pageSize=10', params={
  # TODO
})

print r.json()
URL obj = new URL("https://demo.membercheck.com/api/v1/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());

Schema

All API access is over HTTPS, and accessed from https://demo.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.

Member Scans

The member scans API methods allow you to manage member single and batch scans (get history, get a specific scan, perform new scan).

New Member Single Scan

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/member-scans/single \
  -H 'Content-Type: application/json' \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -d '{"matchType":"Exact","closeMatchRateThreshold":80,"whitelist":"Apply","residence":"ApplyPEP","blankAddress":"ApplyResidenceCountry","pepJurisdiction":"Apply","excludeDeceasedPersons":true,"memberNumber":"string","firstName":"string","middleName":"string","lastName":"string","originalScriptName":"string","gender":"string","dob":"string","address":"string","updateMonitoringList":false}'

POST https://demo.membercheck.com/api/v1/member-scans/single HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string

const inputBody = `{
  "matchType": "Exact",
  "closeMatchRateThreshold": 80,
  "whitelist": "Apply",
  "residence": "ApplyPEP",
  "blankAddress": "ApplyResidenceCountry",
  "pepJurisdiction": "Apply",
  "excludeDeceasedPersons": true,
  "memberNumber": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "originalScriptName": "string",
  "gender": "string",
  "dob": "string",
  "address": "string",
  "updateMonitoringList": false
}`;
const headers = {
  'Content-Type':'application/json',
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/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',
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

data = '{"matchType":"Exact","closeMatchRateThreshold":80,"whitelist":"Apply","residence":"ApplyPEP","blankAddress":"ApplyResidenceCountry","pepJurisdiction":"Apply","excludeDeceasedPersons":true,"memberNumber":"string","firstName":"string","middleName":"string","lastName":"string","originalScriptName":"string","gender":"string","dob":"string","address":"string","updateMonitoringList":false}'
result = RestClient.post 'https://demo.membercheck.com/api/v1/member-scans/single', data, headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

data = '{"matchType":"Exact","closeMatchRateThreshold":80,"whitelist":"Apply","residence":"ApplyPEP","blankAddress":"ApplyResidenceCountry","pepJurisdiction":"Apply","excludeDeceasedPersons":true,"memberNumber":"string","firstName":"string","middleName":"string","lastName":"string","originalScriptName":"string","gender":"string","dob":"string","address":"string","updateMonitoringList":false}'
r = requests.post('https://demo.membercheck.com/api/v1/member-scans/single', data = data, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/member-scans/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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": "Exact",
  "closeMatchRateThreshold": 80,
  "whitelist": "Apply",
  "residence": "ApplyPEP",
  "blankAddress": "ApplyResidenceCountry",
  "pepJurisdiction": "Apply",
  "excludeDeceasedPersons": true,
  "memberNumber": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "originalScriptName": "string",
  "gender": "string",
  "dob": "string",
  "address": "string",
  "updateMonitoringList": false
}
matchType: Exact
closeMatchRateThreshold: 80
whitelist: Apply
residence: ApplyPEP
blankAddress: ApplyResidenceCountry
pepJurisdiction: Apply
excludeDeceasedPersons: true
memberNumber: string
firstName: string
middleName: string
lastName: string
originalScriptName: string
gender: string
dob: string
address: string
updateMonitoringList: false

Parameters

Parameter 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 true 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

{
  "scanId": 0,
  "resultUrl": "string",
  "matchedNumber": 0,
  "matchedEntities": [
    {
      "resultId": 0,
      "uniqueId": 0,
      "monitoringStatus": "NewMatches",
      "category": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "matchRate": 0,
      "dob": "string",
      "primaryLocation": "string",
      "decisionDetail": {
        "text": "string",
        "matchDecision": "Match",
        "assessedRisk": "Unallocated",
        "comment": "string"
      }
    }
  ]
}

Responses

Code Status Description Schema
201 Created ScanResult: contains brief information of matched entities. The returned scanId should be used in GET /member-scans/single/{id} API method to obtain details of this scan. The returned matchedEntities.resultId of each matched entity should be used in GET /member-scans/single/results/{id} API method to obtain entity profile information. ScanResult
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Member Single Scans History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single?scanType=Single&matchType=Exact \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/member-scans/single HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single?scanType=Single&matchType=Exact',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single?scanType=Single&matchType=Exact', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single', params={
'scanType':'Single', 'matchType':'Exact'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/member-scans/single

Returns member scan history.

Member Scan - Scan History provides a record of all scans performed for the selected organisation.

Parameters

Parameter In Type Required Description
from query string(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
scanType query string false Scan Type. See supported values below.
matchType query string false Match Type. See supported values below.
whitelistPolicy query string false Whitelist Policy. See supported values below.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Monitoring update status (if available). 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.
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 Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelistPolicy Apply
whitelistPolicy Ignore
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
subCategory All
decision NotReviewed
decision Match
decision NoMatch
decision NotSure
decision All
risk High
risk Medium
risk Low
risk Unallocated
risk All
monitoringStatus NewMatches
monitoringStatus UpdatedMatches
monitoringStatus RemovedMatches
monitoringStatus NoChanges
monitoringStatus All

Example responses

200 Response

[
  {
    "date": "string",
    "scanType": "Batch",
    "matchType": "Exact",
    "whitelist": "Apply",
    "residence": "ApplyPEP",
    "blankAddress": "ApplyResidenceCountry",
    "pepJurisdiction": "Apply",
    "excludeDeceasedPersons": true,
    "scanId": 0,
    "matches": 0,
    "category": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "originalScriptName": "string",
    "dob": "string",
    "memberNumber": "string",
    "monitor": true,
    "monitoringStatus": "NewMatches"
  }
]

Responses

Code Status Description Schema
200 OK Array of ScanHistoryLog; lists the scan match results for the scans that you searched for. The returned scanId should be used in GET /member-scans/single/{id} API method to obtain details of each scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ScanHistoryLog] false none [Represents member scan history data.]
» date string true none Date of scan.
» scanType string true none Scan type.
» matchType string true none Match type scanned.
» whitelist string true none Whitelist policy used for scan.
» residence string true none Address policy used for scan.
» blankAddress string false none Blank address policy used for scan.
» pepJurisdiction string true none PEP jurisdiction used for scan.
» excludeDeceasedPersons boolean false none Exclude deceased persons policy used for 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) true none Number of matches found for the member.
» category string false none The categories the matched record belongs to, which can be one or a combination of the following: TER, PEP, SIP, RCA.
» firstName string false none The member first name scanned.
» middleName string false none The member middle name scanned (if available).
» lastName string false none The member last name scanned.
» originalScriptName string false none The member original script name scanned.
» dob string false none The member date of birth scanned.
» memberNumber string false none The member number scanned.
» monitor boolean false none Indicates if the member is being actively monitored.
» monitoringStatus string false none Indicates monitoring update status (if available).

Enumerated Values

Property Value
scanType Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelist Apply
whitelist Ignore
residence ApplyPEP
residence ApplySIP
residence ApplyRCA
residence ApplyAll
residence Ignore
blankAddress ApplyResidenceCountry
blankAddress Ignore
pepJurisdiction Apply
pepJurisdiction Ignore
monitoringStatus NewMatches
monitoringStatus UpdatedMatches
monitoringStatus RemovedMatches
monitoringStatus NoChanges
monitoringStatus All

Member Single Scans History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/report?scanType=Single&matchType=Exact \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'MemberScanHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/single/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/report?scanType=Single&matchType=Exact',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "MemberScanHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/report?scanType=Single&matchType=Exact', headers

File.open("MemberScanHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/report', params={
'scanType':'Single', 'matchType':'Exact'
}, headers = headers)

f = open('MemberScanHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
scanType query string false Scan Type. See supported values below.
matchType query string false Match Type. See supported values below.
whitelistPolicy query string false Whitelist Policy. See supported values below.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Monitoring update status (if available). See supported values below.
X-Request-OrgId header string false Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
format CSV
scanType Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelistPolicy Apply
whitelistPolicy Ignore
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Member Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/member-scans/single/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/{id}', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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": {
    "matchType": "Exact",
    "closeMatchRateThreshold": 80,
    "whitelist": "Apply",
    "residence": "ApplyPEP",
    "blankAddress": "ApplyResidenceCountry",
    "pepJurisdiction": "Apply",
    "excludeDeceasedPersons": true,
    "memberNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "originalScriptName": "string",
    "gender": "string",
    "dob": "string",
    "address": "string",
    "updateMonitoringList": false
  },
  "scanResult": {
    "scanId": 0,
    "resultUrl": "string",
    "matchedNumber": 0,
    "matchedEntities": [
      {
        "resultId": 0,
        "uniqueId": 0,
        "monitoringStatus": "NewMatches",
        "category": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "matchRate": 0,
        "dob": "string",
        "primaryLocation": "string",
        "decisionDetail": {
          "text": "string",
          "matchDecision": "Match",
          "assessedRisk": "Unallocated",
          "comment": "string"
        }
      }
    ]
  }
}

Responses

Code Status Description Schema
200 OK ScanHistoryDetail; details of the Scan Parameters used and member information that was scanned and lists Found Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /member-scans/single/results/{id} API method to obtain entity profile information. ScanHistoryDetail
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Single Scan Result Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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,
    "categories": "string",
    "subcategory": "string",
    "gender": "string",
    "deceased": "string",
    "primaryFirstName": "string",
    "primaryMiddleName": "string",
    "primaryLastName": "string",
    "title": "string",
    "position": "string",
    "dateOfBirth": "string",
    "deceasedDate": "string",
    "placeOfBirth": "string",
    "primaryLocation": "string",
    "image": "string",
    "generalInfo": {
      "property1": "string",
      "property2": "string"
    },
    "furtherInformation": "string",
    "xmlFurtherInformation": [
      {}
    ],
    "enterDate": "string",
    "lastReviewed": "string",
    "descriptions": [
      {
        "description1": "string",
        "description2": "string",
        "description3": "string"
      }
    ],
    "nameDetails": [
      {
        "nameType": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "title": "string"
      }
    ],
    "originalScriptNames": [
      "string"
    ],
    "roles": [
      {
        "title": "string",
        "type": "string",
        "status": "string",
        "country": "string",
        "from": "string",
        "to": "string"
      }
    ],
    "importantDates": [
      {
        "dateType": "string",
        "dateValue": "string"
      }
    ],
    "locations": [
      {
        "country": "string",
        "city": "string",
        "address": "string"
      }
    ],
    "countries": [
      {
        "countryType": "string",
        "countryValue": "string"
      }
    ],
    "officialLists": [
      {
        "keyword": "string",
        "category": "string",
        "description": "string",
        "country": "string",
        "isCurrent": true
      }
    ],
    "idNumbers": [
      {
        "type": "string",
        "idNotes": "string",
        "number": "string"
      }
    ],
    "sources": [
      {
        "url": "string",
        "categories": "string",
        "dates": "string",
        "cachedUrl": "string"
      }
    ],
    "linkedIndividuals": [
      {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "otherCategories": "string",
        "subcategories": "string",
        "description": "string"
      }
    ],
    "linkedCompanies": [
      {
        "name": "string",
        "categories": "string",
        "subcategories": "string",
        "description": "string"
      }
    ]
  }
}

Responses

Code Status Description Schema
200 OK SingleScanResultDetail; Entity’s Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. SingleScanResultDetail
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Single Scan Result Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'PersonDetailReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "PersonDetailReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report', headers

File.open("PersonDetailReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report', headers = headers)

f = open('PersonDetailReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The result id of a specific matched member. The GET /member-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

New Member Batch Scan

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/member-scans/batch \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'
  -F param='{"matchType":"Exact","whitelist":"Apply","pepJurisdiction":"Apply","residence":"ApplyAll"}' \
  -F file=@your-file-path

POST https://demo.membercheck.com/api/v1/member-scans/batch HTTP/1.1
Host: demo.membercheck.com
Content-Type: multipart/form-data
Accept: application/json
X-Request-OrgId: string

const headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
};

let formData = new FormData();
formData.append('param', JSON.stringify(jsonParams)); // e.g. param='{"matchType":"Exact","whitelist":"Apply","pepJurisdiction":"Apply","residence":"ApplyAll"}'
formData.append('file', document.getElementById('file-input-id').files[0]);

fetch('https://demo.membercheck.com/api/v1/member-scans/batch',
{
  method: 'POST',
  body: formData,
  headers: headers
})
.then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

data = {
  multipart: true,
  file: File.new('sample_batch_standard.csv', 'rt'),
  param: '{"matchType":"Exact","whitelist":"Apply","pepJurisdiction":"Apply","residence":"ApplyAll"}'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/member-scans/batch', data, headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

data = {'param': '{"matchType":"Exact","whitelist":"Apply","pepJurisdiction":"Apply","residence":"ApplyAll"}'}
files = {'file': ('sample_batch_standard.csv', open('sample_batch_standard.csv', 'rb'), 'text/csv')}

r = requests.post('https://demo.membercheck.com/api/v1/member-scans/batch', data = data, files = files, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/member-scans/batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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

file: string

Parameters

Parameter 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 string true 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.
» file body string(binary) true Batch file containing members.

Example responses

201 Response

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

Responses

Code Status Description Schema
201 Created BatchScanResult; contains batch scan identifier. The returned batchScanId should be used in GET /member-scans/batch/{id} API method to obtain details of this batch scan. BatchScanResult
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Member Batch Scans History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch?from=01/01/2020 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/member-scans/batch HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/batch?from=01/01/2020',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch?from=01/01/2020', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch', params={
'from':'01/01/2020'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
from query string(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date 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.
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": "string",
    "fileName": "string",
    "membersScanned": 0,
    "matchedMembers": 0,
    "numberOfMatches": 0,
    "status": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of BatchScanHistoryLog; lists the batch files that have been uploaded and includes Date and time, File name, Number of Members Scanned, Number of Matched Members, Total Number of Matches and Status of the scan. The returned batchScanId should be used in GET /member-scans/batch/{id} API method to obtain details of each batch scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BatchScanHistoryLog] false none [Represents details of the member batch files, which have been uploaded and scanned.]
» batchScanId integer(int32) false none The identifier of the batch scan. It should be used when requesting the GET /member-scans/batch/{id} API method to get details of this member batch scan.
» date string false none Date and time of the upload.
» fileName string 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 false none Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled.

Member Batch Scans History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch/report?from=01/01/2020 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'MemberBatchScanHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/batch/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/batch/report?from=01/01/2020',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "MemberBatchScanHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch/report?from=01/01/2020', headers

File.open("MemberBatchScanHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch/report', params={
'from':'01/01/2020'
}, headers = headers)

f = open('MemberBatchScanHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date 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.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Member Batch Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/member-scans/batch/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query 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.

Enumerated Values

Parameter Value
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
subCategory All
decision NotReviewed
decision Match
decision NoMatch
decision NotSure
decision All
risk High
risk Medium
risk Low
risk Unallocated
risk All

Example responses

200 Response

{
  "organisation": "string",
  "user": "string",
  "matchType": "Exact",
  "closMatchRateThreshold": 0,
  "whitelist": "Apply",
  "residence": "ApplyPEP",
  "blankAddress": "ApplyResidenceCountry",
  "pepJurisdiction": "Apply",
  "excludeDeceasedPersons": true,
  "categoryResults": [
    {
      "category": "string",
      "matchedMembers": 0,
      "numberOfMatches": 0
    }
  ],
  "watchlistsScanned": [
    "string"
  ],
  "matchedEntities": [
    {
      "scanId": 0,
      "matches": 0,
      "category": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "originalScriptName": "string",
      "dob": "string",
      "memberNumber": "string",
      "monitor": true,
      "monitoringStatus": "NewMatches"
    }
  ],
  "batchScanId": 0,
  "date": "string",
  "fileName": "string",
  "membersScanned": 0,
  "matchedMembers": 0,
  "numberOfMatches": 0,
  "status": "string"
}

Responses

Code Status Description Schema
200 OK BatchScanResults; lists the batch scan results and a list of matched members. The returned matchedEntities.scanId should be used in GET /member-scans/single/{id} API method to obtain details of each member scan of this batch. BatchScanResults
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Batch Scan Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'MemberBatchScanDetailsReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "MemberBatchScanDetailsReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report', headers

File.open("MemberBatchScanDetailsReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report', headers = headers)

f = open('MemberBatchScanDetailsReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Batch Scan Exception Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/exception-report \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/exception-report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch/{id}/exception-report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch/{id}/exception-report', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch/{id}/exception-report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Batch Scan Full Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/full-report \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/member-scans/batch/{id}/full-report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/batch/{id}/full-report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/batch/{id}/full-report', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/batch/{id}/full-report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Monitoring History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/member-scans/monitoring HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/monitoring', params={
'scanResult':'AllMonitoringScans', 'pageIndex':'0', 'pageSize':'10'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/monitoring", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
from query string(date-time) false The date from when the monitoring scan was run (DD/MM/YYYY).
to query string(date-time) 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.
pageIndex query integer(int32) false The page index of results.
pageSize query integer(int32) false The number of items or results per page.
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

Example responses

200 Response

[
  {
    "monitoringScanId": 0,
    "date": "string",
    "totalMembersMonitored": 0,
    "membersChecked": 0,
    "newMatches": 0,
    "updatedEntities": 0,
    "removedMatches": 0,
    "status": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of MonitoringScanHistoryLog; lists the monitoring scans that have been done and includes Date, Total Members Monitored, Members Checked, New Matches, Updated Entities, Removed Matches and Status of the scan. The returned monitoringScanId should be used in GET /member-scans/monitoring/{id} API method to obtain details of each monitoring scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MonitoringScanHistoryLog] false none [Represents details of the automated member monitoring scan.]
» monitoringScanId integer(int32) false none The identifier of the monitoring scan activity. This should be used when requesting the GET /member-scans/monitoring/{id} API method to get details of this member monitoring scan.
» date string false none Date the monitoring scan was run.
» totalMembersMonitored integer(int32) false none Total number of members being actively monitored in the monitoring list.
» membersChecked integer(int32) false none Number of members in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.
» 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 false none Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error.

Member Monitoring History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/monitoring/report?scanResult=AllMonitoringScans \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'MemberMonitoringHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/monitoring/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/monitoring/report?scanResult=AllMonitoringScans',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "MemberMonitoringHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/monitoring/report?scanResult=AllMonitoringScans', headers

File.open("MemberMonitoringHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/monitoring/report', params={
'scanResult':'AllMonitoringScans'
}, headers = headers)

f = open('MemberMonitoringHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/monitoring/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false The date from when the monitoring scan was run (DD/MM/YYYY).
to query string(date-time) 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.
X-Request-OrgId header string false Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
scanResult MonitoringWithUpdates
scanResult AllMonitoringScans

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Member Monitoring Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/monitoring/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/member-scans/monitoring/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query 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.

Enumerated Values

Parameter Value
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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",
  "matchType": "Exact",
  "closMatchRateThreshold": 0,
  "residence": "ApplyPEP",
  "pepJurisdiction": "Apply",
  "categoryResults": [
    {
      "category": "string",
      "matchedMembers": 0,
      "numberOfMatches": 0
    }
  ],
  "watchlistsScanned": [
    "string"
  ],
  "entities": [
    {
      "scanId": 0,
      "matches": 0,
      "category": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "originalScriptName": "string",
      "dob": "string",
      "memberNumber": "string",
      "monitor": true,
      "monitoringStatus": "NewMatches"
    }
  ],
  "monitoringScanId": 0,
  "date": "string",
  "totalMembersMonitored": 0,
  "membersChecked": 0,
  "newMatches": 0,
  "updatedEntities": 0,
  "removedMatches": 0,
  "status": "string"
}

Responses

Code Status Description Schema
200 OK MonitoringScanResults; lists the monitoring scan results and a list of matched members. The returned entities.scanId should be used in GET /member-scans/single/{id} API method to obtain details of each member scan of this monitoring scan. MonitoringScanResults
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Monitoring Scan Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'MemberMonitoringScanDetailsReport.pdf'

GET https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "MemberMonitoringScanDetailsReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report', headers

File.open("MemberMonitoringScanDetailsReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report', headers = headers)

f = open('MemberMonitoringScanDetailsReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/monitoring/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIP subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Outcome of the monitoring status of the scan result. See supported values below.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category PEP
category SIP
category RCA
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Enable Member Scan Monitoring

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/enable \
  -H 'Api-Key: your-api-key'

POST https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/enable HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/enable', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.post('https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/enable', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/enable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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 Member Number already exists in the Monitoring List, this will replace the existing member in the Monitoring List. Member Numbers for members must be unique as this will replace any existing member with the same Member Number in the Monitoring List.

Parameters

Parameter 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

204 Response

{}

Responses

Code Status Description Schema
204 No Content Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Disable Member Scan Monitoring

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/disable \
  -H 'Api-Key: your-api-key'

POST https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/disable HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/disable', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.post('https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/disable', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/member-scans/single/{id}/monitor/disable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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

Parameter 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

204 Response

{}

Responses

Code Status Description Schema
204 No Content Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Member Linked Individual Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0 \
  -H 'Accept: application/json'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0',
{
  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.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}',
  params: {
  'individualId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}', params={
  'individualId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query 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,
  "categories": "string",
  "subcategory": "string",
  "gender": "string",
  "deceased": "string",
  "primaryFirstName": "string",
  "primaryMiddleName": "string",
  "primaryLastName": "string",
  "title": "string",
  "position": "string",
  "dateOfBirth": "string",
  "deceasedDate": "string",
  "placeOfBirth": "string",
  "primaryLocation": "string",
  "image": "string",
  "generalInfo": {
    "property1": "string",
    "property2": "string"
  },
  "furtherInformation": "string",
  "xmlFurtherInformation": [
    {}
  ],
  "enterDate": "string",
  "lastReviewed": "string",
  "descriptions": [
    {
      "description1": "string",
      "description2": "string",
      "description3": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "title": "string"
    }
  ],
  "originalScriptNames": [
    "string"
  ],
  "roles": [
    {
      "title": "string",
      "type": "string",
      "status": "string",
      "country": "string",
      "from": "string",
      "to": "string"
    }
  ],
  "importantDates": [
    {
      "dateType": "string",
      "dateValue": "string"
    }
  ],
  "locations": [
    {
      "country": "string",
      "city": "string",
      "address": "string"
    }
  ],
  "countries": [
    {
      "countryType": "string",
      "countryValue": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "country": "string",
      "isCurrent": true
    }
  ],
  "idNumbers": [
    {
      "type": "string",
      "idNotes": "string",
      "number": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "dates": "string",
      "cachedUrl": "string"
    }
  ],
  "linkedIndividuals": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "otherCategories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "id": 0,
      "name": "string",
      "categories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ]
}

Responses

Code Status Description Schema
200 OK Entity’s Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Linked Individual Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0 \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report',
  params: {
  'individualId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report', params={
  'individualId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-individuals/{individualid}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query integer(int32) true The identifier of a specific linked individual of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedIndividuals.id.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Linked Company Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}?companyId=0 \
  -H 'Accept: application/json'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}?companyId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}?companyId=0',
{
  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.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}',
  params: {
  'companyId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}', params={
  'companyId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}?companyId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query 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,
  "categories": "string",
  "subcategory": "string",
  "primaryName": "string",
  "primaryLocation": "string",
  "generalInfo": {
    "property1": "string",
    "property2": "string"
  },
  "furtherInformation": "string",
  "xmlFurtherInformation": [
    {}
  ],
  "enterDate": "string",
  "lastReviewed": "string",
  "descriptions": [
    {
      "description1": "string",
      "description2": "string",
      "description3": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "entityName": "string"
    }
  ],
  "originalScriptNames": [
    "string"
  ],
  "locations": [
    {
      "country": "string",
      "city": "string",
      "address": "string"
    }
  ],
  "countries": [
    {
      "countryType": "string",
      "countryValue": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "country": "string",
      "isCurrent": true
    }
  ],
  "idNumbers": [
    {
      "type": "string",
      "idNotes": "string",
      "number": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "dates": "string",
      "cachedUrl": "string"
    }
  ],
  "linkedIndividuals": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "otherCategories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "id": 0,
      "name": "string",
      "categories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ]
}

Responses

Code Status Description Schema
200 OK Entity’s Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. EntityCorp
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Linked Company Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0 \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report',
  params: {
  'companyId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report', params={
  'companyId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/linked-companies/{companyid}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query integer(int32) true The identifier of a specific linked company of a matched member. The GET /member-scans/single/results/{id} API method response class returns this identifier in person.linkedCompanies.id.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Member Due Diligence History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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": "2020-06-30T06:30:00Z",
    "comment": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of DecisionHistory; lists the due diligence decisions for a person selected in the scan results or scan history. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DecisionHistory] false none [Returns the due diligence decisions for a person or corporate entity.]
» username string false none The user who recorded the decision.
» date string(date-time) false none The date and time of decision.
» comment string false none Additional comment entered with the decision.

New Member Due Diligence Decision

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions \
  -H 'Content-Type: application/json' \
  -d '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}'

POST https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json

const inputBody = `{
  "matchDecision": "Match",
  "assessedRisk": "Unallocated",
  "comment": "string"
}`;
const headers = {
  'Content-Type':'application/json',
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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',
  'Api-Key' => 'your-api-key'
}

data = '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}';
result = RestClient.post 'https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions', data, headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Api-Key': 'your-api-key'
}

data = '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}'; 
r = requests.post('https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions', data = data, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/member-scans/single/results/{id}/decisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/member-scans/single/results/{id}/decisions

Adds a due diligence decision for a matched person.

Member Scan - Due Diligence Decision You are able to input due diligence decisions for a person selected in the Scan Results, or a Found Entity selected from the Scan History Log.

Body parameter

{
  "matchDecision": "Match",
  "assessedRisk": "Unallocated",
  "comment": "string"
}
matchDecision: Match
assessedRisk: Unallocated
comment: string

Parameters

Parameter 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 true Due Diligence Decision parameters, which include decision, risk and comment.

Example responses

201 Response

{}

Responses

Code Status Description Schema
201 Created Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Corporate Scans

The corp-scans API methods allow you to manage corporate single and batch scans (get history, get a specific scan, perform new scan).

New Corporate Single Scan

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/corp-scans/single \
  -H 'Content-Type: application/json' \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -d '{"matchType":"Exact","whitelist":"Apply","companyName":"string","idNumber":"string","entityNumber":"string","address":"string","updateMonitoringList":false}"

POST https://demo.membercheck.com/api/v1/corp-scans/single HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string

const inputBody = `{
  "matchType": "Exact",
  "whitelist": "Apply",
  "companyName": "string",
  "idNumber": "string",
  "entityNumber": "string",
  "address": "string",
  "updateMonitoringList": false
}`;
const headers = {
  'Content-Type':'application/json',
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/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',
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

data = '{"matchType":"Exact","whitelist":"Apply","companyName":"string","idNumber":"string","entityNumber":"string","address":"string","updateMonitoringList":false}'
result = RestClient.post 'https://demo.membercheck.com/api/v1/corp-scans/single', data, headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

data = '{"matchType":"Exact","whitelist":"Apply","companyName":"string","idNumber":"string","entityNumber":"string","address":"string","updateMonitoringList":false}'
r = requests.post('https://demo.membercheck.com/api/v1/corp-scans/single', data = data, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/corp-scans/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/corp-scans/single

Performs new corporate single scan.

Corporate Scan - Scan New allows you to scan companies.

Body parameter

{
  "matchType": "Exact",
  "whitelist": "Apply",
  "companyName": "string",
  "idNumber": "string",
  "entityNumber": "string",
  "address": "string",
  "updateMonitoringList": false
}
matchType: Exact
whitelist: Apply
companyName: string
idNumber: string
entityNumber: string
address: string
updateMonitoringList: false

Parameters

Parameter 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 true 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

{
  "scanId": 0,
  "resultUrl": "string",
  "matchedNumber": 0,
  "matchedEntities": [
    {
      "resultId": 0,
      "uniqueId": 0,
      "monitoringStatus": "NewMatches",
      "category": "string",
      "name": "string",
      "primaryLocation": "string",
      "decisionDetail": {
        "text": "string",
        "matchDecision": "Match",
        "assessedRisk": "Unallocated",
        "comment": "string"
      }
    }
  ]
}

Responses

Code Status Description Schema
201 Created CorpScanResult; contains brief information of matched entities. The returned scanId should be used in GET /corp-scans/single/{id} API method to obtain details of this scan. The returned matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. CorpScanResult
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Corporate Single Scans History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single?scanType=Single&matchType=Exact \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/corp-scans/single HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single?scanType=Single&matchType=Exact',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single?scanType=Single&matchType=Exact', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single', params={
'scanType':'Single', 'matchType':'Exact'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/corp-scans/single

Returns corporate scan history.

Corporate Scan - Scan History provides a record of all scans performed for the selected organisation.

Parameters

Parameter In Type Required Description
from query string(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date to (DD/MM/YYYY).
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
scanType query string false Scan Type. See supported values below.
matchType query string false Match Type. See supported values below.
whitelistPolicy query string false Whitelist Policy. See supported values below.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Monitoring update status (if available).
pageIndex query integer(int32) false The page index of results.
pageSize query integer(int32) false The number of items or results per page.
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 Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelistPolicy Apply
whitelistPolicy Ignore
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
subCategory All
decision NotReviewed
decision Match
decision NoMatch
decision NotSure
decision All
risk High
risk Medium
risk Low
risk Unallocated
risk All
monitoringStatus NewMatches
monitoringStatus UpdatedMatches
monitoringStatus RemovedMatches
monitoringStatus NoChanges
monitoringStatus All

Example responses

200 Response

[
  {
    "date": "string",
    "scanType": "Batch",
    "matchType": "Exact",
    "whitelist": "Apply",
    "scanId": 0,
    "matches": 0,
    "category": "string",
    "companyName": "string",
    "idNumber": "string",
    "entityNumber": "string",
    "monitor": true,
    "monitoringStatus": "NewMatches"
  }
]

Responses

Code Status Description Schema
200 OK Array of CorpScanHistoryLog; lists the scan match results for the scans that you searched for. The returned scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CorpScanHistoryLog] false none [Represents corporate scan history data.]
» date string false none Date of scan.
» scanType string false none Scan type. See supported values below.
» matchType string false none Match type scanned. See supported values below.
» whitelist string false none Whitelist policy scanned.
» 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.
» category string false none The categories the matched record belongs to, which can be one of the following: SIE, SIE/TER.
» companyName string false none The company name scanned.
» idNumber string false none The company registration/ID number scanned.
» entityNumber string false none The company entity number scanned.
» monitor boolean false none Indicates if the company is being actively monitored.
» monitoringStatus string false none Indicates monitoring update status (if available).

Enumerated Values

Property Value
scanType Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelist Apply
whitelist Ignore
monitoringStatus NewMatches
monitoringStatus UpdatedMatches
monitoringStatus RemovedMatches
monitoringStatus NoChanges
monitoringStatus All

Corporate Single Scans History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/report?scanType=Single&matchType=Exact \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'CorpScanHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/single/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/report?scanType=Single&matchType=Exact',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpScanHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/report?scanType=Single&matchType=Exact', headers

File.open("CorpScanHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/report', params={
'scanType':'Single', 'matchType':'Exact'
}, headers = headers)

f = open('CorpScanHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date to (DD/MM/YYYY).
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
scanType query string false Scan Type. See supported values below.
matchType query string false Match Type. See supported values below.
whitelistPolicy query string false Whitelist Policy. See supported values below.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Monitoring update status (if available).
X-Request-OrgId header string false Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
format CSV
scanType Batch
scanType Single
scanType Automatic
matchType Exact
matchType ExactMidName
matchType Close
whitelistPolicy Apply
whitelistPolicy Ignore
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Corporate Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/corp-scans/single/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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": {
    "matchType": "Exact",
    "whitelist": "Apply",
    "companyName": "string",
    "idNumber": "string",
    "entityNumber": "string",
    "address": "string",
    "updateMonitoringList": false
  },
  "scanResult": {
    "scanId": 0,
    "resultUrl": "string",
    "matchedNumber": 0,
    "matchedEntities": [
      {
        "resultId": 0,
        "uniqueId": 0,
        "monitoringStatus": "NewMatches",
        "category": "string",
        "name": "string",
        "primaryLocation": "string",
        "decisionDetail": {
          "text": "string",
          "matchDecision": "Match",
          "assessedRisk": "Unallocated",
          "comment": "string"
        }
      }
    ]
  }
}

Responses

Code Status Description Schema
200 OK CorpScanHistoryDetail; details of the Company information that was scanned and lists Entities that were identified from the Watchlists as possible matches. The returned scanResult.matchedEntities.resultId of each matched entity should be used in GET /corp-scans/single/results/{id} API method to obtain entity profile information. CorpScanHistoryDetail
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Single Scan Result Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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,
    "categories": "string",
    "subcategory": "string",
    "primaryName": "string",
    "primaryLocation": "string",
    "generalInfo": {
      "property1": "string",
      "property2": "string"
    },
    "furtherInformation": "string",
    "xmlFurtherInformation": [
      {}
    ],
    "enterDate": "string",
    "lastReviewed": "string",
    "descriptions": [
      {
        "description1": "string",
        "description2": "string",
        "description3": "string"
      }
    ],
    "nameDetails": [
      {
        "nameType": "string",
        "entityName": "string"
      }
    ],
    "originalScriptNames": [
      "string"
    ],
    "locations": [
      {
        "country": "string",
        "city": "string",
        "address": "string"
      }
    ],
    "countries": [
      {
        "countryType": "string",
        "countryValue": "string"
      }
    ],
    "officialLists": [
      {
        "keyword": "string",
        "category": "string",
        "description": "string",
        "country": "string",
        "isCurrent": true
      }
    ],
    "idNumbers": [
      {
        "type": "string",
        "idNotes": "string",
        "number": "string"
      }
    ],
    "sources": [
      {
        "url": "string",
        "categories": "string",
        "dates": "string",
        "cachedUrl": "string"
      }
    ],
    "linkedIndividuals": [
      {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "otherCategories": "string",
        "subcategories": "string",
        "description": "string"
      }
    ],
    "linkedCompanies": [
      {
        "name": "string",
        "categories": "string",
        "subcategories": "string",
        "description": "string"
      }
    ]
  }
}

Responses

Code Status Description Schema
200 OK SingleScanCorpResultDetail; Entity’s Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. SingleScanCorpResultDetail
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Single Scan Result Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'CorpDetailReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpDetailReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report', headers

File.open("CorpDetailReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report', headers = headers)

f = open('CorpDetailReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The result id of a specific matched company. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

New Corporate Batch Scan

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/corp-scans/batch \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -F param='{"matchType":"Exact","whitelist":"Apply"}' \
  -F file=@your-file-path

POST https://demo.membercheck.com/api/v1/corp-scans/batch HTTP/1.1
Host: demo.membercheck.com
Content-Type: multipart/form-data
Accept: application/json
X-Request-OrgId: string

const headers = {
  'api-key': 'your-api-key',
  'X-Request-OrgId':'string'
};

const formData = new FormData();
formData.append('param', JSON.stringify(jsonParams)); // e.g. param='{"matchType":"Exact","whitelist":"Apply"}'
formData.append('file', document.getElementById('file-input-id').files[0]);

fetch('https://demo.membercheck.com/api/v1/corp-scans/batch',
{
  method: 'POST',
  body: formData,
  headers: headers
})
.then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

data = {
  multipart: true,
  file: File.new('sample_batch_standard.csv', 'rt'),
  param: '{"matchType":"Exact","whitelist":"Apply"}'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/corp-scans/batch', data, headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

data = {'param': '{"matchType":"Exact","whitelist":"Apply"}'}
files = {'file': ('sample_batch_standard.csv', open('sample_batch_standard.csv', 'rb'), 'text/csv')}

r = requests.post('https://demo.membercheck.com/api/v1/corp-scans/batch', data = data, files = files, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/corp-scans/batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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

file: string

Parameters

Parameter 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 string true Scan parameters, which include match type and whitelist policy, are applied to each scan.
» file body string(binary) true Batch file containing companies.

Example responses

201 Response

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

Responses

Code Status Description Schema
201 Created BatchScanResult: contains batch scan identifier. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of this batch scan. BatchScanResult
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Corporate Batch Scans History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch?from=01/01/2020 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/corp-scans/batch HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/batch?from=01/01/2020',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch?from=01/01/2020', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch', params={
'from':'01/01/2020'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
from query string(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date 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.
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": "string",
    "fileName": "string",
    "companiesScanned": 0,
    "matchedCompanies": 0,
    "numberOfMatches": 0,
    "status": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of CorpBatchScanHistoryLog; lists the batch files that have been uploaded and includes Date and time, File name, Number of Companies Scanned, Number of Matched Companies, Total Number of Matches and Status of the scan. The returned batchScanId should be used in GET /corp-scans/batch/{id} API method to obtain details of each batch scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CorpBatchScanHistoryLog] false none [Represents details of the batch files, which have been uploaded and scanned.]
» batchScanId integer(int32) false none The identifier of the batch scan. It should be used when requesting the GET /corp-scans/batch/{id} API method to get details of the corporate batch scan.
» date string false none Date and time of the upload.
» fileName string 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 false none Status of the scan - Uploaded, Completed, Completed with errors, In Progress, Error or Cancelled.

Corporate Batch Scans History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch/report?from=01/01/2020 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'CorpBatchScanHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/batch/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/batch/report?from=01/01/2020',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpBatchScanHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch/report?from=01/01/2020', headers

File.open("CorpBatchScanHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch/report', params={
'from':'01/01/2020'
}, headers = headers)

f = open('CorpBatchScanHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false Scan date from (DD/MM/YYYY).
to query string(date-time) false Scan date 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.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Corporate Batch Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId.
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query 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.

Enumerated Values

Parameter Value
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
subCategory All
decision NotReviewed
decision Match
decision NoMatch
decision NotSure
decision All
risk High
risk Medium
risk Low
risk Unallocated
risk All

Example responses

200 Response

{
  "organisation": "string",
  "user": "string",
  "matchType": "Exact",
  "whitelist": "Apply",
  "categoryResults": [
    {
      "category": "string",
      "matchedCompanies": 0,
      "numberOfMatches": 0
    }
  ],
  "watchlistsScanned": [
    "string"
  ],
  "matchedEntities": [
    {
      "scanId": 0,
      "matches": 0,
      "category": "string",
      "companyName": "string",
      "idNumber": "string",
      "entityNumber": "string",
      "monitor": true,
      "monitoringStatus": "NewMatches"
    }
  ],
  "batchScanId": 0,
  "date": "string",
  "fileName": "string",
  "companiesScanned": 0,
  "matchedCompanies": 0,
  "numberOfMatches": 0,
  "status": "string"
}

Responses

Code Status Description Schema
200 OK CorpBatchScanResults; lists the batch scan results and a list of matched companies. The returned matchedEntities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each company scan of this batch. CorpBatchScanResults
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Batch Scan Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'CorpBatchScanDetailsReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpBatchScanDetailsReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report', headers

File.open("CorpBatchScanDetailsReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report', headers = headers)

f = open('CorpBatchScanDetailsReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The identifier of a specific corporate batch scan. The GET /corp-scans/batch or POST /corp-scans/batch API method response class returns this identifier in batchScanId.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Batch Scan Exception Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/exception-report \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/exception-report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/exception-report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/exception-report', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/exception-report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Batch Scan Full Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/full-report \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/full-report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/full-report',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/full-report', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/batch/{id}/full-report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Monitoring History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10 \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/corp-scans/monitoring HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/monitoring?scanResult=AllMonitoringScans&pageIndex=0&pageSize=10', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/monitoring', params={
'scanResult':'AllMonitoringScans', 'pageIndex':'0', 'pageSize':'10'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/monitoring", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
from query string(date-time) false The date from when the monitoring scan was run (DD/MM/YYYY).
to query string(date-time) 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.
pageIndex query integer(int32) false The page index of results.
pageSize query integer(int32) false The number of items or results per page.
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

Example responses

200 Response

[
  {
    "monitoringScanId": 0,
    "date": "string",
    "totalCompaniesMonitored": 0,
    "companiesChecked": 0,
    "newMatches": 0,
    "updatedEntities": 0,
    "removedMatches": 0,
    "status": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of CorpMonitoringScanHistoryLog; lists the monitoring scans that have been done and includes Date, Total Companies Monitored, Companies Checked, New Matches, Updated Entities, Removed Matches and Status of the scan. The returned monitoringScanId should be used in GET /corp-scans/monitoring/{id} API method to obtain details of each monitoring scan. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CorpMonitoringScanHistoryLog] false none [Represents details of the automated corporate monitoring scan.]
» monitoringScanId integer(int32) false none The identifier of the monitoring scan activity. This should be used when requesting the GET /corp-scans/monitoring/{id} API method to get details of this corporate monitoring scan.
» date string false none Date the monitoring scan was run.
» totalCompaniesMonitored integer(int32) false none Total number of companies being actively monitored in the monitoring list.
» companiesChecked integer(int32) false none Number of companies in the monitoring list flagged based on preliminary changes detected in the watchlist. This is a preliminary check and may vary from the actual New Matches, Updated Matches and Removed Matches found.
» 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 false none Status of the monitoring scan. The following statuses are applicable - Uploaded, Completed, Completed with errors, In Progress, or Error.

Corporate Monitoring History Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/report?scanResult=AllMonitoringScans \
  -H 'Api-Key: your-api-key' \
  -H 'X-Request-OrgId: string' \
  -o 'CorpMonitoringHistoryReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream
X-Request-OrgId: string


const headers = {
  'Api-Key':'your-api-key',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/monitoring/report?scanResult=AllMonitoringScans',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpMonitoringHistoryReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key',
  'X-Request-OrgId' => 'string'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/monitoring/report?scanResult=AllMonitoringScans', headers

File.open("MemberMonitoringHistoryReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/monitoring/report', params={
'scanResult':'AllMonitoringScans'
}, headers = headers)

f = open('CorpMonitoringHistoryReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
        "X-Request-OrgId": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/monitoring/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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(date-time) false The date from when the monitoring scan was run (DD/MM/YYYY).
to query string(date-time) 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.
X-Request-OrgId header string false Unique organisation identifier. This is optional and your default organisation will be used if not specified. You can specify the relevant Organisation ID if you are assigned to multiple organisations.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
scanResult MonitoringWithUpdates
scanResult AllMonitoringScans

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Corporate Monitoring Scan Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id} \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id} HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId.
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query 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.

Enumerated Values

Parameter Value
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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",
  "matchType": "Exact",
  "categoryResults": [
    {
      "category": "string",
      "matchedCompanies": 0,
      "numberOfMatches": 0
    }
  ],
  "watchlistsScanned": [
    "string"
  ],
  "entities": [
    {
      "scanId": 0,
      "matches": 0,
      "category": "string",
      "companyName": "string",
      "idNumber": "string",
      "entityNumber": "string",
      "monitor": true,
      "monitoringStatus": "NewMatches"
    }
  ],
  "monitoringScanId": 0,
  "date": "string",
  "totalCompaniesMonitored": 0,
  "companiesChecked": 0,
  "newMatches": 0,
  "updatedEntities": 0,
  "removedMatches": 0,
  "status": "string"
}

Responses

Code Status Description Schema
200 OK CorpMonitoringScanResults; lists the monitoring scan results and a list of matched corporates. The returned entities.scanId should be used in GET /corp-scans/single/{id} API method to obtain details of each corporate scan of this monitoring scan. CorpMonitoringScanResults
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Monitoring Scan Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report \
  -H 'Api-Key: your-api-key' \
  -o 'CorpMonitoringScanDetailsReport.pdf'

GET https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.blob();
}).then(function(body) {
    let url = window.URL.createObjectURL(body);
    let anchor = document.createElement('a');
    anchor.href = url;
    anchor.download = "CorpMonitoringScanDetailsReport.pdf";
    document.body.appendChild(anchor);
    anchor.click();
    anchor.remove();
});

require 'rest-client'

headers = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report', headers

File.open("CorpMonitoringScanDetailsReport.pdf", "wb") do |f|
  f.write(result.body)
end

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report', headers = headers)

f = open('CorpMonitoringScanDetailsReport.pdf', 'wb')
f.write(r.content)
f.close()

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/monitoring/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter In Type Required Description
id path integer(int32) true The identifier of a specific corporate monitoring scan. The GET /corp-scans/monitoring API method response class returns this identifier in monitoringScanId.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.
companyName query string false All or part of Company Name.
entityNumber query string false All or part of Entity Number.
scanResult query string false Scan Result Matched or Not Matched.
category query string false Category of entity in scan result. See supported values below.
subCategory query string false SIE subcategories of entity in scan result. See supported values below.
decision query string false Due diligence decision of scan result. See supported values below.
risk query string false Assessed risk level of scan result. See supported values below.
monitoringStatus query string false Outcome of the monitoring status of the scan result. See supported values below.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel
scanResult MatchesFound
scanResult NoMatchesFound
category TER
category SIE
category All
subCategory SanctionsLists
subCategory LawEnforcement
subCategory RegulatoryEnforcement
subCategory OrganisedCrime
subCategory FinancialCrime
subCategory NarcoticsCrime
subCategory ModernSlavery
subCategory BriberyAndCorruption
subCategory CyberCrime
subCategory DisqualifiedDirectors
subCategory Other
subCategory Insolvency
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

Responses

Code Status Description Schema
200 OK Report file byte array. ByteArrayContent
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Enable Corporate Scan Monitoring

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/enable \
  -H 'Api-Key: your-api-key'

POST https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/enable HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/enable', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.post('https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/enable', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/enable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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 Entity Number already exists in the Monitoring List, this will replace the existing company in the Monitoring List. Entity Numbers for companies must be unique as this will replace any existing company with the same Entity Number in the Monitoring List.

Parameters

Parameter 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

204 Response

{}

Responses

Code Status Description Schema
204 No Content Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Disable Corporate Scan Monitoring

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/disable \
  -H 'Api-Key: your-api-key'

POST https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/disable HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/disable', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.post('https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/disable', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/corp-scans/single/{id}/monitor/disable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/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

Parameter 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

204 Response

{}

Responses

Code Status Description Schema
204 No Content Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Corporate Linked Individual Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0 \
  -H 'Accept: application/json'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0',
{
  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.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}',
  params: {
  'individualId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}', params={
  'individualId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}?individualId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query 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,
  "categories": "string",
  "subcategory": "string",
  "gender": "string",
  "deceased": "string",
  "primaryFirstName": "string",
  "primaryMiddleName": "string",
  "primaryLastName": "string",
  "title": "string",
  "position": "string",
  "dateOfBirth": "string",
  "deceasedDate": "string",
  "placeOfBirth": "string",
  "primaryLocation": "string",
  "image": "string",
  "generalInfo": {
    "property1": "string",
    "property2": "string"
  },
  "furtherInformation": "string",
  "xmlFurtherInformation": [
    {}
  ],
  "enterDate": "string",
  "lastReviewed": "string",
  "descriptions": [
    {
      "description1": "string",
      "description2": "string",
      "description3": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "title": "string"
    }
  ],
  "originalScriptNames": [
    "string"
  ],
  "roles": [
    {
      "title": "string",
      "type": "string",
      "status": "string",
      "country": "string",
      "from": "string",
      "to": "string"
    }
  ],
  "importantDates": [
    {
      "dateType": "string",
      "dateValue": "string"
    }
  ],
  "locations": [
    {
      "country": "string",
      "city": "string",
      "address": "string"
    }
  ],
  "countries": [
    {
      "countryType": "string",
      "countryValue": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "country": "string",
      "isCurrent": true
    }
  ],
  "idNumbers": [
    {
      "type": "string",
      "idNotes": "string",
      "number": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "dates": "string",
      "cachedUrl": "string"
    }
  ],
  "linkedIndividuals": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "otherCategories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "id": 0,
      "name": "string",
      "categories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ]
}

Responses

Code Status Description Schema
200 OK Entity’s Profile Information (all available information from the watchlists) including General Information, Also Known As, Addresses, Roles, Important Dates, Countries, Official Lists, ID Numbers, Sources, Images, Relatives and Close Associates. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Linked Individual Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0 \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report',
  params: {
  'individualId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report', params={
  'individualId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report?individualId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-individuals/{individualid}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query integer(int32) true The identifier of a specific linked individual of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedIndividuals.id.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Linked Company Details

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}?companyId=0 \
  -H 'Accept: application/json'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}?companyId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}?companyId=0',
{
  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.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}',
  params: {
  'companyId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}', params={
  'companyId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}?companyId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query 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,
  "categories": "string",
  "subcategory": "string",
  "primaryName": "string",
  "primaryLocation": "string",
  "generalInfo": {
    "property1": "string",
    "property2": "string"
  },
  "furtherInformation": "string",
  "xmlFurtherInformation": [
    {}
  ],
  "enterDate": "string",
  "lastReviewed": "string",
  "descriptions": [
    {
      "description1": "string",
      "description2": "string",
      "description3": "string"
    }
  ],
  "nameDetails": [
    {
      "nameType": "string",
      "entityName": "string"
    }
  ],
  "originalScriptNames": [
    "string"
  ],
  "locations": [
    {
      "country": "string",
      "city": "string",
      "address": "string"
    }
  ],
  "countries": [
    {
      "countryType": "string",
      "countryValue": "string"
    }
  ],
  "officialLists": [
    {
      "keyword": "string",
      "category": "string",
      "description": "string",
      "country": "string",
      "isCurrent": true
    }
  ],
  "idNumbers": [
    {
      "type": "string",
      "idNotes": "string",
      "number": "string"
    }
  ],
  "sources": [
    {
      "url": "string",
      "categories": "string",
      "dates": "string",
      "cachedUrl": "string"
    }
  ],
  "linkedIndividuals": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "otherCategories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ],
  "linkedCompanies": [
    {
      "id": 0,
      "name": "string",
      "categories": "string",
      "subcategories": "string",
      "description": "string"
    }
  ]
}

Responses

Code Status Description Schema
200 OK Entity’s Profile Information (all available information from the watchlists) in the Company Details section including General Information, Also Known As, Addresses, Countries, Official Lists, ID Numbers, Sources. EntityCorp
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Linked Company Details Report

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0 \
  -H 'Accept: application/octet-stream'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0 HTTP/1.1
Host: demo.membercheck.com
Accept: application/octet-stream


const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report',
  params: {
  'companyId' => 'integer(int32)'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report', params={
  'companyId': '0'
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report?companyId=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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/octet-stream"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/linked-companies/{companyid}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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 query integer(int32) true The identifier of a specific linked company of a matched company. The GET /corp-scans/single/results/{id} API method response class returns this identifier in entity.linkedCompanies.id.
format query string false Specify the report file format. Options are PDF, Excel, Word. If no format is defined, the default is PDF.

Enumerated Values

Parameter Value
format PDF
format Word
format Excel

Example responses

200 Response

Responses

Code Status Description Schema
200 OK Report file byte array. Entity
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Corporate Due Diligence History

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions \
  -H 'Api-Key: your-api-key'

GET https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Api-Key' => 'your-api-key'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions', headers

p JSON.parse(result)

import requests
headers = {
  'Api-Key': 'your-api-key'
}

r = requests.get('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions', headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/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

Parameter 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": "2020-06-30T06:30:00Z",
    "comment": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of DecisionHistory; lists the due diligence decisions for a corporate selected in the scan results or scan history. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DecisionHistory] false none [Returns the due diligence decisions for a person or corporate entity.]
» username string false none The user who recorded the decision.
» date string(date-time) false none The date and time of decision.
» comment string false none Additional comment entered with the decision.

New Corporate Due Diligence Decision

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions \
  -H 'Content-Type: application/json' \
  -H 'Api-Key: your-api-key' \
  -d '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}'

POST https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json

const inputBody = `{
  "matchDecision": "Match",
  "assessedRisk": "Unallocated",
  "comment": "string"
}`;
const headers = {
  'Content-Type':'application/json',
  'Api-Key':'your-api-key'
};

fetch('https://demo.membercheck.com/api/v1/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',
  'Api-Key' => 'your-api-key'
}

data = '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}';
result = RestClient.post 'https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions', data, headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Api-Key': 'your-api-key'
}

data = '{"matchDecision":"Match","assessedRisk":"Unallocated","comment":"string"}'; 
r = requests.post('https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions', data = data, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/corp-scans/single/results/{id}/decisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/corp-scans/single/results/{id}/decisions

Adds a due diligence decision for a matched corporate.

Corporate Scan - Due Diligence Decision You are able to input due diligence decisions for a corporate selected in the Scan Results, or a Found Entity selected from the Scan History Log.

Body parameter

{
  "matchDecision": "Match",
  "assessedRisk": "Unallocated",
  "comment": "string"
}
matchDecision: Match
assessedRisk: Unallocated
comment: string

Parameters

Parameter In Type Required Description
id path integer(int32) true The result id of a specific matched member. The GET /corp-scans/single/{id} API method response class returns this identifier in scanResult.matchedEntities.resultId.
body body DecisionParam true Due Diligence Decision parameters, which include decision, risk and comment.

Example responses

201 Response

{}

Responses

Code Status Description Schema
201 Created Indicates success but nothing is in the response body. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
403 Forbidden The server is not able to fulfill the request. None
404 Not Found The requested resource not found. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

ID Verification

ID Verification Data Sources

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/id-verification/data-source \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/id-verification/data-source HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/id-verification/data-source',
{
  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'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/id-verification/data-source',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/id-verification/data-source', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/id-verification/data-source");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/id-verification/data-source", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/id-verification/data-source

Returns list of available Data Sources.

The Data Source name is required for calling the id-verification method and determines which data sources will be searched. This list returns required mandatory parameters for each data source.

Parameters

Parameter 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

[
  {
    "country": "string",
    "dataSources": [
      {
        "name": "string",
        "consentRequired": true,
        "requiredInputParameters": "string"
      }
    ]
  }
]

Responses

Code Status Description Schema
200 OK Array of IDVCountryDataSource; lists all available Data Sources per country. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [IDVCountryDataSource] false none none
» country string false none The data source supplier country.
» dataSources [IDVDataSource] false none [The ID Verification information service supplier, the country of the information source and if consent is required.]
»» name string false none The data source supplier name.
»» consentRequired boolean false none There are available data sources, that will require consent and can only be accessed where the individual who an enquiry is being made on has consented for the enquiry to be performed.
»» requiredInputParameters string false none The data source mandatory input parameters list.

Australian ID Verification

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/id-verification/au/single \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

POST https://demo.membercheck.com/api/v1/id-verification/au/single HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string

const inputBody = '{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "birthDate": "string",
  "gender": "string",
  "address": {
    "unitNumber": "string",
    "streetNumber": "string",
    "streetName": "string",
    "streetType": "string",
    "suburb": "string",
    "state": "str",
    "postCode": "stri"
  },
  "phoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "driversLicenceNo": "string",
  "driversLicenceState": "str",
  "passportNumber": "string",
  "passportCountry": "string",
  "medicareCardNo": "string",
  "medicareCardExpiry": "string",
  "medicareCardType": "string",
  "medicareIndividualRefNo": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/id-verification/au/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'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/id-verification/au/single',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.post('https://demo.membercheck.com/api/v1/id-verification/au/single', data={
  # TODO
}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/id-verification/au/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/id-verification/au/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/id-verification/au/single

Performs new identity verification against Australian data sources.

Member Scan - Scan New allows you to verify members identity by entering member information into the fields provided.

Body parameter

{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "birthDate": "string",
  "gender": "string",
  "address": {
    "unitNumber": "string",
    "streetNumber": "string",
    "streetName": "string",
    "streetType": "string",
    "suburb": "string",
    "state": "str",
    "postCode": "stri"
  },
  "phoneNumber": "string",
  "mobileNumber": "string",
  "emailAddress": "string",
  "driversLicenceNo": "string",
  "driversLicenceState": "str",
  "passportNumber": "string",
  "passportCountry": "string",
  "medicareCardNo": "string",
  "medicareCardExpiry": "string",
  "medicareCardType": "string",
  "medicareIndividualRefNo": "string"
}
dataSources:
  - string
consentObtained: true
firstName: string
middleName: string
lastName: string
birthDate: string
gender: string
address:
  unitNumber: string
  streetNumber: string
  streetName: string
  streetType: string
  suburb: string
  state: str
  postCode: stri
phoneNumber: string
mobileNumber: string
emailAddress: string
driversLicenceNo: string
driversLicenceState: str
passportNumber: string
passportCountry: string
medicareCardNo: string
medicareCardExpiry: string
medicareCardType: string
medicareIndividualRefNo: string

Parameters

Parameter 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 IDVInputParamAu true Verify parameters, which include names, address and other additional identity information that will be verified.

Example responses

201 Response

{
  "message": "string",
  "safeHarbour": true,
  "verifiedNumber": 0,
  "verifiedResults": [
    {
      "dataSource": "string",
      "items": [
        {
          "firstName": "string",
          "firstNameVerified": true,
          "middleName": "string",
          "middleNameVerified": true,
          "lastName": "string",
          "lastNameVerified": true,
          "gender": "string",
          "phoneNumber": "string",
          "mobileNumber": "string",
          "emailAddress": "string",
          "addresses": [
            {
              "addressLine1": "string",
              "suburb": "string",
              "city": "string",
              "state": "string",
              "postcode": "string",
              "fromDate": "string",
              "titleNo": "string",
              "encumbrance": "string",
              "encumbranceLodged": "string",
              "dpid": "string",
              "addressVerified": true
            }
          ],
          "birthDate": "string",
          "birthDateVerified": true,
          "driversLicenceNo": "string",
          "driversLicenceState": "string",
          "licenceNoVerified": true,
          "passportNumber": "string",
          "passportCountry": "string",
          "medicareCardNo": "string",
          "medicareCardExpiry": "string",
          "medicareCardType": "string",
          "medicareIndividualRefNo": 0,
          "status": 0,
          "sourceVerified": true,
          "safeHarbourScore": "string"
        }
      ]
    }
  ]
}

Responses

Code Status Description Schema
201 Created IDVResultsAu: contains information of verified entities. IDVResultsAu
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

New Zealand ID Verification

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/id-verification/nz/single \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

POST https://demo.membercheck.com/api/v1/id-verification/nz/single HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string

const inputBody = '{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "birthDate": "string",
  "address": {
    "unitNumber": "string",
    "streetNumber": "string",
    "streetName": "string",
    "streetType": "string",
    "city": "string",
    "region": "string",
    "postCode": "stri"
  },
  "passportNumber": "string",
  "passportExpiry": "string",
  "driversLicenceNo": "string",
  "driversLicenceVersion": "strin"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/id-verification/nz/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'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/id-verification/nz/single',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.post('https://demo.membercheck.com/api/v1/id-verification/nz/single', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/id-verification/nz/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/id-verification/nz/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/id-verification/nz/single

Performs new identity verification against New Zealand data sources.

Member Scan - Scan New allows you to verify members identity by entering member information into the fields provided.

Body parameter

{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "birthDate": "string",
  "address": {
    "unitNumber": "string",
    "streetNumber": "string",
    "streetName": "string",
    "streetType": "string",
    "city": "string",
    "region": "string",
    "postCode": "stri"
  },
  "passportNumber": "string",
  "passportExpiry": "string",
  "driversLicenceNo": "string",
  "driversLicenceVersion": "strin"
}
dataSources:
  - string
consentObtained: true
firstName: string
middleName: string
lastName: string
birthDate: string
address:
  unitNumber: string
  streetNumber: string
  streetName: string
  streetType: string
  city: string
  region: string
  postCode: stri
passportNumber: string
passportExpiry: string
driversLicenceNo: string
driversLicenceVersion: strin

Parameters

Parameter 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 IDVInputParamNz true Verify parameters, which include names, address and other additional identity information that will be verified.

Example responses

201 Response

{
  "message": "string",
  "safeHarbour": true,
  "verifiedNumber": 0,
  "verifiedResults": [
    {
      "dataSource": "string",
      "items": [
        {
          "firstName": "string",
          "firstNameVerified": true,
          "middleName": "string",
          "middleNameVerified": true,
          "lastName": "string",
          "lastNameVerified": true,
          "knownNames": [
            "string"
          ],
          "addresses": [
            {
              "addressLine1": "string",
              "suburb": "string",
              "city": "string",
              "state": "string",
              "postcode": "string",
              "fromDate": "string",
              "titleNo": "string",
              "encumbrance": "string",
              "encumbranceLodged": "string",
              "dpid": "string",
              "addressVerified": true
            }
          ],
          "otherOwners": [
            "string"
          ],
          "birthDate": "string",
          "passportNumber": "string",
          "passportExpiry": "string",
          "citizenshipCertificateNo": "string",
          "birthCountry": "string",
          "status": 0,
          "sourceVerified": true,
          "safeHarbourScore": "string"
        }
      ]
    }
  ]
}

Responses

Code Status Description Schema
201 Created IDVResultsNz: contains information of verified entities. IDVResultsNz
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Chinese ID Verification

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/id-verification/cn/single \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

POST https://demo.membercheck.com/api/v1/id-verification/cn/single HTTP/1.1
Host: demo.membercheck.com
Content-Type: application/json
Accept: application/json
X-Request-OrgId: string

const inputBody = '{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "fullName": "string",
  "birthDate": "string",
  "idCardNo": "string",
  "bankCardNo": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/id-verification/cn/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'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/id-verification/cn/single',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.post('https://demo.membercheck.com/api/v1/id-verification/cn/single', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/id-verification/cn/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://demo.membercheck.com/api/v1/id-verification/cn/single", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/id-verification/cn/single

Performs new identity verification against Chinese data sources.

Member Scan - Scan New allows you to verify members identity by entering member information into the fields provided.

Body parameter

{
  "dataSources": [
    "string"
  ],
  "consentObtained": true,
  "fullName": "string",
  "birthDate": "string",
  "idCardNo": "string",
  "bankCardNo": "string"
}
dataSources:
  - string
consentObtained: true
fullName: string
birthDate: string
idCardNo: string
bankCardNo: string

Parameters

Parameter 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 IDVInputParamCn true Verify parameters, which include full name, birthdate and identity card information that will be verified.

Example responses

201 Response

{
  "message": "string",
  "safeHarbour": true,
  "verifiedNumber": 0,
  "verifiedResults": [
    {
      "dataSource": "string",
      "items": [
        {
          "fullName": "string",
          "gender": "string",
          "birthDate": "string",
          "birthDateVerified": true,
          "address": "string",
          "idCardNo": "string",
          "idCardNoValid": true,
          "bankCardNo": "string",
          "status": 0,
          "sourceVerified": true,
          "safeHarbourScore": "string"
        }
      ]
    }
  ]
}

Responses

Code Status Description Schema
201 Created IDVResultsCn: contains information of verified entities. IDVResultsCn
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Monitoring Lists

Member Monitoring List

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/monitoring-lists/member \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/monitoring-lists/member HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/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'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/monitoring-lists/member',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/monitoring-lists/member', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/monitoring-lists/member", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/monitoring-lists/member

Returns details of members in the monitoring list. Results can be filtered by Names, Member Number and Status.

Monitoring - Monitoring List provides a record of all members in the monitoring list.

Parameters

Parameter 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.
originalScriptName query string false Full Original Script Name. Only enter original script name in this parameter (i.e. Chinese, Japanese, Cyrillic, Arabic etc).
memberNumber query string false Full Member Number.
status query string false Status of monitoring for the member i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values.
pageIndex query integer(int32) false The page index of results.
pageSize query integer(int32) false The number of items or results per page.
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": "2020-06-30T06:30:00Z",
    "memberNumber": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "originalScriptName": "string",
    "dob": "string",
    "address": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of MonitoringListMemberItem; lists the member’s monitoring list items. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MonitoringListMemberItem] false none none
» id integer(int32) false none The unique identifier for the member assigned by the system within the monitoring list.
» monitor boolean false none Status of monitoring for the member i.e. actively monitored (true) or disabled from monitoring (false).
» addedBy string false none User who added the member to the monitoring list during a scan.
» dateAdded string(date-time) false none Date the member was first added to the monitoring list.
» memberNumber string false none The unique Member Number entered for the member during scans.
» firstName string false none The first name scanned for the member.
» middleName string false none The middle name scanned for the member.
» lastName string false none The last name scanned for the member.
» originalScriptName string false none The original script name scanned for the member.
» dob string false none The date of birth scanned for the member.
» address string false none The address scanned for the member.

Corporate Monitoring List

Code samples

# You can also use wget
curl -X GET https://demo.membercheck.com/api/v1/monitoring-lists/corp \
  -H 'Accept: application/json' \
  -H 'X-Request-OrgId: string'

GET https://demo.membercheck.com/api/v1/monitoring-lists/corp HTTP/1.1
Host: demo.membercheck.com
Accept: application/json
X-Request-OrgId: string


const headers = {
  'Accept':'application/json',
  'X-Request-OrgId':'string'
};

fetch('https://demo.membercheck.com/api/v1/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'
}

result = RestClient.get 'https://demo.membercheck.com/api/v1/monitoring-lists/corp',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-Request-OrgId': 'string'
}

r = requests.get('https://demo.membercheck.com/api/v1/monitoring-lists/corp', params={

}, headers = headers)

print(r.json())

URL obj = new URL("https://demo.membercheck.com/api/v1/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"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://demo.membercheck.com/api/v1/monitoring-lists/corp", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/monitoring-lists/corp

Returns details of companies in the monitoring list. Results can be filtered by Name, Entity Number and Status.

Monitoring - Monitoring List provides a record of all companies in the monitoring list.

Parameters

Parameter In Type Required Description
companyName query string false All or part of Company Name.
entityNumber query string false The Entity Number scanned.
status query string false Status of monitoring for the company i.e. actively monitored (On) or disabled from monitoring (Off). See below for supported values.
pageIndex query integer(int32) false The page index of results.
pageSize query integer(int32) false The number of items or results per page.
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": "2020-06-30T06:30:00Z",
    "entityNumber": "string",
    "companyName": "string",
    "address": "string"
  }
]

Responses

Code Status Description Schema
200 OK Array of MonitoringListCorpItem; lists the corporate’s monitoring list items. Inline
400 Bad Request The request could not be understood or processed by the server. None
401 Unauthorised The requested resource requires authentication. None
500 Internal Server Error An error has occurred on the server. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MonitoringListCorpItem] false none none
» id integer(int32) false none The unique identifier for the company assigned by the system within the monitoring list.
» monitor boolean false none Status of monitoring for the company i.e. actively monitored (true) or disabled from monitoring (false).
» addedBy string false none User who added the company to the monitoring list during a scan.
» dateAdded string(date-time) false none Date the company was first added to the monitoring list.
» entityNumber string false none The unique Entity Number for the company entered during scans.
» companyName string false none The name scanned for the company.
» address string false none The address scanned for the company.

Enable Member Monitoring in Monitoring List

Code samples

# You can also use wget
curl -X POST https://demo.membercheck.com/api/v1/monitoring-lists/member/{id}/enable \
  -H 'Accept: application/json'

POST https://demo.membercheck.com/api/v1/monitoring-lists/member/{id}/enable HTTP/1.1
Host: demo.membercheck.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://demo.membercheck.com/api/v1/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 = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://demo.membercheck.com/api/v1/monitoring-lists/member/{id}/enable',
  params: {
  }, headers: headers

p JSON.p