Tuesday, July 16, 2024

Report - Client Entity
Action:
DETAIL
Method:
GET
URL: /api/v1/report/client/entity/detail
Description: Fetch Client Entity Detail Report based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params ClientEntityID Int32 Client Entity Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Entity Detail Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":200260791,
   \"InterfaceReference\":\"JONES001\",
   \"LastName\":\"JONES\",
   \"FirstName\":\"\",
   \"MiddleName\":\"MERVYN\",
   \"Gender\":\"Unknown\",
   \"Date\":\"0001-01-01T00:00:00\",
   \"Status\":\"Active\",
   \"Country1\":\"Unknown\",
   \"Country2\":\"Unknown\",
   \"Country3\":\"Unknown\",
   \"Risk\":\"High\",
   \"HandledByUserGroup\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUser\":\"\",
   \"Criteria\":\"local-Client-100 - Person\",
   \"DateAdded\":\"2019-09-06T00:00:00\",
   \"CustomTextEnabled\":false,
   \"CustomText1Label\":\"\",
   \"CustomText1\":\"\",
   \"CustomText2Label\":\"\",
   \"CustomText2\":\"\" }]"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"CriteriaID\":1,
   \"CriteriaName\":\"local-Client-100 - Person\",
   \"CriteriaDescription"\:\"local-Default - Person\",
   \"EntityType\":\"Person\",
   \"LastNameMatchPercent\":90.0,
   \"FirstNameMatchPercent\":90.0,
   \"MiddleNameMatchPercent\":60.0,
   \"ReverseSearch"\:\"No\",
   \"Constrained\":\"Yes\",
   \"SearchPEP\":\"Yes\",
   \"SearchRCA\":\"Yes\",
   \"SearchWBL\":\"Yes\",
   \"SearchSAN\":\"Yes\",
   \"SearchAVM\":\"No\",
   \"SearchUNK\":\"Yes\",
   \"IncludeBlankMiddleName\":\"Yes\",
   \"ExcludeExceptDateExactMatch\":\"No\",
   \"ExcludeYearRange\":1,
   \"ExcludeCountryNoMatch\":\"Yes\",
   \"ExcludeCountryNoMatchIncludePEP\":\"Yes\",
   \"ExcludeCountryNoMatchIncludeSAN\":\"Yes\",
   \"ExcludeCountryNoMatchIncludeWBL\":\"Yes\",
   \"BumpCountryMatch\":20,
   \"BumpDateMatch\":30,
   \"BumpDateMMYYMatch\":20,
   \"BumpDateYYMatch\":10,
   \"BumpDateDDMMMatch\":5} ]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientName Text 150
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Gender Text 150
Date Date
Status Text 150
Country1 Text 255
Country2 Text 255
Country3 Text 255
Risk Text 150
HandledByUserGroup Text 150
HandledByUser Text 150
Criteria Text 150
DateAdded Date
CustomTextEnabled Boolean
CustomText1Label Text 255
CustomText1 Text 255
CustomText2Label Text 255
CustomText2 Text 255
Field Data Type
CriteriaID Int 16
CriteriaName Text 150
CriteriaDescription Text 255
EntityType Text 150
LastNameMatchPercent Double
FirstNameMatchPercent Double
MiddleNameMatchPercent Double
ReverseSearch Text 3
Constrained Text 3
SearchPEP Text 3
SearchRCA Text 3
SearchWBL Text 3
SearchSAN Text 3
SearchAVM Text 3
SearchUNK Text 3
IncludeBlankMiddleName Text 3
ExcludeExceptDateExactMatch Text 3
ExcludeYearRange Text 3
ExcludeCountryNoMatch Text 3
ExcludeCountryNoMatchIncludePEP Text 3
ExcludeCountryNoMatchIncludeSAN Text 3
ExcludeCountryNoMatchIncludeWBL Text 3
BumpCountryMatch Byte
BumpDateMatch Byte
BumpDateMMYYMatch Byte
BumpDateYYMatch Byte
BumpDateDDMMMatch Byte
Report - Client Match Discounted
Action:
MATCHDISCOUNTED
Method:
GET
URL: /api/v1/report/client/entity/matchdiscounted
Description: Fetch Client Match Discounted Report based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params ClientEntityID Int32 Client Entity Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params FromDate Date Start Date
Params ToDate Date End Date
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Match Discounted Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"InterfaceReference\":\"10700005\",
   \"LastName\":\"HASSAN\",
   \"FirstName\":\"AHMED\",
   \"MiddleName\":\"\",
   \"Gender\":\"Male\",
   \"Date\":\"1949-12-07T00:00:00\",
   \"Status\":\"Active\",
   \"Country1\":\"Spain\",
   \"Country2\":\"Japan\",
   \"Country3\":\"Unknown\",
   \"Risk\":\"Low\",
   \"HandledByUserGroup\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUser\":\"\",
   \"Criteria\":\"local-Client-100 - Person\",
   \"DateAdded\":\"2017-12-01T00:00:00\"}]"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"EntityID\":951433,
   \"EntityLastName\":\"HASSAN\",
   \"EntityFirstName\":\"AHMED\",
   \"EntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-09-13T00:00:00\",
   \"Note\":\"test discount AH\",
   \"Category\":\"Address does not match\",
   \"MetaDate\":\"01 Jan 1970\",
   \"MetaCountry\":\"Citizenship : Somalia\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserName\":\"user101\"}]"
 },
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"FromDate\":\"2011-01-01T00:00:00\",
   \"ToDate\":\"2019-12-31T00:00:00\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientName Text 150
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Gender Text 150
Date Date
Status Text 150
Country1 Text 255
Country2 Text 255
Country3 Text 255
Risk Text 150
HandledByUserGroup Text 150
HandledByUser Text 150
Criteria Text 150
DateAdded Date
Field Data Type
ClientName Text 150
ClientEntityID Int 32
EntityID Int 32
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
Note Text 2GB
Category Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupName Text 150
HandledByUserName Text 150
Field Data Type
FromDate Date
ToDate Date
Report - Client Match Flagged
Action:
MATCHFLAGGED
Method:
GET
URL: /api/v1/report/client/entity/matchflagged
Description: Fetch Client Match Flagged Report based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params ClientEntityID Int32 Client Entity Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params FromDate Date Start Date
Params ToDate Date End Date
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Match Flagged Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"InterfaceReference\":\"10700005\",
   \"LastName\":\"HASSAN\",
   \"FirstName\":\"AHMED\",
   \"MiddleName\":\"\",
   \"Gender\":\"Male\",
   \"Date\":\"1949-12-07T00:00:00\",
   \"Status\":\"Active\",
   \"Country1\":\"Spain\",
   \"Country2\":\"Japan\",
   \"Country3\":\"Unknown\",
   \"Risk\":\"Low\",
   \"HandledByUserGroup\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUser\":\"\",
   \"Criteria\":\"local-Client-100 - Person\",
   \"DateAdded\":\"2017-12-01T00:00:00"}]\"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"EntityID\":951433,
   \"EntityLastName\":\"HASSAN\",
   \"EntityFirstName\":\"AHMED\",
   \"EntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-09-13T00:00:00\",
   \"Note\":\"test flag AH\",
   \"Category\":\"Relevant Acceptable - Generic\",
   \"MetaDate\":\"01 Jan 1970\",
   \"MetaCountry\":\"Citizenship : Somalia\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserName\":\"user101\"}]"
 },
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"FromDate\":\"2011-01-01T00:00:00\",
   \"ToDate\":\"2019-12-31T00:00:00\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientName Text 150
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Gender Text 150
Date Date
Status Text 150
Country1 Text 255
Country2 Text 255
Country3 Text 255
Risk Text 150
HandledByUserGroup Text 150
HandledByUser Text 150
Criteria Text 150
DateAdded Date
Field Data Type
ClientName Text 150
ClientEntityID Int 32
EntityID Int 32
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
Note Text 2GB
Category Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupName Text 150
HandledByUserName Text 150
Field Data Type
FromDate Date
ToDate Date
Report - Client Search History
Action:
SEARCHHISTORY
Method:
GET
URL: /api/v1/report/client/entity/searchhistory
Description: Fetch Client Search History Report based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params ClientEntityID Int32 Client Entity Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Search History Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"InterfaceReference\":\"10700005\",
   \"LastName\":\"HASSAN\",
   \"FirstName\":\"AHMED\",
   \"MiddleName\":\"\",
   \"Gender\":\"Male\",
   \"Date\":\"1949-12-07T00:00:00\",
   \"Status\":\"Active\",
   \"Country1\":\"Spain\",
   \"Country2\":\"Japan\",
   \"Country3\":\"Unknown\",
   \"Risk\":\"Low\",
   \"HandledByUserGroup\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUser\":\"\",
   \"Criteria\":\"local-Client-100 - Person\",
   \"DateAdded\":\"2017-12-01T00:00:00"}]\"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"AuditTypeID\":2,
   \"AuditTypeName\":\"Update\",
   \"AuditTranDate\":\"2019-09-20T18:08:39.32\",
   \"ClientID\":100,
   \"ClientEntityID\":10700209,
   \"InterfaceReference\":\"10700209\",
   \"LastName\":\"PANKOV\",
   \"FirstName\":\"DMITRIY\",
   \"MiddleName\":\"\",
   \"Criteria\":\"local-Default - Person\",
   \"Gender\":\"Male\",
   \"Date\":\"1971-12-16T00:00:00\",
   \"Country1\":\"Russia\",
   \"Country2\":\"Unknown\",
   \"Country3\":\"Unknown\",
   \"HandledByUserGroup\":\"Handler Group\",
   \"HandledByUser\":\"-\",
   \"Risk\":\"Low\",
   \"Status\":\"Active\",
   \"DateAdded\":\"2017-12-01T00:00:00\",
   \"CustomTextEnabled\":false,
   \"CustomText1Label\":\"\",
   \"CustomText1\":\"\",
   \"CustomText2Label\":\"\",
   \"CustomText2\":\""\}]"
 },
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"CLBT_STCL_ID\":100,
   \"CLBT_ID\":0,
   \"CLBT_START\":\"2017-12-04T12:14:53.513\",
   \"CLBT_END\":\"2017-12-04T12:15:04.433\",
   \"ACTIVE\":0,
   \"ActiveName\":\"No\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientName Text 150
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Gender Text 150
Date Date
Status Text 150
Country1 Text 255
Country2 Text 255
Country3 Text 255
Risk Text 150
HandledByUserGroup Text 150
HandledByUser Text 150
Criteria Text 150
DateAdded Date
Field Data Type
AuditTypeID Int 16
AuditTypeName Text 150
AuditTranDate Date
ClientID Int 16
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Criteria Text 150
Gender Text 150
Date Date
Country1 Text 255
Country2 Text 255
Country3 Text 255
HandledByUserGroup Text 150
HandledByUser Text 150
Risk Text 150
Status Text 150
DateAdded Date
CustomTextEnabled Boolean
CustomText1Label Text 255
CustomText1 Text 255
CustomText2Label Text 255
CustomText2 Text 255
Field Data Type
CLBT_STCL_ID Int 16
CLBT_ID Int 32
CLBT_START Date
CLBT_END Date
ACTIVE Byte
ACTIVENAME Text 150
Report - Client AVM Detail
Action:
AVMDETAIL
Method:
GET
URL: /api/v1/report/client/entity/AVMDetail
Description: Fetch Client Entity AVM Detail Report based on Client Entity Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params ClientEntityID Int32 Client Entity Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Entity AVM Detail Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"InterfaceReference\":\"10700005\",
   \"LastName\":\"HASSAN\",
   \"FirstName\":\"AHMED\",
   \"MiddleName\":\"\",
   \"Gender\":\"Male\",
   \"Date\":\"1949-12-07T00:00:00\",
   \"Status\":\"Active\",
   \"Country1\":\"Spain\",
   \"Country2\":\"Japan\",
   \"Country3\":\"Unknown\",
   \"Risk\":\"Low\",
   \"HandledByUserGroup\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUser\":\"\",
   \"Criteria\":\"local-Client-100 - Person\",
   \"DateAdded\":\"2017-12-01T00:00:00\"}]"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-09-13T00:00:00\",
   \"SearchEngineType\":\"BingWeb\",
   \"Link\":\"https://www.imdb.com/title/tt0037465/\",
   \"WebSnippet\":\"Wilson: Directed by Henry King. With Charles Coburn\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Note\":\"test discount AH\",
   \"Category\":\"Address does not match\",
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserName\":\"user101\"}]"
 },
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-09-13T00:00:00\",
   \"SearchEngineType\":\"BingWeb\",
   \"Link\":\"https://www.imdb.com/title/tt0037465/\",
   \"WebSnippet\":\"Wilson: Directed by Henry King. With Charles Coburn\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Note\":\"test discount AH\",
   \"Category\":\"Address does not match\",
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserName\":\"user101\"}]"
 },
 {
  "Name": "ReportDataSet4",
  "Value": "[{
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700005,
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"Rank\":\"4\",
   \"SearchEngineType\":\"BingWeb\",
   \"Link\":\"https://www.imdb.com/title/tt0037465/\",
   \"WebSnippet\":\"Wilson: Directed by Henry King. With Charles Coburn\",
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserName\":\"user101\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientName Text 150
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
Gender Text 150
Date Date
Status Text 150
Country1 Text 255
Country2 Text 255
Country3 Text 255
Risk Text 150
HandledByUserGroup Text 150
HandledByUser Text 150
Criteria Text 150
DateAdded Date
Field Data Type
ClientName Text 150
ClientEntityID Int 32
GeneratedDate Date
MatchedDate Date
SearchEngineType Text 300
Link Text 2000
WebSnippet Text 2000
ValidToDate Date
Note Text 2GB
Category Text 150
HandledByUserGroupName Text 150
HandledByUserName Text 150
Field Data Type
ClientName Text 150
ClientEntityID Int 32
GeneratedDate Date
MatchedDate Date
SearchEngineType Text 300
Link Text 2000
WebSnippet Text 2000
ValidToDate Date
Note Text 2GB
Category Text 150
HandledByUserGroupName Text 150
HandledByUserName Text 150
Field Data Type
ClientName Text 150
ClientEntityID Int 32
GeneratedDate Date
Rank Int 32
SearchEngineType Text 300
Link Text 2000
WebSnippet Text 2000
HandledByUserGroupName Text 150
HandledByUserName Text 150