Wednesday, August 26, 2026

Client - Match Flagged
Action:
GET ROWS
Method:
GET
URL: /api/v1/client/matchflagged/getrows
Description: Fetch Match Flagged 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 Flagged 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",
   "EntityFirstName": "VLADIMIR",
   "EntityMiddleName": "VLADIMIROVICH",
   "GeneratedDate": "2026-08-26 00:00:00",
   "MatchedDate": "2026-08-26 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",
   "MatchType": 1,
   "ClientIdentityMatches": [
     {
      "IdType": 1,
      "IdTypeDesc": "ID description",
      "IdValue": "ABCD1234",
      "DateLastChanged": "2026-08-26 00:00:00",
      "LastChangedByUserId": 0,
      "LastChangedUserName"Fred Jones
     }
    ],
  }]
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Client - Match Flagged [Using External Reference]
Action:
GET
Method:
GET
URL: /api/v1/client/matchflagged/get
Description: Fetch Match Flagged 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 Flagged records
[{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}]
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
GET ENTITY
Method:
GET
URL: /api/v1/client/matchflagged/getentity
Description: Fetch Match Flagged records based on Interface Reference and Dow Jones Entity Identifier. 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 EntityID Int32 Dow Jones Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Flagged record
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
CONVERT
Method:
POST
URL: api/v1/client/matchflagged/convert
Description: Converts a Client Match Flagged record into a Client Match Discounted 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 MatchDiscountCategoryID Int16 Match Discount Category Identifier
Body Reason String Reason
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 record generated post conversion.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "Regulator approval granted",
 "MatchDiscountCategoryID": 6,
 "MatchDiscountCategoryName": "Other",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName 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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/matchflagged/delete
Description: Delete a Client Match 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 ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Match Flagged record deleted.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 10,
 "MatchFlagCategoryName": "Relevant Not Acceptable - Country Risk",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/matchflagged/update
Description: Update a Client Match 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
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params InterfaceReference String Interface Reference
Params EntityID Int32 Dow Jones Entity Identifier
Params ReturnFormat String Json or Xml
Body Reason String Reason
Body MatchFlagCategoryID Int16 Match Flag Category Identifier
Body Notify Boolean Notify True or False
Body ValidToDate Date Valid to Date yyyy-mm-dd
Body ActionUserID Int16 Identifier of the User performing action.
Return Data: Json or XML of the Client Match Flagged record you have updated.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 10,
 "MatchFlagCategoryName": "Relevant Not Acceptable - Country Risk",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Client - Match Flagged [Using Internal Reference]
Action:
GET INTERNAL
Method:
GET
URL: /api/v1/client/matchflagged/getinternal
Description: Fetch Match Flagged 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 Flagged records
[{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}]
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
GET INTERNAL ENTITY
Method:
GET
URL: /api/v1/client/matchflagged/getinternalentity
Description: Fetch Match Flagged records based on Client Entity Identifier and Dow Jones 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 EntityID Int32 Dow Jones Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML Client Match Flagged record
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
CONVERT INTERNAL
Method:
POST
URL: /api/v1/client/matchflagged/convertinternal
Description: Converts a Client Match Flagged record into a Client Match Discounted 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 MatchDiscountCategoryID Int16 Match Discount Category Identifier
Body Reason String Reason
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 record generated post conversion.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "Regulator approval granted",
 "MatchDiscountCategoryID": 6,
 "MatchDiscountCategoryName": "Other",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchDiscountCategoryID Int 16
MatchDiscountCategoryName 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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
DELETE INTERNAL
Method:
DELETE
URL: /api/v1/client/matchflagged/deleteinternal
Description: Delete a Client Match 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 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 Flagged record deleted.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 10,
 "MatchFlagCategoryName": "Relevant Not Acceptable - Country Risk",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText
Action:
UPDATE INTERNAL
Method:
PUT
URL: /api/v1/client/matchflagged/updateinternal
Description: Update a Client Match 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
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientEntityID Int32 Client Entity Identifier
Params EntityID Int32 Dow Jones Entity Identifier
Params ReturnFormat String Json or Xml
Body Reason String Reason
Body MatchFlagCategoryID Int16 Match Flag Category Identifier
Body Notify Boolean Notify True or False
Body ValidToDate Date Valid to Date yyyy-mm-dd
Body ActionUserID Int16 Identifier of the User performing action.
Return Data: Json or XML of the Client Match Flagged record you have updated.
{
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 98141,
 "EntityFullName": "VLADIMIR VLADIMIROVICH PUTIN",
 "EntityLastName": "PUTIN",
 "EntityFirstName": "VLADIMIR",
 "EntityMiddleName": "VLADIMIROVICH",
 "GeneratedDate": "2026-08-26 00:00:00",
 "MatchedDate": "2026-08-26 00:00:00",
 "ActionDays": 0,
 "Reason": "President of Russia",
 "MatchFlagCategoryID": 10,
 "MatchFlagCategoryName": "Relevant Not Acceptable - Country Risk",
 "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",
 "MatchType": 1,
 "ClientIdentityMatches": [
   {
    "IdType": 1,
    "IdTypeDesc": "ID description",
    "IdValue": "ABCD1234",
    "DateLastChanged": "2026-08-26 00:00:00",
    "LastChangedByUserId": 0,
    "LastChangedUserName"Fred Jones
   }
  ],
}
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
MatchType Byte (0=Name, 1=Identity, 2=Name & Identity)
ClientIdentityMatches Collection (null when empty)
  IdType Int 16
  IdTypeDesc Text
  IdValue Text
  DateLastChanged Date
  LastChangedByUserIdInt 16
  LastChangedUserNameText