Friday, October 03, 2025

Client - Match Potential
Action:
GET ROWS
Method:
GET
URL: /api/v1/client/matchpotential/getrows
Description: Fetch Match Potential records based on Row information
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params RowOffset Int32 Row Offset
Params RowsToFetch Int32 Rows to Fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Row Statistics and collection of Client Match Potential records
{
 "RowsHeader": {
  "RowOffset": 0,
  "RowsFetched": 1,
  "RowStart": 1,
  "RowEnd": 1,
  "RowVolume": 24
 },
 "Data": [
  {
   "ClientEntityID": 1234,
   "ClientEntityInterfaceReference": "AB1234",
   "ClientEntityLastName": "PUTIN",
   "ClientEntityFirstName": "VLADIMIR",
   "ClientEntityMiddleName": "",
   "EntityID": 98141,
   "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
   "EntityLastName": "PUTIN",
   "EntityLastNameJCBias": 1,
   "EntityFirstName": "VLADIMIR",
   "EntityFirstNameJCBias": 1,
   "EntityMiddleName": "VLADIMIROVICH",
   "EntityMiddleNameJCBias": 0,
   "GeneratedDate": "2025-10-03 00:00:00",
   "AverageJCBias": 1,
   "IsPEP": true,
   "IsRCA": false,
   "IsWBL": false,
   "IsSAN": false,
   "IsAVM": false,
   "IsOTH": false,
   "IsUNK": false,
   "IsDateMatch": true,
   "IsCountryMatch": true,
   "CriteriaID": 5,
   "CriteriaName": "Default - Person High Risk",
   "Note": "",
   "Status": 4,
   "Priority": 9,
   "MetaBump": 55,
   "HandledByUserGroupID": "203",
   "HandledByUserGroupName": "Handler Group",
   "HandledByUserID": "0",
   "HandledByUserName": "",
   "ReportData": "",
   "ClientAliasEntityId": 3,
   "AliasInterfaceReference": "AB1234-Alias"
  }]
}
Field Data Type
RowsHeader Collection
 RowOffset Int 32
 RowsFetched Int 32
 RowStart Int 32
 RowEnd Int 32
 RowVolume Int 32
Data Collection
 ClientEntityID Int 32
 ClientEntityInterfaceReference Text 50
 ClientEntityLastName Text 255
 ClientEntityFirstName Text 255
 ClientEntityMiddleName Text 255
 EntityID Int 32
 EntityFullName Text 255
 EntityLastName Text 255
 EntityLastNameJCBias Double
 EntityFirstName Text 255
 EntityFirstNameJCBias Double
 EntityMiddleName Text 255
 EntityMiddleNameJCBias Double
 GeneratedDate Date
 AverageJCBias Double
 IsPEP Boolean
 IsRCA Boolean
 IsWBL Boolean
 IsSAN Boolean
 IsAVM Boolean
 IsOTH Boolean
 IsUNK Boolean
 IsDateMatch Boolean
 IsCountryMatch Boolean
 CriteriaID Int 16
 CriteriaName Text 150
 Note Text 2GB
 Status Byte
 Priority Byte
 MetaBump Byte
 HandledByUserGroupID Int 16
 HandledByUserGroupName Text 150
 HandledByUserID Int 16
 HandledByUserName Text 150
 ReportData Base64 String
 ClientAliasEntityId Int 32
 AliasInterfaceReferencee Text 50
Client - Match Potential [Using External Reference]
Action:
GET
Method:
GET
URL: /api/v1/client/matchpotential/get
Description: Fetch Match Potential records based on Interface Reference. Only Entity Interface References can be passed here. Does not accept Alias Interface References.
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params InterfaceReference String Interface Reference
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Match Potential records
[{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityLastNameJCBias": 1,
 "EntityFirstName": "VLADIMIR",
 "EntityFirstNameJCBias": 1,
 "EntityMiddleName": "VLADIMIROVICH",
 "EntityMiddleNameJCBias": 0,
 "GeneratedDate": "2025-10-03 00:00:00",
 "AverageJCBias": 1,
 "IsPEP": true,
 "IsRCA": false,
 "IsWBL": false,
 "IsSAN": false,
 "IsAVM": false,
 "IsOTH": false,
 "IsUNK": false,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "CriteriaID": 3,
 "DataSourceProvider": 0,
 "CriteriaName": "Default - Person Medium Risk",
 "Note": "",
 "Status": 4,
 "Priority": 9,
 "MetaBump": 55
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "DateMeta": null,
 "CountryMeta": null,
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}]
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReferenceText 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityLastNameJCBias Double
EntityFirstName Text 255
EntityFirstNameJCBias Double
EntityMiddleName Text 255
EntityMiddleNameJCBias Double
GeneratedDate Date
AverageJCBias Double
IsPEP Boolean
IsRCA Boolean
IsWBL Boolean
IsSAN Boolean
IsAVM Boolean
IsOTH Boolean
IsUNK Boolean
IsDateMatch Boolean
IsCountryMatch Boolean
CriteriaID Int 16
DataSourceProvider Int 16
CriteriaName Text 150
Note Text 2GB
Status Byte
Priority Byte
MetaBump Byte
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
DateMeta String
CountryMeta String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50
Action:
MATCH
Method:
POST
URL: api/v1/client/matchpotential/match
Description: Match a Client Match Potential record by converting it into a Client Match Discounted or Flagged Record based on Interface Reference. Only Entity Interface References can be passed here. Does not accept Alias Interface References.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body InterfaceReference String Interface Reference
Body EntityID Int32 Dow Jones Entity Identifier
Body MatchType String Discount or Flag
Body Reason String Reason
Body MatchCategoryID Int16 Match Discount or Flag Category Identifier
Body ValidToDate Date Valid to Date yyyy-mm-dd
Body Notify Boolean Notify True or False
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Discounted or Flagged record generated post match.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2025-10-03 00:00:00",
 "MatchedDate": "2025-10-03 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 8,
 "MatchFlagCategoryName": "Relevant Not Acceptable - High Risk PEP",
 "MetaDataDate": "07 Oct 1952",
 "MetaDataCountry": "Citizenship : Russia | Jurisdiction : Russia | Resident of : Russia",
 "ValidToDate": "2099-12-31 00:00:00",
 "Notify": true,
 "HandledByUserGroupID": "203",
 "HandledByUserGroupName": "Handler Group",
 "HandledByUserID": "105",
 "HandledByUserName": "Fred Jones",
 "ReportData": "",
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Reason Text 25,000
MatchFlagCategoryID Int 16
MatchFlagCategoryName Text 150
MetaDataDate Text 750
MetaDataCountry Text 750
ValidToDate Date
Notify Boolean
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
ReportData Base64 String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50
Client - Match Potential [Using Internal Reference]
Action:
GET INTERNAL
Method:
GET
URL: /api/v1/client/matchpotential/getinternal
Description: Fetch Match Potential records based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientEntityID Int32 Client Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Match Potential records
[{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityLastNameJCBias": 1,
 "EntityFirstName": "VLADIMIR",
 "EntityFirstNameJCBias": 1,
 "EntityMiddleName": "VLADIMIROVICH",
 "EntityMiddleNameJCBias": 0,
 "GeneratedDate": "2025-10-03 00:00:00",
 "AverageJCBias": 1,
 "IsPEP": true,
 "IsRCA": false,
 "IsWBL": false,
 "IsSAN": false,
 "IsAVM": false,
 "IsOTH": false,
 "IsUNK": false,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "CriteriaID": 3,
 "DataSourceProvider": 0,
 "CriteriaName": "Default - Person Medium Risk",
 "Note": "",
 "Status": 4,
 "Priority": 9,
 "MetaBump": 55
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "DateMeta": null,
 "CountryMeta": null,
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}]
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReferenceText 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityLastNameJCBias Double
EntityFirstName Text 255
EntityFirstNameJCBias Double
EntityMiddleName Text 255
EntityMiddleNameJCBias Double
GeneratedDate Date
AverageJCBias Double
IsPEP Boolean
IsRCA Boolean
IsWBL Boolean
IsSAN Boolean
IsAVM Boolean
IsOTH Boolean
IsUNK Boolean
IsDateMatch Boolean
IsCountryMatch Boolean
CriteriaID Int 16
DataSourceProvider Int 16
CriteriaName Text 150
Note Text 2GB
Status Byte
Priority Byte
MetaBump Byte
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
DateMeta String
CountryMeta String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50
Action:
MATCH INTERNAL
Method:
POST
URL: api/v1/client/matchpotential/matchinternal
Description: Match a Client Match Potential record by converting it into a Client Match Discounted or Flagged Record based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientEntityID Int32 Client Entity Identfier
Body EntityID Int32 Dow Jones Entity Identifier
Body MatchType String Discount or Flag
Body Reason String Reason
Body MatchCategoryID Int16 Match Discount or Flag Category Identifier
Body ValidToDate Date Valid to Date yyyy-mm-dd
Body Notify Boolean Notify True or False
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Discounted or Flagged record generated post match.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2025-10-03 00:00:00",
 "MatchedDate": "2025-10-03 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 8,
 "MatchFlagCategoryName": "Relevant Not Acceptable - High Risk PEP",
 "MetaDataDate": "07 Oct 1952",
 "MetaDataCountry": "Citizenship : Russia | Jurisdiction : Russia | Resident of : Russia",
 "ValidToDate": "2099-12-31 00:00:00",
 "Notify": true,
 "HandledByUserGroupID": "203",
 "HandledByUserGroupName": "Handler Group",
 "HandledByUserID": "105",
 "HandledByUserName": "Fred Jones",
 "ReportData": "",
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Reason Text 25,000
MatchFlagCategoryID Int 16
MatchFlagCategoryName Text 150
MetaDataDate Text 750
MetaDataCountry Text 750
ValidToDate Date
Notify Boolean
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
ReportData Base64 String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50
Action:
REASSIGN
Method:
POST
URL: /api/v1/client/matchpotential/reassign
Description: Reassign/Unassign a Client Match Potential based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body ClientEntityID Int32 Client Entity Identifier
Body HandledByUserGroupID Int16 Identifier of the User Group to reassign Client Match Potential to.
Body AssignToUserID Int16 Identifier of the User to reassign Client Match Potential to.
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Entity with updated ownership information after reassign.
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 5000,
 "InterfaceReference": "VP123",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 9,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": null,
 "Country1ID": 0,
 "Country1Name": "Unknown",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": 204,
 "HandledByUserGroupName": "Admin Group",
 "HandledByUserID": 102,
 "HandledByUserName": "Chandramohan Ganorkar",
 "RiskID": 10,
 "RiskName": "Medium",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2025-10-03 00:00:00",
 "CustomText1": "",
 "CustomText2": "",
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2025-10-03 00:00:00"
}
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Text 255
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
CriteriaID Int 16
CriteriaName Text 150
GenderID Byte
GenderName Text 150
Date Date
Country1ID Int 16
Country1Name Text 255
Country2ID Int 16
Country2Name Text 255
Country3ID Int 16
Country3Name Text 255
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
RiskID Int 16
RiskName Text 150
StatusID Byte
StatusName Text 150
DateAdded Date
CustomText1 Text 255
CustomText2 Text 255
AdverseMediaFileCriteriaID Int 16
AdverseMediaDateRangeID Int 16
AdverseMediaCountryID Int 16
AdditionalAndTerms Text 256
AdditionalOrTerms Text 256
ExcludeTerms Text 256
AdverseMediaDateLastScreened Date
Action:
TAKEOWNERSHIP
Method:
POST
URL: /api/v1/client/matchpotential/takeownership
Description: Take ownership of a Client Match Potential based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientEntityID Int32 Client Entity Identifier
Body HandledByUserGroupID Int16 Identifier of the User Group for ownership of the Client Match Potential.
Body UserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Entity with updated ownership information.
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 5000,
 "InterfaceReference": "VP123",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 9,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": null,
 "Country1ID": 0,
 "Country1Name": "Unknown",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": 204,
 "HandledByUserGroupName": "Admin Group",
 "HandledByUserID": 102,
 "HandledByUserName": "Chandramohan Ganorkar",
 "RiskID": 10,
 "RiskName": "Medium",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2025-10-03 00:00:00",
 "CustomText1": "",
 "CustomText2": "",
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2025-10-03 00:00:00"
}
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Text 255
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
CriteriaID Int 16
CriteriaName Text 150
GenderID Byte
GenderName Text 150
Date Date
Country1ID Int 16
Country1Name Text 255
Country2ID Int 16
Country2Name Text 255
Country3ID Int 16
Country3Name Text 255
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
RiskID Int 16
RiskName Text 150
StatusID Byte
StatusName Text 150
DateAdded Date
CustomText1 Text 255
CustomText2 Text 255
AdverseMediaFileCriteriaID Int 16
AdverseMediaDateRangeID Int 16
AdverseMediaCountryID Int 16
AdditionalAndTerms Text 256
AdditionalOrTerms Text 256
ExcludeTerms Text 256
AdverseMediaDateLastScreened Date
Action:
DELETE INTERNAL
Method:
DELETE
URL: /api/v1/client/matchpotential/deleteinternal
Description: Delete a Client Match Potential record based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientEntityID Int32 Client Entity Identifier
Body EntityID Int32 Dow Jones Entity Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Potential record deleted.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityLastNameJCBias": 1,
 "EntityFirstName": "VLADIMIR",
 "EntityFirstNameJCBias": 1,
 "EntityMiddleName": "VLADIMIROVICH",
 "EntityMiddleNameJCBias": 0,
 "GeneratedDate": "2025-10-03 00:00:00",
 "AverageJCBias": 1,
 "IsPEP": true,
 "IsRCA": false,
 "IsWBL": false,
 "IsSAN": false,
 "IsAVM": false,
 "IsOTH": false,
 "IsUNK": false,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "CriteriaID": 3,
 "DataSourceProvider": 0,
 "CriteriaName": "Default - Person Medium Risk",
 "Note": "",
 "Status": 4,
 "Priority": 9,
 "MetaBump": 55,
 "HandledByUserGroupID": "203",
 "HandledByUserGroupName": "Handler Group",
 "HandledByUserID": "0",
 "HandledByUserName": "",
 "DateMeta": null,
 "CountryMeta": null,
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityLastNameJCBias Double
EntityFirstName Text 255
EntityFirstNameJCBias Double
EntityMiddleName Text 255
EntityMiddleNameJCBias Double
GeneratedDate Date
AverageJCBias Double
IsPEP Boolean
IsRCA Boolean
IsWBL Boolean
IsSAN Boolean
IsAVM Boolean
IsOTH Boolean
IsUNK Boolean
IsDateMatch Boolean
IsCountryMatch Boolean
CriteriaID Int 16
DataSourceProvider Int 16
CriteriaName Text 150
Note Text 2GB
Status Byte
Priority Byte
MetaBump Byte
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
DateMeta String
CountryMeta String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50
Action:
DELETE ALL INTERNAL
Method:
DELETE
URL: /api/v1/client/matchpotential/deleteallinternal
Description: Delete all outstanding Client Match Potential records based on Client Entity Identifier. Only Entity Identifiers can be passed here. Does not accept Alias Identifiers.
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientEntityID Int32 Client Entity Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Potential records deleted.
[{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityLastNameJCBias": 1,
 "EntityFirstName": "VLADIMIR",
 "EntityFirstNameJCBias": 1,
 "EntityMiddleName": "VLADIMIROVICH",
 "EntityMiddleNameJCBias": 0,
 "GeneratedDate": "2025-10-03 00:00:00",
 "AverageJCBias": 1,
 "IsPEP": true,
 "IsRCA": false,
 "IsWBL": false,
 "IsSAN": false,
 "IsAVM": false,
 "IsOTH": false,
 "IsUNK": false,
 "IsDateMatch": true,
 "IsCountryMatch": true,
 "CriteriaID": 3,
 "DataSourceProvider": 0,
 "CriteriaName": "Default - Person Medium Risk",
 "Note": "",
 "Status": 4,
 "Priority": 9,
 "MetaBump": 55
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "DateMeta": null,
 "CountryMeta": null,
 "ClientAliasEntityId": 3,
 "AliasInterfaceReference": "AB1234-Alias"
}]
Field Data Type
ClientEntityID Int 32
ClientEntityInterfaceReferenceText 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityLastNameJCBias Double
EntityFirstName Text 255
EntityFirstNameJCBias Double
EntityMiddleName Text 255
EntityMiddleNameJCBias Double
GeneratedDate Date
AverageJCBias Double
IsPEP Boolean
IsRCA Boolean
IsWBL Boolean
IsSAN Boolean
IsAVM Boolean
IsOTH Boolean
IsUNK Boolean
IsDateMatch Boolean
IsCountryMatch Boolean
CriteriaID Int 16
DataSourceProvider Int 16
CriteriaName Text 150
Note Text 2GB
Status Byte
Priority Byte
MetaBump Byte
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
DateMeta String
CountryMeta String
ClientAliasEntityId Int 32
AliasInterfaceReferencee Text 50