Follow these step-by-step instructions for retrieving all information/data related to a case:
// Authentication: ApiKey in request headers
// STEP 1: Get a list of all cases for your instance.
// https://api.icomplykyc.com/api/v2/case-management?sortCriteria=created&sortOrder=1&limit=10&skip=0¤tPage=1
// Body: JSON Example:
// {"status":"potential","filters":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]}
/* Where the values for the filters represent the following values:
Sanction = 0
Warning = 1
FitnessProbity = 2
Pep = 3
PepClass1 = 4
PepClass2 = 5
PepClass3 =6
PepClass4 = 7
AdverseMedia = 8
AdverseMediaFinancialCrime = 9
AdverseMediaViolentCrime = 10
AdverseMediaSexualCrime = 11
AdverseMediaTerrorism = 12
AdverseMediaFraud = 13
AdverseMediaNarcotics = 14
AdverseMediaGeneral = 15
AllSanctionsWarningsFitnessProbity = 16
*/
{
"code": 200,
"status": "success",
"message": "",
"data": {
"data": [
{
"id": 12345,
"created": "2024-11-25T16:03:41",
"name": "TD SECURITIES INC.",
"runBy": "John Doe",
"ongoing": true,
"potential": 5,
"caseStatus": "Open",
"commentsCount": 2,
"processing": false,
"attachedTo": [],
"updatedByOM": false
},
{
"id": 12346,
"created": "2024-11-25T16:02:33",
"name": "TD SECURITIES INC.",
"runBy": "John Doe",
"ongoing": true,
"potential": 5,
"caseStatus": "Open",
"commentsCount": 2,
"processing": false,
"attachedTo": [],
"updatedByOM": false
}
],
"paginationData": {
"totalPages": 10,
"currentPage": 1,
"limit": 10,
"skip": 0,
"total": 100
}
}
}
// Get details of a specific search
// https://api.icomplykyc.com/api/v2/case-management/12345
{
"code": 200,
"status": "success",
"message": "",
"data": {
"attachedTo": [],
"searchTerm": "td bank",
"year": null,
"countries": "",
"fuzziness": 30,
"created": "2024-11-20 13:17:39",
"runBy": "John Doe",
"assignedTo": " ",
"assignedToId": null,
"complianceLogId": 16574,
"onGoing": false,
"consolidatedMatchTypes": [
8,
9,
13,
15,
14,
12,
10,
1,
2
],
"requestedAmlTypes": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16
],
"commentsCount": 9,
"potentialHitsCount": 14,
"unknownHitsCount": 2,
"rejectedHitsCount": 3,
"acceptedHitsCount": 2,
"caseStatus": "Open",
"entityType": 0,
"updatedByOM": false
}
}
// STEP 2: Get a list of all potential hits for a search.
// https://api.icomplykyc.com/api/v2/case-management/16574/matches-table?sortCriteria=name&sortOrder=0&limit=7&skip=7¤tPage=1
// Request Method: POST
// Body: JSON Example:
// {"status":"potential","filters":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]}
/* Where the values for the filters represent the following values:
Sanction = 0
Warning = 1
FitnessProbity = 2
Pep = 3
PepClass1 = 4
PepClass2 = 5
PepClass3 =6
PepClass4 = 7
AdverseMedia = 8
AdverseMediaFinancialCrime = 9
AdverseMediaViolentCrime = 10
AdverseMediaSexualCrime = 11
AdverseMediaTerrorism = 12
AdverseMediaFraud = 13
AdverseMediaNarcotics = 14
AdverseMediaGeneral = 15
AllSanctionsWarningsFitnessProbity = 16
*/
{
"code": 200,
"status": "success",
"message": "",
"data": {
"hits": {
"data": [
{
"hitId": "BMGXZWYZ73PY3K5",
"entityType": "organisation",
"name": "TD BANK USA",
"matched": [
9,
15,
1
],
"countries": "Canada, United States",
"relevance": "Name matched exactly",
"status": "potential",
"commentsCount": 0,
"riskTypeCount": 4,
"resultsFound": 23,
"updatedByOM": false,
"deprecated": false
},
{
"hitId": "LBK5CK6FW74V5K2",
"entityType": "organisation",
"name": "TD Bank USA NA CO Target Enterprise Inc.",
"matched": [
15
],
"countries": "United States",
"relevance": "Name matched exactly",
"status": "potential",
"commentsCount": 0,
"riskTypeCount": 2,
"resultsFound": 1,
"updatedByOM": false,
"deprecated": false
}
],
"paginationData": {
"totalPages": 2,
"currentPage": 2,
"limit": 7,
"skip": 7,
"total": 14
}
},
"counts": {
"potentialCount": 14,
"unknownCount": 2,
"rejectedCount": 3,
"acceptedCount": 2
}
}
}
// STEP 3: Get the details of a hit for a particular case.
// Request Method: GET
// https://api.icomplykyc.com/api/v2/case-management/12345/hits/9VXJVW1V3G6YUYT
{
"code": 200,
"status": "success",
"message": "",
"data": {
"complianceLogId": 12345,
"hitId": "9VXJVW1V3G6YUYT",
"searchTerm": "td bank",
"searchResult": "TD Bank",
"countries": "Canada, France, Spain, United States",
"entityType": "Legal Entity",
"alternativeNames": "TD Bank, TD Bank National Association, TD Bank NA, TD Banka, TD Bank N.A., TD Bank, N.A., TD Bank, National Association",
"consolidatedMatchTypes": [
8,
9,
15,
14,
2,
1
],
"attachedTo": [],
"year": null,
"created": "2024-11-20 13:17:39",
"runBy": "John Doe",
"assignedTo": " ",
"assignedToId": null,
"fuzziness": 30,
"ongoingMonitoring": false,
"caseStatus": "Open",
"listingsCounter": 6,
"adverseMediaCounter": 12,
"documentsCounter": 3,
"potentialCounter": 21,
"unknownCounter": 2,
"rejectedCounter": 3,
"acceptedCounter": 2
}
}
// STEP 4: Get a list for a specific hit type, such as adverse media
// Request Method: GET
// https://api.icomplykyc.com/api/v2/case-management/16574/hits/9VXJVW1V3G6YUYT/adverse-media
{
"code": 200,
"status": "success",
"message": "",
"data": {
"adverseMedia": {
"data": [
{
"id": 791943,
"status": "potential",
"date": null,
"snippet": "Dr. Dominick A. Lembo v. Arlene Marchese (A-92-18) (082930) Argued January 22, 2020 -- Decided June 17, 2020 ALBIN, J., writing for the Court. In this case, the Court considers whether the trial court properly dismissed the common law claims of conversion and negligence that Dr. Dominick Lembo brought against TD Bank National Association, as well as whether the Uniform Fiduciaries Law (UFL) provides an affirmative cause of action against the bank. Dr. Lembo employed in his dental practice Arlene Marchese, his office manager, and Karen Wright, a dental hygienist.",
"title": "A-92-18 - Dr. Dominick A. Lembo v. Arlene Marchese (082930) (Passaic County and Statewide)",
"url": "https://www.njcourts.gov/system/files/court-opinions/2020/a_92_18.pdf",
"assignedUserId": null,
"assignedUser": null,
"updatedByOM": false
},
{
"id": 791485,
"status": "potential",
"date": null,
"snippet": "U.S. Treasury Dept says settlement reached over TD Bank's sanctions violations The U.S. Treasury Department on Thursday reached a $115,000 settlement of two cases involving banking group TD Bank NA for apparent violations of narcotics kingpin and North Korea sanctions. Canada's TD Bank delays office return over Omicron fears",
"title": "TD.TO - Toronto-Dominion Bank Profile | Reuters",
"url": "https://www.reuters.com/companies/TD.TO",
"assignedUserId": null,
"assignedUser": null,
"updatedByOM": false
},
{
"id": 791479,
"status": "potential",
"date": "2012-07-20T00:00:00Z",
"snippet": ": (803) 345-9171 July 6, 2012 Chapin, South Carolina SUMMONS AND COMMON PLEAS 2012-CP-40-03618 SCBT, N.A., f/k/a South Carolina Bank and Trust, N.A., Plaintiff, against SEL Properties, L.L.C., Stephen E. Lipscomb Banta Associates, LLC, TD Bank National Association, Michael Rodney Spence, Ronald Spence, Petroleum Equipment Company, Inc. n/k/a Jones & Frank Corp., Defendants. TO",
"title": "Public Notices - Legal Advertisements | www.thecolumbiastar.com | Columbia Star",
"url": "http://www.thecolumbiastar.com/news/2012-07-20/Public_Notices/Public_Notices__Legal_Advertisements.html",
"assignedUserId": null,
"assignedUser": null,
"updatedByOM": false
}
],
"paginationData": {
"totalPages": 2,
"currentPage": 1,
"limit": 10,
"skip": 0,
"total": 12
}
},
"counts": {
"potentialCount": 12,
"unknownCount": 0,
"rejectedCount": 0,
"acceptedCount": 0,
"fullListingsCount": 0,
"adverseMediaCount": 12
}
}
}
// Step 5: Get details of other related case information
/*
These endpoints will return additional information related to a search/case:
https://api.icomplykyc.com/api/v2/case-management/{complianceLogId}/hits/{hitId}/documents
https://api.icomplykyc.com/api/v2/case-management/{complianceLogId}/hits/{hitId}/comments
*/