Wednesday, August 26, 2026

Client - Entity Audit
Action:
GET
Method:
GET
URL: /api/v1/client/entity/audit/get
Description: Fetch an existing Client Entity Audit record based on Client Entity Identifier and Audit Date
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 TransactionDate Date Transaction Date (Audit Date)
Params AuditType Byte 1=Add; 2=Update; 3=Delete
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Entity Audit record being fetched
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 1241,
 "InterfaceReference": "AB1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 1,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": "1962-03-22 00:00:00",
 "Country1ID": 182,
 "Country1Name": "Russia",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "RiskID": 3,
 "RiskName": "High",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2019-09-06 00:00:00",
 "CustomText1": "",
 "CustomText2": ""
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2026-08-26 00:00:00",
 "AuditTypeID": 2,
 "AuditTranDate": "2019-09-06 17:51:36",
 "DateLastChanged": "2019-09-06 17:51:36",
 "LastChangedByUserID": 101
}
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Test 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
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16
Action:
GET ALL
Method:
GET
URL: /api/v1/client/entity/audit/getall
Description: Fetch Client Entity Audit records based on User Identifier and Date Range
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 UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of the Client Entity Audit objects being fetched
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 1241,
 "InterfaceReference": "AB1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 1,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": "1962-03-22 00:00:00",
 "Country1ID": 182,
 "Country1Name": "Russia",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "RiskID": 3,
 "RiskName": "High",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2019-09-06 00:00:00",
 "CustomText1": "",
 "CustomText2": ""
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2026-08-26 00:00:00",
 "AuditTypeID": 2,
 "AuditTranDate": "2019-09-06 17:51:36",
 "DateLastChanged": "2019-09-06 17:51:36",
 "LastChangedByUserID": 101
}
Field Data Type
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Test 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
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16
Action:
GET ALL PAGED
Method:
GET
URL: /api/v1/client/entity/audit/getallpaged
Description: Fetch Client Entity Audit records based on User Identifier, Date Range in batches for the given PageIndex and Number of Rows to fetch
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 UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params SearchString String Search String (optional- leave blank)
Params SearchOn Byte 0=LastName, 1=FirstName, 2=MiddleName, 3=ClientEntityID, 4=InterfaceReference
Params SearchType Byte 0=StartsWith, 1=Contains
Params SearchStatus Byte 2=Both, 1=Active, 0=Disabled
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of the Client Entity Audit objects being fetched
{
  "TotalRecords": 5,
  "Data": [
  {
   "BusinessUnitID": 10,
   "BusinessUnitName": Jersey Office,
   "ClientEntityID": 1241,
   "InterfaceReference": "AB1234",
   "LastName": "PUTIN",
   "FirstName": "VLADIMIR",
   "MiddleName": "",
   "CriteriaID": 1,
   "CriteriaName": "Default - Person",
   "GenderID": 1,
   "GenderName": "Male",
   "Date": "1962-03-22 00:00:00",
   "Country1ID": 182,
   "Country1Name": "Russia",
   "Country2ID": 0,
   "Country2Name": "Unknown",
   "Country3ID": 0,
   "Country3Name": "Unknown",
   "HandledByUserGroupID": "203"
   "HandledByUserGroupName": "Handler Group"
   "HandledByUserID": "0"
   "HandledByUserName": ""
   "RiskID": 3,
   "RiskName": "High",
   "StatusID": 1,
   "StatusName": "Active",
   "DateAdded": "2019-09-06 00:00:00",
   "CustomText1": "",
   "CustomText2": ""
   "AdverseMediaFileCriteriaID": 1003,
   "AdverseMediaDateRangeID": 0,
   "AdverseMediaCountryID": 0,
   "AdditionalAndTerms": "",
   "AdditionalOrTerms": "",
   "ExcludeTerms": ""
   "AdverseMediaDateLastScreened": "2026-08-26 00:00:00",
   "AuditTypeID": 2,
   "AuditTranDate": "2019-09-06 17:51:36",
   "DateLastChanged": "2019-09-06 17:51:36",
   "LastChangedByUserID": 101
  }
 ]
}
Field Data Type
TotalRecords Int 32
BusinessUnitID Int 32
BusinessUnitName Test 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
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16
Client - Entity ID Audit
Action:
GET
Method:
GET
URL: /api/v1/client/entityId/audit/get
Description: Fetch an existing Client Entity ID Audit record by its unique record Id
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 TransactionDate Date Transaction Date (Audit Date)
Params AuditType Byte 1=Add; 2=Update; 3=Delete
Params ReturnFormat String Json or Xml
Params RecordId Int32 The unique identifier of the Client Entity ID Audit record
Return Data: Json of the Client Entity ID Audit record being fetched
{
 "AuditTypeID": 1,
 "AuditDate": "2019-09-06 17:51:36",
 "Id": 42,
 "ClientId": 1,
 "BusinessUnit": 10,
 "EntityId": 1241,
 "CurrentInterfaceReference": "AB1234",
 "CurrentLastName": "PUTIN",
 "CurrentFirstName": "VLADIMIR",
 "CurrentMiddleName": "",
 "IdType": 3,
 "IdTypeName": "Passport",
 "IdValue": "123456789",
 "DateLastChanged": "2019-09-06 17:51:36",
 "UserLastChanged": 101
}
Field Data Type
AuditTypeID Int 16
AuditDate Date
Id Int 32
ClientId Int 16
BusinessUnit Int 32
EntityId Int 32
CurrentInterfaceReference Text 50
CurrentLastName Text 255
CurrentFirstName Text 255
CurrentMiddleName Text 255
IdType Int 16
IdTypeName Text 255
IdValue Text 200
DateLastChanged Date
UserLastChanged Int 16
Action:
GET ALL
Method:
GET
URL: /api/v1/client/entityId/audit/getall
Description: Fetch all Client Entity ID Audit records for a given User and Date Range
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 UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Entity ID Audit records
[{
 "AuditTypeID": 1,
 "AuditDate": "2019-09-06 17:51:36",
 "Id": 42,
 "ClientId": 1,
 "BusinessUnit": 10,
 "EntityId": 1241,
 "CurrentInterfaceReference": "AB1234",
 "CurrentLastName": "PUTIN",
 "CurrentFirstName": "VLADIMIR",
 "CurrentMiddleName": "",
 "IdType": 3,
 "IdTypeName": "Passport",
 "IdValue": "123456789",
 "DateLastChanged": "2019-09-06 17:51:36",
 "UserLastChanged": 101
}]
Field Data Type
AuditTypeID Int16
AuditDate Date
Id Int 32
ClientId Int 16
BusinessUnit Int 32
EntityId Int 32
CurrentInterfaceReference Text 50
CurrentLastName Text 255
CurrentFirstName Text 255
CurrentMiddleName Text 255
IdType Int 16
IdTypeName Text 255
IdValue Text 200
DateLastChanged Date
UserLastChanged Int 16
Action:
GET ALL PAGED
Method:
GET
URL: /api/v1/client/entityId/audit/getallpaged
Description: Fetch a paged collection of Client Entity ID Audit records for a given User and Date Range, with search filtering
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 UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params CurrentPage Int32 Page number to fetch (minimum: 1)
Params PageSize Int32 Number of rows to return per page (minimum: 1)
Params SearchString String ID value search term (optional, max 255 characters)
Params SearchOn Byte 0=LastName, 1=FirstName, 2=MiddleName, 3=ClientEntityID, 4=InterfaceReference, 5=ID Value
Params SearchType Byte 0=StartsWith, 1=Contains
Params SearchStatus Byte 2=Both, 1=Active, 0=Disabled
Params ReturnFormat String Json or Xml
Return Data: Json or XML paged collection of Client Entity ID Audit records
[{
 "AuditTypeID": 1,
 "AuditDate": "2019-09-06 17:51:36",
 "Id": 42,
 "ClientId": 1,
 "BusinessUnit": 10,
 "EntityId": 1241,
 "CurrentInterfaceReference": "AB1234",
 "CurrentLastName": "PUTIN",
 "CurrentFirstName": "VLADIMIR",
 "CurrentMiddleName": "",
 "IdType": 3,
 "IdTypeName": "Passport",
 "IdValue": "123456789",
 "DateLastChanged": "2019-09-06 17:51:36",
 "UserLastChanged": 101
}]
Field Data Type
AuditTypeID Int 16
AuditDate Date
Id Int 32
ClientId Int 16
BusinessUnit Int 32
EntityId Int 32
CurrentInterfaceReference Text 50
CurrentLastName Text 255
CurrentFirstName Text 255
CurrentMiddleName Text 255
IdType Int 16
IdTypeName Text 255
IdValue Text 200
DateLastChanged Date
UserLastChanged Int 16