Acuris Risk Intelligence Monitor

API Guide:
Monitor API 1.0

Classification: Confidential
Revision History
Date Version Description Author

24/07/2018 0.1 API Version 1.0 Matt Taylor

02/08/2018 1.0 Finalised documentation Benjamin Zwahlen
15/10/2018 1.1 Updated branding Benjamin Zwahlen
27/11/2018 1.2 Added QR lookup endpoints Benjamin Zwahlen
18/12/2018 1.3 Updated MatchDataset responses Matt Taylor
10/06/2019 1.4 Added option to delete related Mariusz Lip
matches

Classification: Confidential
Contents
Introduction................................................................................................................6
Communication .................................................................................................................................. 6
Authentication ................................................................................................................................... 6
Endpoints....................................................................................................................7
Add Business ...................................................................................................................................... 7
Sample JSON Business Add Request:........................................................................................................... 7
Request Fields Description:.......................................................................................................................... 8
Sample Add Business Response:.................................................................................................................. 8
Edit Business....................................................................................................................................... 9
Sample JSON Edit Business Request: ........................................................................................................... 9
URL Parameters: .......................................................................................................................................... 9
Request Fields Description:.......................................................................................................................... 9
Sample Edit Business Response: ................................................................................................................ 10
Get Business ..................................................................................................................................... 11
Sample JSON Get Business by UniqueId Request:..................................................................................... 11
URL Parameters: ........................................................................................................................................ 11
Sample JSON Business Get by UniqueId Response: .................................................................................. 11
Response Fields Description: ..................................................................................................................... 12
Get Businesses ................................................................................................................................. 13
Sample JSON Get Business Request: ......................................................................................................... 13
URL Parameters: ........................................................................................................................................ 13
Sample JSON Get Business Response: ....................................................................................................... 13
Response Fields Description: ..................................................................................................................... 14
Remove Business.............................................................................................................................. 15
Sample JSON Remove Business by UniqueId Request: ............................................................................. 15
URL Parameters: ........................................................................................................................................ 15
Sample Remove Business by UniqueId Response: .................................................................................... 15
Add Person ....................................................................................................................................... 16
Sample JSON Person Add Request: ........................................................................................................... 16
Request Fields Description:........................................................................................................................ 16

Classification: Confidential
 Sample Add Person Response: .................................................................................................................. 17
Edit Person ....................................................................................................................................... 18
Sample JSON Edit Person Request:............................................................................................................ 18
URL Parameters: ........................................................................................................................................ 18
Request Fields Description:........................................................................................................................ 18
Sample Edit Person Response:................................................................................................................... 19
Get Person ........................................................................................................................................ 20
Sample JSON Get Person by UniqueId Request: ....................................................................................... 20
URL Parameters: ........................................................................................................................................ 20
Sample JSON Person Get by UniqueId Response: ..................................................................................... 20
Response Fields Description: ..................................................................................................................... 21
Get Persons ...................................................................................................................................... 22
Sample JSON Get Persons by StartIndex and Size Request:...................................................................... 22
URL Parameters: ........................................................................................................................................ 22
Sample JSON Get Persons by StartIntex and Size Response: .................................................................... 22
Response Fields Description: ..................................................................................................................... 23
Remove Person ................................................................................................................................ 24
Sample JSON Remove Persons by UniqueId Request: .............................................................................. 24
URL Parameters: ........................................................................................................................................ 24
Sample Remove Person by UniqueId Response:....................................................................................... 24
Retrieve Open Alerts ........................................................................................................................ 25
Sample JSON Retrieve Open Alerts Request: ............................................................................................ 25
URL Parameters: ........................................................................................................................................ 25
Sample JSON Retrieve Open Alerts Response: .......................................................................................... 26
Response Fields Description: ..................................................................................................................... 27
Retrieve Specific Alert ...................................................................................................................... 29
Sample JSON Retrieve Specific Alert Request: .......................................................................................... 29
URL Parameters: ........................................................................................................................................ 29
Sample JSON Retrieve Specific Alert Response: ........................................................................................ 30
Response Fields Description: ..................................................................................................................... 31
Person Get by Quick Reference (QR) Code ..................................................................................... 33
Sample JSON Get Person by QR Code Request: ........................................................................................ 33

Classification: Confidential
 Sample JSON Person Get by QR Code Response: (E.g. QR = 116301)....................................................... 33
Response Fields Description: ..................................................................................................................... 36
Add Comment to Match - Person .................................................................................................... 39
Sample JSON Add Comment to Match - Person Request: ........................................................................ 39
URL Parameters: ........................................................................................................................................ 39
Sample Add Comment to Person Match Response: ................................................................................. 40
Business Get by Quick Reference (QR) Code................................................................................... 41
Sample JSON Get Business by QR Code Request: ..................................................................................... 41
Sample JSON Get Business by QR Code Response (E.g. QR = 41263) ....................................................... 41
Response Fields Description: ..................................................................................................................... 43
Add Comment to Match - Business ................................................................................................. 46
Sample JSON Add Comment to Match - Business Request: ..................................................................... 46
URL Parameters: ........................................................................................................................................ 46
Sample Add Comment to Match – Business Response:............................................................................ 46

Classification: Confidential
Introduction
The Monitor API is to be used for integrating into the Acuris Risk Intelligence On-going Monitor. The
API allows you to add, edit and remove entities from monitoring. Matches can be retrieved from the
API and reviewed once the nightly monitor has performed the matching logic.
The prerequisite for using this API is that Acuris Risk Intelligence has already provisioned a
monitoring database and the worklists (sources) have already been configured. Some settings for
matching are only available within the KYC6 portal. Please ask Client Care for more information.

Communication

Communication is provided as an HTTP REST Web-Service

(http://en.wikipedia.org/wiki/Representational_state_transfer). Security will be provided in the
form of an HTTPS connection to ensure data security.

Authentication

Authentication shall be performed by using a unique key submitted as part of each API call. This
unique key is obtained from Acuris Risk Intelligence and will be unique for each company for auditing
purposes. The key is in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where x is an alphanumeric
character. When communicating with API, the key should be provided in headers section, with
“apiKey” field name.

Classification: Confidential
Endpoints
List of functions available through the Monitor API 1.0. The following HTTP codes can be expected
from the API:
200 - OK
201 - Created
204 - No Content
400 - Bad Request
401 - Unauthorised
404 - Not Found
500 - Internal Server Error

Add Business

The add business endpoint allows authenticated users to add business to the monitoring.
Sample JSON Business Add Request:
Request Type POST
Request URL /monitorApi/v1_0/api/businesses

Request URL (LIVE) https://api1.c6-intelligence.com/monitorApi/v1_0/api/businesses

Request URL (UAT) https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/businesses

Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

Classification: Confidential
 {
"name": "string",
"address1": "address",
"address2": "city",
"address3": "state",
"postcode": "postocde",
"uniqueId": "unique id",
"country": "United Kingdom",
"sourceName": "test123"
}

Request Fields Description:

Parameter Name Required Field Restrictions Description
name Yes Max length 300 Name of business
address 1 No Max length 500 Address
address 2 No Max length 500 City
address 3 No Max length 500 State
postcode No Max length 100 Postcode
uniqueId Yes Max length 100 Unique Id of business
country No Max length 100 Country name
sourceName Yes Max length 100 Source name

Sample Add Business Response:

UniqueId which was passed as a single string containing just the ID.

Classification: Confidential
Edit Business

The edit business endpoint allows authenticated users to edit business by uniqueId which is
passed in the URL.
Sample JSON Edit Business Request:
Request Type PUT
Request URL /monitorApi/v1_0/api/businesses?uniqueId={uniqueId}

Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/businesses?uniqueId=C6016

(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/businesses?uniqueId=C6016
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment
Request Body:
{
"name": "Business Name",
"address1": "Address",
"address2": "City",
"address3": "State",
"postcode": "Post Code",
"country": "United Kingdom",
"sourceName": "ml3"
}

URL Parameters:
Parameter Required Field Restrictions Description
Name
uniqueId Yes Max length 100 UniqueId of businesses

Request Fields Description:

Parameter Required Field Restrictions Description
Name
name Yes Max length 300 Name of business
address 1 No Max length 500 Address

Classification: Confidential
 address 2 No Max length 500 City
address 3 No Max length 500 State
postcode No Max length 100 Postcode
country No Max length 100 Country
sourceName Yes Max length 100 Source Name

Sample Edit Business Response:

No content

Classification: Confidential
Get Business

The get business endpoint allows authenticated users to retrieve business information by uniqueId
which is passed in the URL.
Sample JSON Get Business by UniqueId Request:
Request Type GET
Request URL /monitorApi/v1_0/api/businesses?uniqueId={uniqueId)

Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/businesses?uniqueId=C6016

(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/businesses?uniqueId=C6016
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Name Required Field Restrictions Description
uniqueId Yes Max length 100 UniqueId of businesses

Sample JSON Business Get by UniqueId Response:

{
"name": "name","address1": "addr1",
"address2": "addr2",
"address3": "addr3",
"postcode": "ps",
"insertDate": "2017-05-26 11:20:11",
"uniqueId": "rrrrr",
"updateDate":null,
"countryName": "United Kingdom", "sourceName": "Low Risk"

Classification: Confidential
Response Fields Description:
Parameter Name Description
name Name of business
address 1 Address
address 2 City
address 3 State
address6 Country
postcode Postcode
insertDate InsertDate
uniqueId Unique ID of business
updateDate UpdateDate
countryName Country
sourceName Source

Classification: Confidential
Get Businesses

The get businesses endpoint allows authenticated users to retrieve businesses. It requires a user to
pass the start index and size in the URL. This endpoint works using pagination.
Sample JSON Get Business Request:
Request Type GET
Request URL /monitorApi/v1_0/api/businesses/{startIndex}/{size}
Request URL (LIVE) https://api1.c6-intelligence.com/monitorApi/v1_0/api/businesses/5/4

Request URL (UAT) https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/businesses/5/4

Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Name Required Field Restrictions Description
startIndex Yes Between 0 and 2147483647 Unique Id of businesses
size Yes Between 1 and 100 The number of records to return

Sample JSON Get Business Response:

[
{
"name": "Advanced Software Systems",
"address1": "3rd Floor, Omar Hodge Building, Wickhams Cay 1,",
"address2": "Tortola",
"address3": "Road Town",
"postcode": "555555",
"insertDate": "2015-09-22 10:14:17",
"uniqueId": "5-1580",
"updateDate": "2017-06-02 13:02:24",
"countryName": "British Virgin Islands",
"sourceName": "Business Monitoring Dept"
},
{
"name": "Aeroflot",

Classification: Confidential
 "address1": "37 Building 9 Leningradsky Prospect",
"address2": "Moscow",
"address3": "",
"postcode": "",
"insertDate": "2015-05-22 15:31:16",
"uniqueId": "C6031",
"updateDate": null,
"countryName": "Russia",
"sourceName": "Business Monitoring Dept"
}
]

Response Fields Description:

Parameter Name Description
name Name of business
address 1 Address
address 2 City
address 3 State
address6 Country
postcode Postcode
insertDate InsertDate
uniqueId Unique ID of business
updateDate UpdateDate
countryName Country
sourceName Source

Classification: Confidential
Remove Business

The remove business endpoint allows authenticated users to delete a business using a uniqueId
which is passed in the URL.
Sample JSON Remove Business by UniqueId Request:
Request DELETE
Type
Request /monitorApi/v1_0/api/business?uniqueId={uniqueId}&relatedMatches={boolean}
URL
Request https://api1.c6-intelligence.com/monitorApi/v1_0/api/business?uniqueId=C6016&relatedMatches=true
URL (LIVE)
Request https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/business?uniqueId=C6016&relatedMatches=true
URL (UAT)
Request Headers:
apiKey <your_api_key_here>
Content- application/json; charset=utf-8
Type
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Required Field Restrictions Description
Name
uniqueId Yes Max length 100 UniqueId of businesses
relatedMatches No Only “true” or “false” Whether to delete matches generated for this
business. Defaults to “false” if not provided

Sample Remove Business by UniqueId Response:

No content

Classification: Confidential
Add Person

The add person endpoint allows authenticated users to add persons for monitoring.
Sample JSON Person Add Request:
Request Type POST
Request URL /monitorApi/v1_0/api/persons

Request URL (LIVE) https://api1.c6-intelligence.com/monitorApi/v1_0/api/persons

Request URL (UAT) https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/persons

Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment
{
"forename": "string",
"surname": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postcode": "string",
"uniqueId": "string",
"country": "string",
"nationality": "string",
"sourceName": "string",
"dob": "2017-06-01",
"yob": 0
}

Request Fields Description:

Parameter Name Required Field Restrictions Description
forename Yes Max length 100 Forename
surname Yes Max length 100 Surname
address1 No Max length 500 Address
address2 No Max length 500 City
address3 No Max length 500 State
postcode No Max length 100 Post code
uniqueId Yes Max length 100 UniqueId
country No Max length 100 Country

Classification: Confidential
 nationality No Max length 100 Nationality
sourceName Yes Max length 200 Source name
dob No Format: yyyy-mm-dd Date of Birth
yob No Frmat: yyyy Year of Birth

Sample Add Person Response:

uniqueId which was passed

Classification: Confidential
Edit Person

The edit person endpoint allows authenticated users to edit person by uniqueId which is passed in
the URL.
Sample JSON Edit Person Request:
Request Type PUT
Request URL /monitorApi/v1_0/api/persons?uniqueId={uniqueId)

Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/persons?uniqueId=C6016

(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/persons?uniqueId=C6016
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment
Request Body:
{
"forename": "string",
"surname": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postcode": "string",
"country": "string",
"nationality": "string",
"sourceName": "string",
"dob": "2017-06-01",
"yob": 0
}

URL Parameters:
Parameter Required Field Restrictions Description
Name
uniqueId Yes Max length 100 UniqueId of person

Request Fields Description:

Parameter Name Required Field Restrictions Description

Classification: Confidential
 forename Yes Max length 100 Forename
surname Yes Max length 100 Surname
address1 No Max length 500 Address
address2 No Max length 500 City
address3 No Max length 500 State
postcode No Max length 100 Post code
country No Max length 100 Country
nationality No Max length 100 Nationality
sourceName Yes Max length 200 Source name
dob No Format: yyyy-mm-dd Date of Birth
yob No Format: yyyy Year of Birth

Sample Edit Person Response:

No content

Classification: Confidential
Get Person

The get person endpoint allows authenticated users to retrieve person information by uniqueId
which is passed in the URL.
Sample JSON Get Person by UniqueId Request:
Request Type GET
Request URL /monitorApi/v1_0/api/persons?uniqueId={uniqueId)

Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/persons?uniqueId=C6016

(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/persons?uniqueId=C6016
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Name Required Field Restrictions Description
uniqueId Yes Max length 100 Unique Id of businesses

Sample JSON Person Get by UniqueId Response:

{
"forename": "John",
"surname": "Sur",
"address1": "Addr1",
"address2": "Addr2",
"address3": "Addr3",
"postcode": "PS",
"dob": "01/06/2017",
"yob": 2017,
"insertDate": "2017-05-25 09:37:36",
"uniqueId": "string",
"updateDate": "2017-06-01 12:26:46",
"countryName": "United Kingdom",
"nationalityName": "United Kingdom",
"sourceName": "ml3"
}

Classification: Confidential
Response Fields Description:
Parameter Name Description
forename Forename
surname Surname
address1 Address
address2 City
address3 State
postcode Post code
dob Date of Birth. Format: yyyy-mm-dd
yob Year of Birth. Format: yyyy
insertDate Insert Date
uniqueId Unique Id of person
updateDate Update date
countryName Country name
nationalityName Nationality name
sourceName Source name

Classification: Confidential
Get Persons

The get persons endpoint allows authenticated users to retrieve persons. It requires a user to pass
start index and size in the URL. This endpoint works using pagination.
Sample JSON Get Persons by StartIndex and Size Request:
Request Type GET
Request URL /monitorApi/v1_0/api/persons/{startIndex}/{size}
Request URL (LIVE) https://api1.c6-intelligence.com/monitorApi/v1_0/api/persons/5/4

Request URL (UAT) https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/persons/5/4

Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Name Required Field Restrictions Description
startIndex Yes Between 0 and 2147483647 Unique Id of businesses
size Yes Between 1 and 100 The number of records to return

Sample JSON Get Persons by StartIntex and Size Response:

[
{
"forename": "john",
"surname": "smith",
"address1": "",
"address2": "",
"address3": "",
"postcode": "",
"dob": null,
"yob": null,
"insertDate": "2017-02-20 09:38:32",
"uniqueId": "m10",
"updateDate": "2017-02-20 09:38:32",
"countryName": null,
"nationalityName": null,

Classification: Confidential
 "sourceName": "ml2"
},
{
"forename": "john",
"surname": "smith",
"address1": "",
"address2": "",
"address3": "",
"postcode": "",
"dob": null,
"yob": null,
"insertDate": "2017-02-22 11:40:26",
"uniqueId": "mll12",
"updateDate": "2017-02-22 11:40:26",
"countryName": "United Kingdom",
"nationalityName": null,
"sourceName": "ml3"
}
]

Response Fields Description:

Parameter Name Description
forename Forename
surname Surname
address1 Address
address2 City
address3 State
postcode Post code
dob Date of Birth. Format: yyyy-mm-dd
yob Year of Birth
insertDate Insert Date
uniqueId Unique Id of person
updateDate Update date
countryName Country name
nationalityName Nationality name
sourceName Source name

Classification: Confidential
Remove Person

The remove business endpoint allows authenticated users to delete a business using a uniqueId
which is passed in the URL.
Sample JSON Remove Persons by UniqueId Request:
Request DELETE
Type
Request URL /monitorApi/v1_0/api/persons?uniqueId={uniqueId}&relatedMatches={boolean}
Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/persons?uniqueId=C6016&relatedMatches=true
(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/person?uniqueId=C6016&relatedMatches=true
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content- application/json; charset=utf-8
Type
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Required Field Restrictions Description
Name
uniqueId Yes Max length 100 Unique Id of person
relatedMatches No Only “true” or “false” Whether to delete matches generated for this
person. Defaults to “false” if not provided

Sample Remove Person by UniqueId Response:

No content

Classification: Confidential
Retrieve Open Alerts

The “retrieve open alerts” endpoint allows authenticated users to retrieve a collection of monitor
records with all alerts (matches) for each record. Only records with at least one “open” alert are
shown. This endpoint works using pagination – There is also optional filtering by source.
Sample JSON Retrieve Open Alerts Request:
Request Type GET
Request URL /monitorApi/v1_0/api/worklist/{startIndex}/{size}?source={source}
Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/worklist/0/10?source=mySource
(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/worklist/0/10?source=mySource
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Required Field Restrictions Description
Name
startIndex Yes Between 0 and Unique Id of businesses
2147483647
size Yes Between 1 and 100 The number of records to return
source No Text Source Name

Classification: Confidential
Sample JSON Retrieve Open Alerts Response:
{
"monitorRecords":[
{
"uniqueId":"id1",
"type":"person",
"matches":[
{
"matchId":344637,
"qrCode":114950,
"matchDescription":"C6 Match on Forename, Surname, Address6",
"status":"No Match",
"matchDataset":"PEP",
"matchScore":100,
"matchDate":"2017-04-04 13:26:52",
"lastUpdate":"2017-05-23 09:04:39",
"matchDetail":{
"forename":true,
"middleName":false,
"surname":true,
"dob":false,
"yob":false,
"businessName":null,
"alias":false,
"partialName":null,
"partialAlias":null,
"reverseName":null,
"address1":false,
"address2":false,
"address3":false,
"address6":true,
"postcode":false
},
"comments":[
{
"comment":"Match description / article count - C6 Match on Forename, Surname, Address6",
"dateAdded":"2017-04-04 13:27:01",
"userId":1
},
{
"comment":"Test comment",
"dateAdded":"2017-05-23 09:01:31",
"userId":100
},
{
"comment":"Some text",
"dateAdded":"2017-05-23 09:04:39",

Classification: Confidential
 "userId":100
}
],
"attachments":[
{
"fileName":"Empty.pdf",
"attachmentPath":"\\Uploads\\636318252981651186_2468_Empty.pdf",
"dateAdded":"2017-05-31 11:01:38",
"userId":100
}
],
"statusHistory":[
{
"status":"Match - No Risk",
"date":"2017-05-23 09:01:31",
"userId":111
},
{
"status":"No Match",
"date":"2017-05-23 09:04:22",
"userId":100
}
]
}
]
}
],
"startIndex":0,
"size":10
}

Response Fields Description:

Parameter Name Description
monitorRecords.uniqueId
monitorRecords.type Record type - person/business
monitorRecords.matches.matchId Match identifier.
monitorRecords.matches.qrCode Matched id, also known as QuickReference
(QR) code.
monitorRecords.matches.matchDescription Match description.
monitorRecords.matches.status Current status of the match.
monitorRecords.matches.matchDataset Dataset assigned to match. Possible values are:
“PEP”, ”Sanction”, “FinancialRegulator”,
“LawEnforcement”, “DisqualifiedDirector”,
“Insolvency”, “AdverseMedia”, “Watchlist”
monitorRecords.matches.matchScore Record source (worklist).

Classification: Confidential
 monitorRecords.matches.matchDate Match date.
monitorRecords.matches.lastUpdate Last match update date.
monitorRecords.matches.matchDetail.forename Is match against forename field.
monitorRecords.matches.matchDetail.middleName Is match against middle name field.
monitorRecords.matches.matchDetail.surname Is match against surname field.
monitorRecords.matches.matchDetail.dob Is match against dob field.
monitorRecords.matches.matchDetail.yob Is match against yob field.
monitorRecords.matches.matchDetail.businessName Is match against name field.
monitorRecords.matches.matchDetail.alias Is match against alias field.
monitorRecords.matches.matchDetail.partialName Is match against address2 field.
monitorRecords.matches.matchDetail.partialAlias Is partial match against alias field.
monitorRecords.matches.matchDetail.reverseName Is reverse match against name field.
monitorRecords.matches.matchDetail.address1 Is match against address1 field.
monitorRecords.matches.matchDetail.address2 Is match against address2 field.
monitorRecords.matches.matchDetail.address3 Is match against address3 field.
monitorRecords.matches.matchDetail.address6 Is match against address6 field.
monitorRecords.matches.matchDetail.postcode Is match against postcode field.
monitorRecords.matches.comments.comment Comment text.
monitorRecords.matches.comments.dateAdded Comment insert date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.comments.userId User id.
monitorRecords.matches.attachments.fileName Attachment file name.
monitorRecords.matches.attachments.attachmentPath Patch to access attachment. Add proper
domain at the beginning for KYC6 e.g.
https://kyc6.com/ for live and
https://uat.kyc6.com/ for UAT
monitorRecords.matches.attachments.dateAdded Attachment add date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.attachments.userId User id.
monitorRecords.matches.statusHistory.status Status name
monitorRecords.matches.statusHistory.date Status change date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.statusHistory.userId User id.
startIndex Requested start index.
size Requested records size.

Classification: Confidential
Retrieve Specific Alert

The “Retrieve specific alert” endpoint allows authenticated users to retrieve single monitor record
(person or business) with all alerts (matches).
Sample JSON Retrieve Specific Alert Request:
Request Type GET
Request URL /monitorApi/v1_0/api/worklist/{type}?uniqueId={uniqueId}
Request URL https://api1.c6-intelligence.com/monitorApi/v1_0/api/worklist/person?uniqueId=C6016
(LIVE)
Request URL https://api1.uat.c6-intelligence.com/monitorApi/v1_0/api/worklist/person?uniqueId=C6016
(UAT)
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Name Required Field Restrictions Description
type Yes Text, values: person, business. Determines record type: person
or business.
uniqueId Yes Text Person/business uniqueId

Classification: Confidential
Sample JSON Retrieve Specific Alert Response:
{
"uniqueId":"id1",
"type":"person",
"matches":[
{
"matchId":344637,
"qrCode":114950,
"matchDescription":"C6 Match on Forename, Surname, Address6",
"status":"No Match",
"matchDataset":"PEP",
"matchScore":100,
"matchDate":"2017-04-04 13:26:52",
"lastUpdate":"2017-05-23 09:04:39",
"matchDetail":{
"forename":true,
"middleName":false,
"surname":true,
"dob":false,
"yob":false,
"businessName":null,
"alias":false,
"partialName":null,
"partialAlias":null,
"reverseName":null,
"address1":false,
"address2":false,
"address3":false,
"address6":true,
"postcode":false
},
"comments":[
{
"comment":"Match description / article count - C6 Match on Forename, Surname, Address6 / 54",
"dateAdded":"2017-04-04 13:27:01",
"userId":1
},
{
"comment":"Test comment",
"dateAdded":"2017-05-23 09:01:31",
"userId":100
},
{
"comment":"Some text",
"dateAdded":"2017-05-23 09:04:39",
"userId":100
}

Classification: Confidential
 ],
"attachments":[
{
"fileName":"Empty.pdf",
"attachmentPath":"\\Uploads\\636318252981651186_2468_Empty.pdf",
"dateAdded":"2017-05-31 11:01:38",
"userId":100
}
],
"statusHistory":[
{
"status":"Match - No Risk",
"date":"2017-05-23 09:01:31",
"userId":111
},
{
"status":"No Match",
"date":"2017-05-23 09:04:22",
"userId":100
}
]
}
]
}

Response Fields Description:

Parameter Name Description
monitorRecords.uniqueId
monitorRecords.type Record type - person/business
monitorRecords.matches.matchId Match identifier.
monitorRecords.matches.qrCode Matched id, also known as QuickReference
(QR) code.
monitorRecords.matches.matchDescription Match description.
monitorRecords.matches.status Current status of the match.
monitorRecords.matches.matchDataset Dataset assigned to match. Possible values are:
“PEP”, ”Sanction”, “FinancialRegulator”,
“LawEnforcement”, “DisqualifiedDirector”,
“Insolvency”, “AdverseMedia”, “Watchlist”
monitorRecords.matches.matchScore Record source (worklist).
monitorRecords.matches.matchDate Match date.
monitorRecords.matches.lastUpdate Last match update date.
monitorRecords.matches.matchDetail.forename Is match against forename field.
monitorRecords.matches.matchDetail.middleName Is match against middle name field.
monitorRecords.matches.matchDetail.surname Is match against surname field.
monitorRecords.matches.matchDetail.dob Is match against dob field.
monitorRecords.matches.matchDetail.yob Is match against yob field.

Classification: Confidential
 monitorRecords.matches.matchDetail.businessName Is match against name field.
monitorRecords.matches.matchDetail.alias Is match against alias field.
monitorRecords.matches.matchDetail.partialName Is match against address2 field.
monitorRecords.matches.matchDetail.partialAlias Is partial match against alias field.
monitorRecords.matches.matchDetail.reverseName Is reverse match against name field.
monitorRecords.matches.matchDetail.address1 Is match against address1 field.
monitorRecords.matches.matchDetail.address2 Is match against address2 field.
monitorRecords.matches.matchDetail.address3 Is match against address3 field.
monitorRecords.matches.matchDetail.address6 Is match against address6 field.
monitorRecords.matches.matchDetail.postcode Is match against postcode field.
monitorRecords.matches.comments.comment Comment text.
monitorRecords.matches.comments.dateAdded Comment insert date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.comments.userId User id.
monitorRecords.matches.attachments.fileName Attachment file name.
monitorRecords.matches.attachments.attachmentPath Patch to access attachment. Add proper
domain at the beginning for KYC6 e.g.
https://kyc6.com/ for live and
https://uat.kyc6.com/ for UAT
monitorRecords.matches.attachments.dateAdded Attachment add date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.attachments.userId User id.
monitorRecords.matches.statusHistory.status Status name
monitorRecords.matches.statusHistory.date Status change date. Format: yyyy-mm-dd
hh:mm:ss
monitorRecords.matches.statusHistory.userId User id.

Classification: Confidential
Person Get by Quick Reference (QR) Code

This endpoint allows authenticated users to retrieve a person profile using the Quick Reference (QR)
code - The person QR code is passed in URL.

Sample JSON Get Person by QR Code Request:

Request Type: GET
Request URL (LIVE) https://api1.c6-
intelligence.com/monitorApi/v1_0/api/persons/qr?personId={QRCode}
Request URL (UAT) https://api1.uat.c6-
intelligence.com/monitorApi/v1_0/api/persons/qr?personId={QRCode}
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

Sample JSON Person Get by QR Code Response: (E.g. QR = 116301)

{
"recordsFound": 1,
"matches": [
{
"score": 73,
"person": {
"id": 116301,
"title": {
"description": "Mr"
},
"alternativeTitle": null,
"forename": "Vladimir",
"middlename": "Vladimirovich",
"surname": "Putin",
"dateOfBirth": "1952-10-07",
"yearOfBirth": 1952,
"dateOfDeath": null,
"yearOfDeath": null,
"isDeceased": false,
"gender": "Male",
"nationality": {
"nationality": "Russian"
},

Classification: Confidential
 "imageURL": "https://secure.c6-intelligence.com/c6images/0020715000/0020712831.jpg",
"telephoneNumber": "",
"faxNumber": "",
"mobileNumber": "",
"email": "",
"pepLevel": 1,
"isPEP": true,
"isSanctionsCurrent": false,
"isSanctionsPrevious": false,
"isLawEnforcement": false,
"isFinancialregulator": false,
"isDisqualifiedDirector": false,
"isInsolvent": false,
"isAdverseMedia": false,
"addresses": [
{
"address1": "23 Ilinkina Street",
"address2": "",
"address3": "",
"address4": "",
"city": "Moscow",
"county": "",
"postcode": "103132",
"country": {
"name": "Russia"
}
}
],
"aliases": [
{
"title": {
"description": "Mr"
},
"alternativeTitle": null,
"forename": "Владимир",
"middlename": "Владимирович",
"surname": "Путин"
}
],
"articles": [
{
"originalURL": "http://www.atimes.com/c-asia/BG14Ag04.html",
"dateCollected": "2016-05-16",
"c6URL": "",
"categories": [
{

Classification: Confidential
 "name": "PEP"
},
{
"name": "Adverse Media"
}
],
"snippet": {
"title": "UPDATE 2-Money manager, arts patron gets 9 yrs prison",
"summary": "...trimmed...",
"keywordsMatched": [
"sentence",
"arrested"
]
}
},
{
"originalURL": "http://www.atimes.com/c-asia/BG14Ag02.html",
"dateCollected": "2016-05-16",
"c6URL": "https://secure.c6-intelligence.com/c6images/0000130000/0000127055.pdf",
"categories": [
{
"name": "PEP"
}
],
"snippet": null
}

],
"sanctions": [
{
"sanctionType": {
"description": "EU"
},
"isCurrent": false
},
],
"notes": [
{
"dataSource": {
"name": "C6 Intelligence"
},
"text": "Currently listed as a sanctioned individual by OFAC"
}
],
"linkedBusinesses": [
{

Classification: Confidential
 "businessId": 41263,
"businessName": "Gazprom OJSC",
"position": "Shareholder (4,5%)"
}
],
"linkedPersons": [
{
"personId": 4887619,
"name": "Nadezhda Aleksandrovna Krasnoyarova",
"association": "Surgutneftegas"
},
{
"personId": 1191306,
"name": "Lyudmila Alexandrovna Putina",
"association": "Lyudmila Putina is the former spouse of Vladimir Putin"
}
],
"politicalPositions": [
{
"description": "Former President of the Federation (2 Terms)",
"from": "31 December 1999",
"to": "7 May 2008",
"country": {
"name": "Russia"
}
}
]
}
}
]
}

Response Fields Description:

Field Name Description
recordsFound Number of matched profiles.
matches Array of matched person profiles.
matches.score Matching score for matched person profile.
matches.person.id Matched person id, also known as QuickReference (QR) code.
matches.person.title.description Person title, one of the following values: ”None”, “Mr” “Mrs”,
“Miss”, “Ms”, “Dr”.
matches.person.alternativeTitle Alternative person title i.e. “Sir”, “Prof.” etc.
matches.person.forename Matched profile’s forename.
matches.person.middlename Matched profile’s middle name.
matches.person.surname Matched profile’s surname.
matches.person.dateOfBirth Matched profile’s date of birth. Format: yyyy-MM-dd
matches.person.yearOfBirth Matched profile’s year of birth

Classification: Confidential
 matches.person.dateOfDeath Matched profile’s date of death. Format: yyyy-MM-dd
matches.person.yearOfDeath Matched profile’s year of death
matches.person.isDeceased Matched profile is dead.
matches.person.gender Matched profile’s gender: “Male”, “Female” or “Unknown”
matches.person.nationality.nationality Matched profile’s nationality
matches.person.imageURL Link to matched profile’s photo
matches.person.telephoneNumber Matched profile’s home phone number
matches.person.faxNumber Matched profile’s fax number
matches.person.mobileNumber Matched profile’s mobile number
matches.person.email Matched profile’s email
matches.person.pepLevel Matched profile’s PEP level. Possible values are: null, 1,2,3 or
4
matches.person.isPEP Matched profile is a PEP
matches.person.isSanctionsCurrent Matched profile is currently sanctioned. Sanction details are
returned in “Sanctions” section
matches.person.isSanctionsPrevious Matched profile was sanctioned in the past. Sanction details
are returned in “Sanctions” section
matches.person.isLawEnforcement Matched profile belongs to “Law Enforcement” dataset
matches.person.isFinancialregulator Matched profile belongs to “Financial Regulator” dataset
matches.person.isDisqualifiedDirector Matched profile belongs to “Disqualified Director” dataset
matches.person.isInsolvent Matched profile belongs to “Insolvency” dataset
matches.person.isAdverseMedia Matched profile belongs to “Adverse Media” dataset
matches.person.addresses Array of addresses linked with matched profile
matches.person.addresses.address1 1st part of address
matches.person.addresses.address2 2nd part of address
matches.person.addresses.address3 3rd part of address
matches.person.addresses.address4 4th part of address
matches.person.addresses.city address, city
matches.person.addresses.county address, county/state
matches.person.addresses.postcode address, postcode
matches.person.addresses.country.name address, country name
matches.person.aliases Array of aliases for matched profile
matches.person.alias.title.description Alias title, one of the following values: “None”, “Mr”, “Mrs”,
“Miss”, “Ms”, “Dr”.
matches.person.alias.alternativeTitle Alternative alias title i.e. “Sir”, “Prof.” etc.
matches.person.alias.forename Matched alias forename.
matches.person.alias.middlename Matched alias middle name.
matches.person.alias.surname Matched alias surname.
matches.person.articles Array of articles (documents) linked with matched profile
matches.person.articles.originalURL Link to original website
matches.person.articles.dateCollected Date, article was collected by C6. Format: yyyy-MM-dd
matches.person.articles c6URL Link to article (original website converted to PDF). If this is
blank then there will be a snippet node.
matches.person.articles.categories Array of categories for article
matches.person.articles.categories.name Name of article category. Possible values are: “PEP”,
”Sanctions”, “Financial Regulator”, “Law Enforcement”,
“Disqualified Director”, “Insolvent”, “Adverse Media”, “ID/V”,”
Corporate/Business”
matches.person.articles.snippet By default, the snippet node is null. If, however the c6URL is
blank, the snippet node will be present as follows.

Classification: Confidential
 matches.person.articles.snippet.title The title of the original article.
matches.person.articles.snippet.summary An extract from the adverse media article representing the key
content of the article.
matches.person.articles.snippet.keywordsMatched An array of adverse keywords that were matched in the article
text.
matches.person.sanctions Array of sanctions for matched profile
matches.person.sanctions.sanctionType.description Sanction description. Possible values: “HMT”,
“OFAC”,”EU”,”UN”, “Austrac”.
matches.person.sanctions.isCurrent Current (true) or previous (false) sanction.
matches.person.notes Array of notes added to matched profile.
matches.person.notes.datasource.name Source of the note.
matches.person.notes.text Note.
matches.person.linkedBusinesses Array of businesses linked with matched profile.
matches.person.linkedBusinesses.businessId Id (QR) of linked business.
matches.person.linkedBusinesses.businessName Name of linked business.
matches.person.linkedBusinesses.position Position of matched profile in business.
matches.person.linkedPersons Array of persons associated with matched profile.
matches.person.linkedPersons.personId Id (QR) of linked person.
matches.person.linkedPersons.name Name of linked person.
matches.person.linkedPersons.association Describes association between matched profile and linked
person.
matches.person.politicalPositions Array of political positions for matched profile.
matches.person.politicalPositions.description Description of political role.
matches.person.politicalPositions.from Political role start date.
matches.person.politicalPositions.to Political role end date.
matches.person.politicalPositions.country.name Political role country.

Classification: Confidential
Add Comment to Match - Person

This endpoint allows users to add comments to a person match.

Sample JSON Add Comment to Match - Person Request:

Request Type POST
Request URL /monitorApi/v1_0/api/persons/status/{matchId}?status={status}&comment={comment}
Request URL (LIVE) https://api1.c6-
intelligence.com/monitorApi/v1_0/api/persons/status/{matchId}?status=No%20Match&
comment=Test%20Comment
Request URL (UAT) https://api1.uat.c6-
intelligence.com/monitorApi/v1_0/api/persons/status/{matchId}?status=No%20Match&
comment=Test%20Comment
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Required Field Restrictions Description
Name
matchId Yes Text Person/business matchId
status Yes Match status – either; Status of match
1) Match - No Risk
2) Match - Risk
3) No Match

(Character space
replaced by %20 for
ASCII)
comment No Text, 2000 max Comment to match
(Character space
replaced by %20 for
ASCII)

Classification: Confidential
Sample Add Comment to Person Match Response:
No Content

Classification: Confidential
Business Get by Quick Reference (QR) Code

This endpoint allows authenticated users to retrieve a business profile using the Quick Reference
(QR) code - The Business QR code is passed in URL.

Sample JSON Get Business by QR Code Request:

Request Type: GET
Request URL https://api1.c6-
(LIVE) intelligence.com/MonitorApi/v1_0/api/businesses/qr?businessId=QRCode}
Request URL https://api1.uat.c6-intelligence.com/
(UAT) MonitorApi/v1_0/api/businesses/qr?businessId=QRCode}
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

Sample JSON Get Business by QR Code Response (E.g. QR = 41263)

{
"id": 41263,
"businessName": "Gazprom OJSC",
"telephoneNumber": "+7 (495) 719 30 01",
"faxNumber": "+7 (495) 719 83 33",
"website": "www.gazprom.ru",
"isPEP": true,
"isSanctionsCurrent": false,
"isSanctionsPrevious": true,
"isLawEnforcement": false,
"isFinancialregulator": false,
"isDisqualifiedDirector": false,
"isInsolvent": false,
"isAdverseMedia": false,
"addresses": [
{
"address1": "16 Nametkina Street",
"address2": "",
"address3": "",
"address4": "",
"city": "Moscow",
"county": "",
"postcode": "117997",

Classification: Confidential
 "country": {
"name": "Russia"
}
}
],
"aliases": [
{
"businessName": "Gasprom"
},
],
"articles": [
{
"originalURL": "http://www.tadviser.ru/index.php",
"dateCollected": "2016-11-01",
"c6URL": "",
"categories": [
{
"name": "PEP"
},
{
"name": "ID/V"
},
{
"name": "Adverse Media"
}
],
"snippet": {
"title": "UPDATE 2-Money manager, arts patron gets 9 yrs prison",
"summary": "...trimmed...",
"keywordsMatched": [
"sentence",
"arrested"
]
}
},
{
"originalURL": "http://www.tadviser.ru/index.php",
"dateCollected": "2016-11-01",
"c6URL": "https://secure.c6-intelligence.com/c6images/0021195000/0021194450.pdf",
"categories": [
{
"name": "PEP"
}
],
"snippet": null
}

Classification: Confidential
 ],
"sanctions": [
{
"sanctionType": {
"description": "OFAC"
},
"isCurrent": true
}
],
"notes": [
{
"dataSource": {
"name": "C6 Intelligence"
},
"text": "Currently listed as a sanctioned business by OFAC"
}
],
"linkedBusinesses": [
{
"businessId": 420392,
"businessName": "RosUkrEnergo",
"linkDescription": "RosUkrEnergo is a subsidiary of Gazprom"
}
],
"linkedPersons": [
{
"personId": 26659,
"name": "Viktor Borisovich Khristenko",
"position": "Member of the Board of Directors"
}
]
}

Response Fields Description:

Field Name Description
recordsFound Number of matched profiles.
matches Array of matched business profiles.
matches.score Matching score for matched business profile.
matches.business Object containing matched profile data.
matches.business.id Matched business id, also known as QuickReference (QR)
code.
matches.business.businessName Matched business name.
matches.business.telephoneNumber Matched profile’s home phone number.
matches.business.faxNumber Matched profile’s fax number.
matches.business.website Matched profile’s website.
matches.business.isPEP Matched profile is a PEP.

Classification: Confidential
 matches.business.isSanctionsCurrent Matched profile is currently sanctioned. Sanction details
are returned in “Sanctions” section.
matches.business.isSanctionsPrevious Matched profile was sanctioned in the past. Sanction
details are returned in “Sanctions” section.
matches.business.isLawEnforcement Matched profile belongs in “Law Enforcement” dataset.
matches.business.isFinancialregulator Matched profile belongs to “Financial Regulator”
dataset.
matches.business.isDisqualifiedDirector Matched profile belongs to “Disqualified Director”
dataset.
matches.business.isInsolvent Matched profile belongs to “Insolvency” dataset.
matches.business.isAdverseMedia Matched profile belongs to “Adverse Media” dataset.
matches.business.addresses Array of addresses linked with matched profile.
matches.business.addresses.address1 1st part of address.
matches.business.addresses.address2 2nd part of address.
matches.business.addresses.address3 3rd part of address.
matches.business.addresses.address4 4th part of address.
matches.business.addresses.city address, city.
matches.business.addresses.county address, county/state.
matches.business.addresses.postcode address, postcode.
matches.business.addresses.country.name address, country name.
matches.business.aliases Array of aliases for matched profile.
matches.business.alias.businessName Alternative business name/
matches.business.articles Array of articles (documents) linked with matched
profile.
matches.business.articles.originalURL Link to original website.
matches.business.articles.dateCollected Date, article was collected by C6. Format: yyyy-MM-dd
matches.business.articles c6URL Link to article (original website converted to PDF).
matches.business.articles.categories Array of categories for article.
matches.business.articles.categories.name Name of article category. Possible values are: “PEP”,
”Sanctions”, “Financial Regulator”, “Law Enforcement”,
“Disqualified Director”, “Insolvent”, “Adverse Media”,
“ID/V”,” Corporate/Business”.
articles.snippet By default, the snippet node is null. If, however the c6URL
is blank, the snippet node will be present as follows.
articles.snippet.title The title of the original article.
articles.snippet.summary An extract from the adverse media article representing
the key content of the article.
articles.snippet.keywordsMatched An array of adverse keywords that were matched in the
article text.
matches.business.sanctions Array of sanctions for matched profile.
matches.business.sanctions.sanctionType.description Sanction description. Possible values: “HMT”,
“OFAC”,”EU”,”UN”, “Austrac”.
matches.business.sanctions.isCurrent Current (true) or previous (false) sanction.
matches.business.notes Array of notes added to matched profile.
matches.business.notes.datasource.name Source of the note.
matches.business.notes.text Note.
matches.business.linkedBusinesses Array of businesses linked with matched profile.
matches.business.linkedBusinesses.businessId Id (QR) of linked business.
matches.business.linkedBusinesses.businessName Name of linked business.

Classification: Confidential
 matches.business.linkedBusinesses.linkDescription Description of association between matched and linked
business.
matches.business.linkedPersons Array of persons linked with matched profile.
matches.business.linkedPersons.personId Id (QR) of linked person.
matches.business.linkedPersons.name Name of linked person.
matches.business.linkedPersons.position Position of linked person in matched business.

Classification: Confidential
Add Comment to Match - Business

This endpoint allows users to add comments to a business match.

Sample JSON Add Comment to Match - Business Request:
Request Type POST
Request URL /monitorApi/v1_0/api/businesses/status/{matchId}?status={status}&comment={comme
nt}
Request URL (LIVE) https://api1.c6-
intelligence.com/monitorApi/v1_0/api/businesses/status/{matchId}?status=No%20Matc
h&comment=Test%20Comment
Request URL (UAT) https://api1.uat.c6-
intelligence.com/monitorApi/v1_0/api/businesses/status/{matchId}?status=No%20Matc
h&comment=Test%20Comment
Request Headers:
apiKey <your_api_key_here>
Content-Type application/json; charset=utf-8
Host api1.c6-intelligence.com Note: Host for LIVE environment
Host api1.uat.c6-intelligence.com Note: Host for UAT environment

URL Parameters:
Parameter Required Field Restrictions Description
Name
matchId Yes Text Person/business matchId
status Yes Match status – either; Status of match
1) Match - No Risk
2) Match - Risk
3) No Match

(Character space
replaced by %20 for
ASCII)
comment No Text, 2000 max Comment to match
(Character space
replaced by %20 for
ASCII)

Sample Add Comment to Match – Business Response:

No Content

Classification: Confidential