Tuesday, July 16, 2024

Report - Match Discount
Action:
MATCHDISCOUNTBYDAY
Method:
GET
URL: /api/v1/report/matchmonitor/matchdiscountbyday
Description: Fetch Match Discount Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Discount Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700127,
   \"ClientLastName\":\"ROBINSON\",
   \"ClientFirstName\":\"JASON\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":11730606,
   \"EntityFullName\":\"JASON LEE ROBINSON\",
   \"EntityLastName\":\"ROBINSON\",
   \"EntityFirstName\":\"JASON\",
   \"EntityMiddleName\":\"LEE\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-08-08T00:00:00\",
   \"ActionDays\":71,
   \"Note\":\"\",
   \"MatchDiscountedCategoryID\":2,
   \"MatchDiscountedCategoryName\":\"Date does not match\",
   \"MetaDate\":\"1969 | 1970\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":174,
   \"HandledByUserName\":\"user174\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"StartDate\":\"2019-01-01T00:00:00\",
   \"EndDate\":\"2019-10-01T00:00:00\"}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscountedCategoryID Int 16
MatchDiscountedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
StartDate Date
EndDate Date
Report - Match Flag
Action:
MATCHFLAGBYDAY
Method:
GET
URL: /api/v1/report/matchmonitor/matchflagbyday
Description: Fetch Match Flag Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Flag Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700127,
   \"ClientLastName\":\"ROBINSON\",
   \"ClientFirstName\":\"JASON\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":11730606,
   \"EntityFullName\":\"JASON LEE ROBINSON\",
   \"EntityLastName\":\"ROBINSON\",
   \"EntityFirstName\":\"JASON\",
   \"EntityMiddleName\":\"LEE\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-08-08T00:00:00\",
   \"ActionDays\":71,
   \"Note\":\"\",
   \"MatchFlaggedCategoryID\":1,
   \"MatchFlaggedCategoryName\":\"Relevant Acceptable - Generic\",
   \"MetaDate\":\"1969 | 1970\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":174,
   \"HandledByUserName\":\"user174\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"StartDate\":\"2019-01-01T00:00:00\",
   \"EndDate\":\"2019-10-01T00:00:00\"}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchFlaggedCategoryID Int 16
MatchFlaggedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
StartDate Date
EndDate Date
Report - Match Potential
Action:
MATCHPOTENTIAL
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotential
Description: Fetch Match Potential Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":101,
   \"ClientName\":\"local-Client-101\",
   \"ClientEntityID\":20700007,
   \"ClientEntityLastName\":\"HUSSAIN\",
   \"ClientEntityFirstName\":\"ASIF\",
   \"ClientEntityMiddleName\":\"\",
   \"GeneratedDate\":\"2018-06-19T00:00:00\",
   \"Priority\":1,
   \"NumberOfPotentialMatches\":13,
   \"IsDateMatch\":true,
   \"IsCountryMatch\":true,
   \"IsPEPVolume\":0,
   \"IsRCAVolume\":1,
   \"IsWBLVolume\":12,
   \"IsSANVolume\":0,
   \"IsAVMVolume\":0,
   \"IsOTHVolume\":0,
   \"IsUNKVolume\":0,
   \"HandledByUserGroupID\":206,
   \"HandledByUserGroupName\":\"local-Swiss Handler Users-206\",
   \"HandledByUserID\":104,
   \"HandledByUserName\":\"user104\"}]"
 }],
 "SubreportDataSources": [{
  "key": "MatchPotential_SR0-ClientID-101-ClientEntityID-20700007-HandledByUserGroupID-206",
  "value": [{
   "Name": "ReportDataSet1",
   "Value": "[{
    \"ClientID\":101,
    \"ClientName\":\"local-Client-101\",
    \"ClientEntityID\":20700007,
    \"EntityID\":2256988,
    \"EntityFullName\":\"ASIF HUSSAIN\",
    \"GeneratedDate\":\"2018-06-19T00:00:00\",
    \"LastName\":\"HUSSAIN\",
    \"LastNameJCBias\":1.0,
    \"FirstName\":\"ASIF\",
    \"FirstNameJCBias\":1.0,
    \"MiddleName\":\"\",
    \"MiddleNameJCBias\":0.0,
    \"AverageJCBias\":1.0,
    \"IsPEP\":\"No\",
    \"IsRCA\":\"No\",
    \"IsWBL\":\"Yes\",
    \"IsSAN\":\"No\",
    \"IsAVM\":\"No\",
    \"IsOTH\":\"No\",
    \"IsUNK\":\"No\",
    \"IsDateMatch\":\"No\",
    \"IsCountryMatch\":\"Yes\",
    \"FileCriteriaID\":1,
    \"FileCriteriaName\":\"local-Client-100 - Person\",
    \"HandledByUserGroupID\":206,
    \"HandledByUserGroupName\":\"local-Swiss Handler Users-206\",
    \"HandledByUserID\":104,
    \"HandledByUserName\":\"user104\",
    \"Status\":0,
    \"Priority\":1,
    \"MetaBump\":20}]"
  }]
 }]
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
Priority Byte
NumberOfPotentialMatches Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
EntityID Int 32
EntityFullName Text 255
GeneratedDate Date
LastName Text 255
LastNameJCBias Double
FirstName Text 255
FirstNameJCBias Double
MiddleName Text 255
MiddleNameJCBias Double
AverageNameJCBias Double
IsPEP Text 3
IsRCA Text 3
IsWBL Text 3
IsSAN Text 3
IsAVM Text 3
IsOTH Text 3
IsUNK Text 3
IsDateMatch Text 3
IsCountryMatch Text 3
FileCriteriaID Int 16
FileCriteriaName Text 150
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Status Byte
Priority Byte
MetaBump Byte
Report - Match Potential Statistics
Action:
MATCHPOTENTIALSTATISTICS
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotentialstatistics
Description: Fetch Match Potential Statistics Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params RiskID Int16 Risk ID (set to -1 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Statistics Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"HandledByUserGroupID\":0,
   \"HandledByUserGroupName\":\"All User Groups\",
   \"ClientEntityVolume\":64,
   \"MatchPotentialVolume\":3447,
   \"PEPVolume\":334,
   \"RCAVolume\":858,
   \"WBLVolume\":2256,
   \"SANVolume\":3,
   \"AVMVolume\":1,
   \"UNKVolume\":0}]"
  },
  {
  "Name": "ReportDataSet1A",
  "Value": "[{
   \"Category\":"0 Day",
   \"PEPVolume\":0,
   \"RCAVolume\":0,
   \"WBLVolume\":0,
   \"SANVolume\":0,
   \"AVMVolume\":0,
   \"UNKVolume\":0}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"Category\":\"[P0] 4 Days\",
   \"PEPVolume\":1,
   \"RCAVolume\":0,
   \"WBLVolume\":0,
   \"SANVolume\":0,
   \"AVMVolume\":0,
   \"UNKVolume\":0}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
ClientEntityVolume Int 32
MatchPotentialVolume Int 32
PEPVolume Int 32
RCAVolume Int 32
WBLVolume Int 32
SANVolume Int 32
AVMVolume Int 32
UNKVolume Int 32
Field Data Type
Category Text 150
PEPVolume Int 32
RCAVolume Int 32
WBLVolume Int 32
SANVolume Int 32
AVMVolume Int 32
UNKVolume Int 32
Field Data Type
Category Text 150
PEPVolume Int 32
RCAVolume Int 32
WBLVolume Int 32
SANVolume Int 32
AVMVolume Int 32
UNKVolume Int 32
Report - Match Potential Summary
Action:
MATCHPOTENTIALSUMMARY
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotentialsummary
Description: Fetch Match Potential Summary Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Summary Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientEntityLastName\":\"WILSON\",
   \"ClientEntityFirstName\":\"BRIAN\",
   \"ClientEntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"DaysOutstanding\":5,
   \"Priority\":9,
   \"MetaBump\":25,
   \"NumberOfPotentialMatches\":11,
   \"IsDateMatch\":true,
   \"IsCountryMatch\":true,
   \"IsPEPVolume\":3,
   \"IsRCAVolume\":0,
   \"IsWBLVolume\":8,
   \"IsSANVolume\":0,
   \"IsAVMVolume\":0,
   \"IsOTHVolume\":0,
   \"IsUNKVolume\":0,
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
DaysOutstanding Int 16
Priority Byte
MetaBump Byte
NumberOfPotentialMatches Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Report - Match Potential Volume
Action:
MATCHPOTENTIALVOLUME
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotentialvolume
Description: Fetch Match Potential Volume Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Volume Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_VOLUME\":3447,
   \"CLMP_ISPEPVOL\":334,
   \"CLMP_ISRCAVOL\":858,
   \"CLMP_ISWBLVOL\":2256,
   \"CLMP_ISSANVOL\":3,
   \"CLMP_ISAVMVOL\":1,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_PRIORITY\":9,
   \"CLMP_VOLUME\":3350,
   \"CLMP_ISPEPVOL\":323,
   \"CLMP_ISRCAVOL\":827,
   \"CLMP_ISWBLVOL\":2202,
   \"CLMP_ISSANVOL\":3,
   \"CLMP_ISAVMVOL\":0,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 },
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_GENDATE\":\"2019-10-01T00:00:00\",
   \"CLMP_VOLUME\":3335,
   \"CLMP_ISPEPVOL\":320,
   \"CLMP_ISRCAVOL\":825,
   \"CLMP_ISWBLVOL\":2193,
   \"CLMP_ISSANVOL\":2,
   \"CLMP_ISAVMVOL\":0,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 },
 {
  "Name": "ReportDataSet4",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_GENDATE\":\"2019-10-01T00:00:00\",
   \"CLMP_PRIORITY\":9,
   \"CLMP_VOLUME\":3333,
   \"CLMP_ISPEPVOL\":318,
   \"CLMP_ISRCAVOL\":825,
   \"CLMP_ISWBLVOL\":2193,
   \"CLMP_ISSANVOL\":2,
   \"CLMP_ISAVMVOL\":0,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 },
 {
  "Name": "ReportDataSet5",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_GENDATE\":\"2019-10-01T00:00:00\",
   \"CLMP_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMP_VOLUME\":3335,
   \"CLMP_ISPEPVOL\":320,
   \"CLMP_ISRCAVOL\":825,
   \"CLMP_ISWBLVOL\":2193,
   \"CLMP_ISSANVOL\":2,
   \"CLMP_ISAVMVOL\":0,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 },
 {
  "Name": "ReportDataSet6",
  "Value": "[{
   \"CLMP_STCL_NAME\":\"local-Client-100\",
   \"CLMP_GENDATE\":\"2019-10-01T00:00:00\",
   \"CLMP_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMP_PRIORITY\":9,
   \"CLMP_VOLUME\":3333,
   \"CLMP_ISPEPVOL\":318,
   \"CLMP_ISRCAVOL\":825,
   \"CLMP_ISWBLVOL\":2193,
   \"CLMP_ISSANVOL\":2,
   \"CLMP_ISAVMVOL\":0,
   \"CLMP_ISOTHVOL\":0}]"
   \"CLMP_ISUNKVOL\":0}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_PRIORITY Byte
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_GENDATE Date
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_GENDATE Date
CLMP_PRIORITY Byte
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_GENDATE Date
CLMP_HBY_STUG_NAME Text 150
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Field Data Type
CLMP_STCL_NAME Text 150
CLMP_GENDATE Date
CLMP_HBY_STUG_NAME Text 150
CLMP_PRIORITY Byte
CLMP_VOLUME Int 32
CLMP_ISPEPVOL Int 32
CLMP_ISRCAVOL Int 32
CLMP_ISWBLVOL Int 32
CLMP_ISSANVOL Int 32
CLMP_ISAVMVOL Int 32
CLMP_ISOTHVOL Int 32
CLMP_ISUNKVOL Int 32
Report - Match Data By Day
Action:
MATCHDATABYDAY
Method:
GET
URL: /api/v1/report/matchmonitor/matchdatabyday
Description: Fetch Match Data By Day Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params Date Date Date
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 Match Data By Day Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":200260791,
   \"ClientEntityLastName\":\"JONES\",
   \"ClientEntityFirstName\":\"\",
   \"ClientEntityMiddleName\":\"MERVYN\",
   \"EntityID\":67827,
   \"EntityFullName\":\"MACIFIERRAN MOMO JIBBA\",
   \"GeneratedDate\":\"2019-10-01T00:00:00\",
   \"LastName\":\"JONES\",
   \"LastNameJCBias\":1.0,
   \"FirstName\":\"MO\",
   \"FirstNameJCBias\":0.0,
   \"MiddleName\":\"\",
   \"MiddleNameJCBias\":0.0,
   \"AverageJCBias\":0.5,
   \"IsPEP\":\"Yes\",
   \"IsRCA\":\"No\",
   \"IsWBL\":\"Yes\",
   \"IsSAN\":\"Yes\",
   \"IsAVM\":\"No\",
   \"IsOTH\":\"No\",
   \"IsUNK\":\"No\",
   \"IsDateMatch\":\"No\",
   \"IsCountryMatch\":\"No\",
   \"FileCriteriaID\":1,
   \"FileCriteriaName\":\"local-Client-100 - Person\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\",
   \"Status\":0,
   \"Priority\":9,
   \"MetaBump\":0}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":11450391,
   \"EntityFullName\":\"BRYAN WILSON\",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRYAN\",
   \"EntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"yellow\",
   \"MatchFlaggedCategoryID\":1,
   \"MatchFlaggedCategoryName\":\"Relevant Acceptable - Generic\",
   \"MetaDate\":\"\",
   \"MetaCountry\":\"Citizenship : New Zealand | Jurisdiction : New Zealand | Resident of : New Zealand\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  },
  {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":"\\",
   \"EntityID\":934883,
   \"EntityFullName\":\"BRIAN KEITH WILSON\",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRIAN\",
   \"EntityMiddleName\":\"KEITH\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"grey\",
   \"MatchDiscountedCategoryID\":1,
   \"MatchDiscountedCategoryName\":\"Address does not match\",
   \"MetaDate\":\"1972 | 1973\",
   \"MetaCountry\":\"Citizenship : United States | Resident of : United States | Address : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
GeneratedDate Date
LastName Text 255
LastNameJCBias Double
FirstName Text 255
FirstNameJCBias Double
MiddleName Text 255
MiddleNameJCBias Double
AverageNameJCBias Double
IsPEP Text 3
IsRCA Text 3
IsWBL Text 3
IsSAN Text 3
IsAVM Text 3
IsOTH Text 3
IsUNK Text 3
IsDateMatch Text 3
IsCountryMatch Text 3
FileCriteriaID Int 16
FileCriteriaName Text 150
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Status Byte
Priority Byte
MetaBump Byte
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchFlaggedCategoryID Int 16
MatchFlaggedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscountedCategoryID Int 16
MatchDiscountedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Report - Match Discount By Category
Action:
MATCHDISCOUNTBYCATEGORY
Method:
GET
URL: /api/v1/report/matchmonitor/matchdiscountbycategory
Description: Fetch Match Discount By Category Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params FromDate Date Start Date
Params ToDate Date End Date
Params MatchDiscountCategoryID Int16 Match Discount Category 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 Match Discount By Category Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"CLMD_STCL_ID\":100,
   \"CLMD_STCL_NAME\":\"local-Client-100\",
   \"CLMD_CLEN_ID\":10700005,
   \"CLMD_CLEN_IFREF\":\"10700005\",
   \"CLMD_CLEN_LASTNAME\":\"HASSAN\",
   \"CLMD_CLEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_CLEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ID\":951433,
   \"CLMD_DAEN_FULLNAME\":\"AHMED HASSAN\",
   \"CLMD_DAEN_LASTNAME\":\"HASSAN\",
   \"CLMD_DAEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_DAEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ISPEP\":false,
   \"CLMD_DAEN_ISRCA\":false,
   \"CLMD_DAEN_ISWBL\":true,
   \"CLMD_DAEN_ISSAN\":false,
   \"CLMD_DAEN_ISAVM\":false,
   \"CLMD_DAEN_ISOTH\":false,
   \"CLMD_DAEN_ISUNK\":false,
   \"CLMD_GENDATE\":\"2019-05-29T00:00:00\",
   \"CLMD_MATCHDATE\":\"2019-09-13T00:00:00\",
   \"CLMD_ACTIONDAYS\":107,
   \"CLMD_NOTE\":\"test discount AH\",
   \"CLMD_STMD_ID\":1,
   \"CLMD_STMD_NAME\":\"Address does not match\",
   \"CLMD_METADATE\":\"01 Jan 1970\",
   \"CLMD_METACOUNTRY\":\"Citizenship : Somalia\",
   \"CLMD_VALIDTO\":\"2099-12-31T00:00:00\",
   \"CLMD_NOTIFY\":true,
   \"CLMD_HBY_STUG_ID\":203,
   \"CLMD_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMD_HBY_STUR_ID\":101,
   \"CLMD_HBY_STUR_NAME\":\"user101\",
   \"CLMD_DLC\":\"2019-09-13T09:14:51.86\",
   \"CLMD_LCBU\":101,
   \"CLMD_DAEN_ISPEPFMT\":\"No\",
   \"CLMD_DAEN_ISRCAFMT\":\"No\",
   \"CLMD_DAEN_ISWBLFMT\":"Yes\",
   \"CLMD_DAEN_ISSANFMT\":"No\",
   \"CLMD_DAEN_ISAVMFMT\":"No\",
   \"CLMD_DAEN_ISOTHFMT\":"No\"}]"
   \"CLMD_DAEN_ISUNKFMT\":"No\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"FromDate\":\"2019-01-01T00:00:00\",
   \"ToDate\":\"2019-10-01T00:00:00\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
CLMD_STCL_ID Int 16
CLMD_STCL_NAME Text 150
CLMD_CLEN_ID Int 32
CLMD_CLEN_LASTNAME Text 150
CLMD_CLEN_FIRSTNAME Text 150
CLMD_CLEN_MIDDLENAME Text 150
CLMD_DAEN_ID Int 32
CLMD_DAEN_FULLNAME Text 150
CLMD_DAEN_LASTNAME Text 150
CLMD_DAEN_FIRSTNAME Text 150
CLMD_DAEN_MIDDLENAME Text 150
CLMD_DAEN_ISPEP Boolean
CLMD_DAEN_ISRCA Boolean
CLMD_DAEN_ISWBL Boolean
CLMD_DAEN_ISSAN Boolean
CLMD_DAEN_ISAVM Boolean
CLMD_DAEN_ISOTH Boolean
CLMD_DAEN_ISUNK Boolean
CLMD_GENDATE Date
CLMD_MATCHDATE Date
CLMD_ACTIONDAYS Int 32
CLMD_NOTE Text 2GB
CLMD_STMD_ID Int 16
CLMD_STMD_NAME Text 150
CLMD_METADATE Text 4000
CLMD_METACOUNTRY Text 4000
CLMD_VALIDTO Date
CLMD_NOTIFY Boolean
CLMD_HBY_STUG_ID Int 16
CLMD_HBY_STUG_NAME Text 150
CLMD_HBY_STUR_ID Int 16
CLMD_HBY_STUR_NAME Text 150
CLMD_DLC Date
CLMD_LCBU Int 16
CLMD_DAEN_ISPEPFMT Text 3
CLMD_DAEN_ISRCAFMT Text 3
CLMD_DAEN_ISWBLFMT Text 3
CLMD_DAEN_ISSANFMT Text 3
CLMD_DAEN_ISAVMFMT Text 3
CLMD_DAEN_ISOTHFMT Text 3
CLMD_DAEN_ISUNKFMT Text 3
Field Data Type
FromDate Date
ToDate Date
Report - Match Flag By Category
Action:
MATCHFLAGBYCATEGORY
Method:
GET
URL: /api/v1/report/matchmonitor/matchflagbycategory
Description: Fetch Match Flag By Category Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params FromDate Date Start Date
Params ToDate Date End Date
Params MatchFlagCategoryID Int16 Match Flag Category 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 Match Flag By Category Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"CLMD_STCL_ID\":100,
   \"CLMD_STCL_NAME\":\"local-Client-100\",
   \"CLMD_CLEN_ID\":10700005,
   \"CLMD_CLEN_IFREF\":\"10700005\",
   \"CLMD_CLEN_LASTNAME\":\"HASSAN\",
   \"CLMD_CLEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_CLEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ID\":951433,
   \"CLMD_DAEN_FULLNAME\":\"AHMED HASSAN\",
   \"CLMD_DAEN_LASTNAME\":\"HASSAN\",
   \"CLMD_DAEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_DAEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ISPEP\":false,
   \"CLMD_DAEN_ISRCA\":false,
   \"CLMD_DAEN_ISWBL\":true,
   \"CLMD_DAEN_ISSAN\":false,
   \"CLMD_DAEN_ISAVM\":false,
   \"CLMD_DAEN_ISOTH\":false,
   \"CLMD_DAEN_ISUNK\":false,
   \"CLMD_GENDATE\":\"2019-05-29T00:00:00\",
   \"CLMD_MATCHDATE\":\"2019-09-13T00:00:00\",
   \"CLMD_ACTIONDAYS\":107,
   \"CLMD_NOTE\":\"test flag AH\",
   \"CLMD_STMD_ID\":2,
   \"CLMD_STMD_NAME\":\"Relevant Acceptable - Generic\",
   \"CLMD_METADATE\":\"01 Jan 1970\",
   \"CLMD_METACOUNTRY\":\"Citizenship : Somalia\",
   \"CLMD_VALIDTO\":\"2099-12-31T00:00:00\",
   \"CLMD_NOTIFY\":true,
   \"CLMD_HBY_STUG_ID\":203,
   \"CLMD_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMD_HBY_STUR_ID\":101,
   \"CLMD_HBY_STUR_NAME\":\"user101\",
   \"CLMD_DLC\":\"2019-09-13T09:14:51.86\",
   \"CLMD_LCBU\":101,
   \"CLMD_DAEN_ISPEPFMT\":\"No\",
   \"CLMD_DAEN_ISRCAFMT\":\"No\",
   \"CLMD_DAEN_ISWBLFMT\":\"Yes\",
   \"CLMD_DAEN_ISSANFMT\":\"No\",
   \"CLMD_DAEN_ISAVMFMT\":\"No\",
   \"CLMD_DAEN_ISOTHFMT\":\"No\"}]"
   \"CLMD_DAEN_ISUNKFMT\":\"No\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"FromDate\":\"2019-01-01T00:00:00\",
   \"ToDate\:\"2019-10-01T00:00:00\"}]"
 }],
 "SubreportDataSources": null
}
Field Data Type
CLMD_STCL_ID Int 16
CLMD_STCL_NAME Text 150
CLMD_CLEN_ID Int 32
CLMD_CLEN_LASTNAME Text 150
CLMD_CLEN_FIRSTNAME Text 150
CLMD_CLEN_MIDDLENAME Text 150
CLMD_DAEN_ID Int 32
CLMD_DAEN_FULLNAME Text 150
CLMD_DAEN_LASTNAME Text 150
CLMD_DAEN_FIRSTNAME Text 150
CLMD_DAEN_MIDDLENAME Text 150
CLMD_DAEN_ISPEP Boolean
CLMD_DAEN_ISRCA Boolean
CLMD_DAEN_ISWBL Boolean
CLMD_DAEN_ISSAN Boolean
CLMD_DAEN_ISAVM Boolean
CLMD_DAEN_ISOTH Boolean
CLMD_DAEN_ISUNK Boolean
CLMD_GENDATE Date
CLMD_MATCHDATE Date
CLMD_ACTIONDAYS Int 32
CLMD_NOTE Text 2GB
CLMD_STMD_ID Int 16
CLMD_STMD_NAME Text 150
CLMD_METADATE Text 4000
CLMD_METACOUNTRY Text 4000
CLMD_VALIDTO Date
CLMD_NOTIFY Boolean
CLMD_HBY_STUG_ID Int 16
CLMD_HBY_STUG_NAME Text 150
CLMD_HBY_STUR_ID Int 16
CLMD_HBY_STUR_NAME Text 150
CLMD_DLC Date
CLMD_LCBU Int 16
CLMD_DAEN_ISPEPFMT Text 3
CLMD_DAEN_ISRCAFMT Text 3
CLMD_DAEN_ISWBLFMT Text 3
CLMD_DAEN_ISSANFMT Text 3
CLMD_DAEN_ISAVMFMT Text 3
CLMD_DAEN_ISOTHFMT Text 3
CLMD_DAEN_ISUNKFMT Text 3
Field Data Type
FromDate Date
ToDate Date
Report - Match Checking
Action:
MATCHCHECKING
Method:
GET
URL: /api/v1/report/matchmonitor/matchchecking
Description: Fetch Match Checking Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params Date Date Date
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Checking Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientInterfaceReference\":\"10700181\",
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":\"\",
   \"ClientCountry1Name\":\"United Kingdom\",
   \"ClientCountry2Name\":\"Unknown\",
   \"ClientCountry3Name\":\"Unknown\",
   \"ClientDateOfBirth\":\"1981-12-07T00:00:00\",
   \"ClientGenderName\":\"Male\",
   \"ClientCriteriaName\":\"local-Client-100 - Person High Risk\",
   \"ClientRiskName\":\"High\",
   \"ClientDateAdded\":\"2017-12-01T00:00:00\",
   \"EntityID\":934883,
   \"EntityFullName\":\"BRIAN KEITH WILSON\",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRIAN\",
   \"EntityMiddleName\":\"KEITH\",
   \"EntityGender\":\"Male\",
   \"EntityIsPEP\":\"No\",
   \"EntityIsRCA\":\"No\",
   \"EntityIsWBL\":\"Yes\",
   \"EntityIsSAN\":\"No\",
   \"EntityIsAVM\":\"No\",
   \"EntityIsOTH\":\"No\",
   \"EntityIsUNK\":\"No\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"grey\",
   \"MatchDiscFlag\":\"Discount\",
   \"MatchCategoryName\":\"Address does not match\",
   \"MetaDate\":\"1972 | 1973\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientInterfaceReference Text 150
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
ClientCountry1Name Text 150
ClientCountry2Name Text 150
ClientCountry3Name Text 150
ClientDateOfBirth Date
ClientGenderName Text 150
ClientCriteriaName Text 150
ClientRiskName Text 150
ClientDateAdded Date
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
EntityGender Text 150
EntityIsPEP Text 3
EntityIsRCA Text 3
EntityIsWBL Text 3
EntityIsSAN Text 3
EntityIsAVM Text 3
EntityIsOTH Text 3
EntityIsUNK Text 3
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscFlag Text 8
MatchCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Report - Processing Statistics
Action:
PROCESSINGSTATISTICS
Method:
GET
URL: /api/v1/report/matchmonitor/processingstatistics
Description: Fetch Processing Statistics Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params Date Date Date
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 Processing Statistics Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName"\:\"local-Client-100\",
   \"BatchID\":14708,
   \"StartDate\":\"2019-08-26T18:01:57.56\",
   \"EndDate\":\"2019-08-26T18:02:08.997\",
   \"Searches\":217,
   \"InitialMatchesFound\":204,
   \"InitialMatchesDiscMultiMatch\":12,
   \"InitialMatchesDiscExisting\":192,
   \"InitialMatchesDiscWhiteList\":0,
   \"InitialMatchesDiscDateMeta\":0,
   \"InitialMatchesDiscCountryMeta\":0,
   \"InitialMatchesDiscTotal\":204,
   \"ClientVolume\":0,
   \"TotalMatches\":0,
   \"PEPVolume\":0,
   \"RCAVolume\":0,
   \"WBLVolume\":0,
   \"SANVolume\":0,
   \"AVMVolume\":0,
   \"UNKVolume\":0,
   \"DLThreads\":2,
   \"NSThreads\":2}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
BatchID Int 32
StartDate Date
EndDate Date
Searches Int 32
InitialMatchesFound Int 32
InitialMatchesDiscMultiMatch Int 32
InitialMatchesDiscExisting Int 32
InitialMatchesDiscWhiteList Int 32
InitialMatchesDiscDateMeta Int 32
InitialMatchesDiscCountryMetaInt 32
InitialMatchesDiscTotal Int 32
ClientVolume Int 32
TotalMatches Int 32
PEPVolume Int 32
RCAVolume Int 32
WBLVolume Int 32
SANVolume Int 32
AVMVolume Int 32
UNKVolume Int 32
DLThreads Int 16
NSDLThreads Int 16
Report - Client Notify Change
Action:
CLIENTNOTIFYCHANGE
Method:
GET
URL: /api/v1/report/matchmonitor/clientnotifychange
Description: Fetch Client Notify Change Report
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Notify Change Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"DataFeedID\":624,
   \"ClientEntityID\":200215042,
   \"ClientLastName\":\"AL ASSAD\",
   \"ClientFirstName\":\"ASMA\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":307912,
   \"EntityFullName\":\"ASMA AL-ASSAD\",
   \"Area\":2,
   \"AreaName\":\"Match Flagged\",
   \"DataFeedDate\":\"2019-08-07T00:00:00\",
   \"Notify\":true,
   \"NotifyName\":\"Yes\",
   \"UserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"UserName\":\"user235\",
   \"Deleted\":false,
   \"DeletedName\":\"No\",
   \"RecordChanged\":true,
   \"RecordChangedName\":\"Yes\",
   \"ClassificationChanged\":false,
   \"ClassificationChangedName\":\"No\",
   \"NameChanged\":false,
   \"NameChangedName\":"No",
   \"DateChanged\":false,
   \"DateChangedName\":\"No\",
   \"AddressChanged\":false,
   \"AddressChangedName\":\"No\",
   \"CountryChanged\":false,
   \"CountryChangedName\":\"No\"}]"
  }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
DataFeedID Int 32
ClientEntityID Int 32
ClientLastName Text 150
ClientFirstName Text 150
ClientMiddleName Text 150
EntityID Int 32
EntityFullName Text 150
Area Int 16
AreaName Text 150
DataFeedDate Date
Notify Boolean
NotifyName Text 3
UserGroupName Text 150
UserName Text 150
Deleted Boolean
DeletedName Text 3
RecordChanged Boolean
RecordChangedName Text 3
ClassificationChanged Boolean
ClassificationChangedName Text 3
NameChanged Boolean
NameChangedName Text 3
DateChanged Boolean
DateChangedName Text 3
AddressChanged Boolean
AddressChangedName Text 3
CountryChanged Boolean
CountryChangedName Text 3
Report - Match Flag Paged
Action:
MATCHFLAGBYDAYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchflagbydaypaged
Description: Fetch Match Flag Report 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 0 View All if not provided)
Params UserID Int16 User Identifier
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Flag Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700127,
   \"ClientLastName\":\"ROBINSON\",
   \"ClientFirstName\":\"JASON"\,
   \"ClientMiddleName\":\"\",
   \"EntityID\":11730606,
   \"EntityFullName\":\"JASON LEE ROBINSON\",
   \"EntityLastName\":\"ROBINSON\",
   \"EntityFirstName\":\"JASON\",
   \"EntityMiddleName\":\"LEE\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-08-08T00:00:00\",
   \"ActionDays\":71,
   \"Note\":\"\",
   \"MatchFlaggedCategoryID\":1,
   \"MatchFlaggedCategoryName\":\"Relevant Acceptable - Generic\",
   \"MetaDate\":\"1969 | 1970\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":174,
   \"HandledByUserName\":\"user174\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"StartDate\":\"2019-01-01T00:00:00\",
   \"EndDate\":\"2019-10-01T00:00:00\"}]"
  }],
 "SubreportDataSources": null,
 "MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchFlaggedCategoryID Int 16
MatchFlaggedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
StartDate Date
EndDate Date
Field Data Type
MainReportDataRowCount Int 32
Report - Match Discount Paged
Action:
MATCHDISCOUNTBYDAYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchdiscountbydaypaged
Description: Fetch Match Discount Report 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 0 View All if not provided)
Params UserID Int16 User Identifier
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Discount Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700127,
   \"ClientLastName\":\"ROBINSON\",
   \"ClientFirstName\":\"JASON\",
   \"ClientMiddleName\":\"\",
   \"EntityI\D":11730606,
   \"EntityFullName\":\"JASON LEE ROBINSON\",
   \"EntityLastName\":\"ROBINSON\",
   \"EntityFirstName\":"\JASON\",
   \"EntityMiddleName\":\"LEE\",
   \"GeneratedDate\":\"2019-05-29T00:00:00\",
   \"MatchedDate\":\"2019-08-08T00:00:00\",
   \"ActionDays\":71,
   \"Note\":\"\",
   \"MatchDiscountedCategoryID\":2,
   \"MatchDiscountedCategoryName\":\"Date does not match\",
   \"MetaDate\":\"1969 | 1970\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":174,
   \"HandledByUserName\":\"user174\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"StartDate\":\"2019-01-01T00:00:00\",
   \"EndDate\":\"2019-10-01T00:00:00\"}]"
  }],
 "SubreportDataSources": null,
 "MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscountedCategoryID Int 16
MatchDiscountedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
StartDate Date
EndDate Date
Field Data Type
MainReportDataRowCount Int 32
Report - Match Potential Paged
Action:
MATCHPOTENTIALPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotentialpaged
Description: Fetch Match Potential Report 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 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params IncludeSummary Boolean True- Include Summary Data and Match Details. False - Only Match Details (SubreportDataSources will be empty and data will returned in ReportDataSources
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":101,
   \"ClientName\":\"local-Client-101\",
   \"ClientEntityID\":20700007,
   \"ClientEntityLastName\":\"HUSSAIN\",
   \"ClientEntityFirstName\":\"ASIF\",
   \"ClientEntityMiddleName\":\"\",
   \"GeneratedDate\":\"2018-06-19T00:00:00\",
   \"Priority\":1,
   \"NumberOfPotentialMatches\":13,
   \"IsDateMatch\":true,
   \"IsCountryMatch\":true,
   \"IsPEPVolume\":0,
   \"IsRCAVolume\":1,
   \"IsWBLVolume\":12,
   \"IsSANVolume\":0,
   \"IsAVMVolume\":0,
   \"IsOTHVolume\":0,
   \"IsUNKVolume\":0,
   \"HandledByUserGroupID\":206,
   \"HandledByUserGroupName\":\"local-Swiss Handler Users-206\",
   \"HandledByUserID\":104,
   \"HandledByUserName\":\"user104\"}]"
 }],
 "SubreportDataSources": [{
  "key": "MatchPotential_SR0-ClientID-101-ClientEntityID-20700007-HandledByUserGroupID-206",
  "value": [{
   "Name": "ReportDataSet1",
   "Value": "[{
    \"ClientID\":101,
    \"ClientName\":\"local-Client-101\",
    \"ClientEntityID\":20700007,
    \"EntityID\":2256988,
    \"EntityFullName\":\"ASIF HUSSAIN\",
    \"GeneratedDate\":\"2018-06-19T00:00:00\",
    \"LastName\":\"HUSSAIN\",
    \"LastNameJCBias\":1.0,
    \"FirstName\":\"ASIF\",
    \"FirstNameJCBias\":1.0,
    \"MiddleName\":"",
    \"MiddleNameJCBias\":0.0,
    \"AverageJCBias\":1.0,
    \"IsPEP\":\"No\",
    \"IsRCA\":\"No\",
    \"IsWBL\":\"Yes\",
    \"IsSAN\":\"No\",
    \"IsAVM\":\"No\",
    \"IsOTH\":\"No\",
    \"IsUNK\":\"No\",
    \"IsDateMatch\":\"No\",
    \"IsCountryMatch\":\"Yes\",
    \"FileCriteriaID\":1,
    \"FileCriteriaName\":\"local-Client-100 - Person\",
    \"HandledByUserGroupID\":206,
    \"HandledByUserGroupName\":\"local-Swiss Handler Users-206\",
    \"HandledByUserID\":104,
    \"HandledByUserName\":\"user104\",
    \"Status\":0,
    \"Priority\":1,
    \"MetaBump\":20}]"
  }]
 }],
 "MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
Priority Byte
NumberOfPotentialMatches Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
EntityID Int 32
EntityFullName Text 255
GeneratedDate Date
LastName Text 255
LastNameJCBias Double
FirstName Text 255
FirstNameJCBias Double
MiddleName Text 255
MiddleNameJCBias Double
AverageNameJCBias Double
IsPEP Text 3
IsRCA Text 3
IsWBL Text 3
IsSAN Text 3
IsAVM Text 3
IsOTH Text 3
IsUNK Text 3
IsDateMatch Text 3
IsCountryMatch Text 3
FileCriteriaID Int 16
FileCriteriaName Text 150
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Status Byte
Priority Byte
MetaBump Byte
Field Data Type
MainReportDataRowCount Int 32
Report - Match Potential Summary Paged
Action:
MATCHPOTENTIALSUMMARYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchpotentialsummarypaged
Description: Fetch Match Potential Summary Report 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 0 View All if not provided)
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Potential Summary Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientEntityLastName\":\"WILSON\",
   \"ClientEntityFirstName\":\"BRIAN\",
   \"ClientEntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"DaysOutstanding\":5,
   \"Priority\":9,
   \"MetaBump\":25,
   \"NumberOfPotentialMatches\":11,
   \"IsDateMatch\":true,
   \"IsCountryMatch\":true,
   \"IsPEPVolume\":3,
   \"IsRCAVolume\":0,
   \"IsWBLVolume\":8,
   \"IsSANVolume\":0,
   \"IsAVMVolume\":0,
   \"IsOTHVolume\":0,
   \"IsUNKVolume\":0,
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
 }],
 "SubreportDataSources": null,
 ""MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
GeneratedDate Date
DaysOutstanding Int 16
Priority Byte
MetaBump Byte
NumberOfPotentialMatches Int 32
IsDateMatch Boolean
IsCountryMatch Boolean
IsPEPVolume Int 32
IsRCAVolume Int 32
IsWBLVolume Int 32
IsSANVolume Int 32
IsAVMVolume Int 32
IsOTHVolume Int 32
IsUNKVolume Int 32
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
MainReportDataRowCount Int 32
Report - Match Data By Day Paged
Action:
MATCHDATABYDAYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchdatabydaypaged
Description: Fetch Match Data By Day Report for the given PageIndex and Number of Rows to fetch
Type Key DataType Notes
Headers api-key String Your Api-Key
Params UserID Int16 User Identifier
Params Date Date Date
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Data By Day Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"MatchType\":\"Outstanding\",
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":200260791,
   \"ClientEntityLastName\":\"JONES\",
   \"ClientEntityFirstName\":\"\",
   \"ClientEntityMiddleName\":\"MERVYN\",
   \"EntityID\":67827,
   \"EntityFullName\":\"MACIFIERRAN MOMO JIBBA\",
   \"GeneratedDate\":\"2019-10-01T00:00:00\",
   \"LastName\":\"JONES\",
   \"LastNameJCBias\":1.0,
   \"FirstName\":\"MO\",
   \"FirstNameJCBias\":0.0,
   \"MiddleName\":\"\",
   \"MiddleNameJCBias\":0.0,
   \"AverageJCBias\":0.5,
   \"IsPEP\":\"Yes\",
   \"IsRCA\":\"No\",
   \"IsWBL\":\"Yes",
   \"IsSAN\":\"Yes",
   \"IsAVM\":\"No\",
   \"IsOTH\":\"No\",
   \"IsUNK\":\"No\",
   \"IsDateMatch\":\"No\",
   \"IsCountryMatch\":\"No\",
   \"FileCriteriaID\":1,
   \"FileCriteriaName\":\"local-Client-100 - Person\",
   \"HandledByUserGroupID\":203,
   \"HandledByUserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\",
   \"Status\":0,
   \"Priority\":9,
   \"MetaBump\":0}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"MatchType\":\"Discounted\",
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":"",
   \"EntityID\":11450391,
   \"EntityFullName\":\"BRYAN WILSON\",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRYAN\",
   \"EntityMiddleName\":\"\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"yellow\",
   \"MatchFlaggedCategoryID\":1,
   \"MatchFlaggedCategoryName\":\"Relevant Acceptable - Generic\",
   \"MetaDate\":\"\",
   \"MetaCountry\":\"Citizenship : New Zealand | Jurisdiction : New Zealand | Resident of : New Zealand\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  },
  {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"MatchType\":\"Flagged\",
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":934883,
   \"EntityFullName\":"BRIAN KEITH WILSON",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRIAN\",
   \"EntityMiddleName\":\"KEITH\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"grey\",
   \"MatchDiscountedCategoryID\":1,
   \"MatchDiscountedCategoryName\":\"Address does not match\",
   \"MetaDate\":\"1972 | 1973\",
   \"MetaCountry\":\"Citizenship : United States | Resident of : United States | Address : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  }],
 "SubreportDataSources": null,
 ""MainReportDataRowCount": 1000
}
Field Data Type
MatchType Text 16
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
GeneratedDate Date
LastName Text 255
LastNameJCBias Double
FirstName Text 255
FirstNameJCBias Double
MiddleName Text 255
MiddleNameJCBias Double
AverageNameJCBias Double
IsPEP Text 3
IsRCA Text 3
IsWBL Text 3
IsSAN Text 3
IsAVM Text 3
IsOTH Text 3
IsUNK Text 3
IsDateMatch Text 3
IsCountryMatch Text 3
FileCriteriaID Int 16
FileCriteriaName Text 150
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Status Byte
Priority Byte
MetaBump Byte
Field Data Type
MatchType Text 16
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchFlaggedCategoryID Int 16
MatchFlaggedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
MatchType Text 16
ClientID Int 16
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscountedCategoryID Int 16
MatchDiscountedCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
MainReportDataRowCount Int 32
Report - Match Discount By Category Paged
Action:
MATCHDISCOUNTBYCATEGORYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchdiscountbycategorypaged
Description: Fetch Match Discount By Category Report for the given PageIndex and Number of Rows to fetch
Type Key DataType Notes
Headers api-key String Your Api-Key
Params FromDate Date Start Date
Params ToDate Date End Date
Params MatchDiscountCategoryID Int16 Match Discount Category Identifier
Params UserID Int16 User Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Discount By Category Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"CLMD_STCL_ID\":100,
   \"CLMD_STCL_NAME\":\"local-Client-100\",
   \"CLMD_CLEN_ID\":10700005,
   \"CLMD_CLEN_IFREF\":\"10700005\",
   \"CLMD_CLEN_LASTNAME\":\"HASSAN\",
   \"CLMD_CLEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_CLEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ID\":951433,
   \"CLMD_DAEN_FULLNAME\":\"AHMED HASSAN\",
   \"CLMD_DAEN_LASTNAME\":\"HASSAN\",
   \"CLMD_DAEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_DAEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ISPEP\":false,
   \"CLMD_DAEN_ISRCA\":false,
   \"CLMD_DAEN_ISWBL\":true,
   \"CLMD_DAEN_ISSAN\":false,
   \"CLMD_DAEN_ISAVM\":false,
   \"CLMD_DAEN_ISOTH\":false,
   \"CLMD_DAEN_ISUNK\":false,
   \"CLMD_GENDATE\":\"2019-05-29T00:00:00\",
   \"CLMD_MATCHDATE\":\"2019-09-13T00:00:00\",
   \"CLMD_ACTIONDAYS\":107,
   \"CLMD_NOTE\":\"test discount AH\",
   \"CLMD_STMD_ID\":1,
   \"CLMD_STMD_NAME\":\"Address does not match\",
   \"CLMD_METADATE\":\"01 Jan 1970\",
   \"CLMD_METACOUNTRY\":\"Citizenship : Somalia\",
   \"CLMD_VALIDTO\":\"2099-12-31T00:00:00\",
   \"CLMD_NOTIFY\":true,
   \"CLMD_HBY_STUG_ID\":203,
   \"CLMD_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMD_HBY_STUR_ID\":101,
   \"CLMD_HBY_STUR_NAME\":\"user101\",
   \"CLMD_DLC\":\"2019-09-13T09:14:51.86\",
   \"CLMD_LCBU\":101,
   \"CLMD_DAEN_ISPEPFMT\":\"No\",
   \"CLMD_DAEN_ISRCAFMT\":\"No\",
   \"CLMD_DAEN_ISWBLFMT\":\"Yes\",
   \"CLMD_DAEN_ISSANFMT\":\"No\",
   \"CLMD_DAEN_ISAVMFMT\":\"No\",
   \"CLMD_DAEN_ISOTHFMT\":\"No\"}]"
   \"CLMD_DAEN_ISUNKFMT\":\"No\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"FromDate\":\"2019-01-01T00:00:00\",
   \"ToDate\":\"2019-10-01T00:00:00\"}]"
 }],
 "SubreportDataSources": null
 ""MainReportDataRowCount": 1000
}
Field Data Type
CLMD_STCL_ID Int 16
CLMD_STCL_NAME Text 150
CLMD_CLEN_ID Int 32
CLMD_CLEN_LASTNAME Text 150
CLMD_CLEN_FIRSTNAME Text 150
CLMD_CLEN_MIDDLENAME Text 150
CLMD_DAEN_ID Int 32
CLMD_DAEN_FULLNAME Text 150
CLMD_DAEN_LASTNAME Text 150
CLMD_DAEN_FIRSTNAME Text 150
CLMD_DAEN_MIDDLENAME Text 150
CLMD_DAEN_ISPEP Boolean
CLMD_DAEN_ISRCA Boolean
CLMD_DAEN_ISWBL Boolean
CLMD_DAEN_ISSAN Boolean
CLMD_DAEN_ISAVM Boolean
CLMD_DAEN_ISOTH Boolean
CLMD_DAEN_ISUNK Boolean
CLMD_GENDATE Date
CLMD_MATCHDATE Date
CLMD_ACTIONDAYS Int 32
CLMD_NOTE Text 2GB
CLMD_STMD_ID Int 16
CLMD_STMD_NAME Text 150
CLMD_METADATE Text 4000
CLMD_METACOUNTRY Text 4000
CLMD_VALIDTO Date
CLMD_NOTIFY Boolean
CLMD_HBY_STUG_ID Int 16
CLMD_HBY_STUG_NAME Text 150
CLMD_HBY_STUR_ID Int 16
CLMD_HBY_STUR_NAME Text 150
CLMD_DLC Date
CLMD_LCBU Int 16
CLMD_DAEN_ISPEPFMT Text 3
CLMD_DAEN_ISRCAFMT Text 3
CLMD_DAEN_ISWBLFMT Text 3
CLMD_DAEN_ISSANFMT Text 3
CLMD_DAEN_ISAVMFMT Text 3
CLMD_DAEN_ISOTHFMT Text 3
CLMD_DAEN_ISUNKFMT Text 3
Field Data Type
FromDate Date
ToDate Date
Field Data Type
MainReportDataRowCount Int 32
Report - Match Flag By Category Paged
Action:
MATCHFLAGBYCATEGORYPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchflagbycategorypaged
Description: Fetch Match Flag By Category Report for the given PageIndex and Number of Rows to fetch
Type Key DataType Notes
Headers api-key String Your Api-Key
Params FromDate Date Start Date
Params ToDate Date End Date
Params MatchFlagCategoryID Int16 Match Flag Category Identifier
Params UserID Int16 User Identifier
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Flag By Category Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"CLMD_STCL_ID\":100,
   \"CLMD_STCL_NAME\":\"local-Client-100\",
   \"CLMD_CLEN_ID\":10700005,
   \"CLMD_CLEN_IFREF\":\"10700005\",
   \"CLMD_CLEN_LASTNAME\":\"HASSAN\",
   \"CLMD_CLEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_CLEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ID\":951433,
   \"CLMD_DAEN_FULLNAME\":"AHMED HASSAN",
   \"CLMD_DAEN_LASTNAME\":\"HASSAN\",
   \"CLMD_DAEN_FIRSTNAME\":\"AHMED\",
   \"CLMD_DAEN_MIDDLENAME\":\"\",
   \"CLMD_DAEN_ISPEP\":false,
   \"CLMD_DAEN_ISRCA\":false,
   \"CLMD_DAEN_ISWBL\":true,
   \"CLMD_DAEN_ISSAN\":false,
   \"CLMD_DAEN_ISAVM\":false,
   \"CLMD_DAEN_ISOTH\":false,
   \"CLMD_DAEN_ISUNK\":false,
   \"CLMD_GENDATE\":\"2019-05-29T00:00:00\",
   \"CLMD_MATCHDATE\":\"2019-09-13T00:00:00\",
   \"CLMD_ACTIONDAYS\":107,
   \"CLMD_NOTE\":\"test flag AH\",
   \"CLMD_STMD_ID\":2,
   \"CLMD_STMD_NAME\":\"Relevant Acceptable - Generic\",
   \"CLMD_METADATE\":\"01 Jan 1970\",
   \"CLMD_METACOUNTRY\":\"Citizenship : Somalia\",
   \"CLMD_VALIDTO\":\"2099-12-31T00:00:00\",
   \"CLMD_NOTIFY\":true,
   \"CLMD_HBY_STUG_ID\":203,
   \"CLMD_HBY_STUG_NAME\":\"STG Jersey Demo Handlers Group\",
   \"CLMD_HBY_STUR_ID\":101,
   \"CLMD_HBY_STUR_NAME\":\"user101\",
   \"CLMD_DLC\":\"2019-09-13T09:14:51.86\",
   \"CLMD_LCBU\":101,
   \"CLMD_DAEN_ISPEPFMT\":\"No\",
   \"CLMD_DAEN_ISRCAFMT\":\"No\",
   \"CLMD_DAEN_ISWBLFMT\":\"Yes\",
   \"CLMD_DAEN_ISSANFMT\":\"No\",
   \"CLMD_DAEN_ISAVMFMT\":\"No\",
   \"CLMD_DAEN_ISOTHFMT\":\"No\"}]"
   \"CLMD_DAEN_ISUNKFMT\":\"No\"}]"
  },
  {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"FromDate\":\"2019-01-01T00:00:00\",
   \"ToDate\":\"2019-10-01T00:00:00\"}]"
 }],
 "SubreportDataSources": null
 ""MainReportDataRowCount": 1000
}
Field Data Type
CLMD_STCL_ID Int 16
CLMD_STCL_NAME Text 150
CLMD_CLEN_ID Int 32
CLMD_CLEN_LASTNAME Text 150
CLMD_CLEN_FIRSTNAME Text 150
CLMD_CLEN_MIDDLENAME Text 150
CLMD_DAEN_ID Int 32
CLMD_DAEN_FULLNAME Text 150
CLMD_DAEN_LASTNAME Text 150
CLMD_DAEN_FIRSTNAME Text 150
CLMD_DAEN_MIDDLENAME Text 150
CLMD_DAEN_ISPEP Boolean
CLMD_DAEN_ISRCA Boolean
CLMD_DAEN_ISWBL Boolean
CLMD_DAEN_ISSAN Boolean
CLMD_DAEN_ISAVM Boolean
CLMD_DAEN_ISOTH Boolean
CLMD_DAEN_ISUNK Boolean
CLMD_GENDATE Date
CLMD_MATCHDATE Date
CLMD_ACTIONDAYS Int 32
CLMD_NOTE Text 2GB
CLMD_STMD_ID Int 16
CLMD_STMD_NAME Text 150
CLMD_METADATE Text 4000
CLMD_METACOUNTRY Text 4000
CLMD_VALIDTO Date
CLMD_NOTIFY Boolean
CLMD_HBY_STUG_ID Int 16
CLMD_HBY_STUG_NAME Text 150
CLMD_HBY_STUR_ID Int 16
CLMD_HBY_STUR_NAME Text 150
CLMD_DLC Date
CLMD_LCBU Int 16
CLMD_DAEN_ISPEPFMT Text 3
CLMD_DAEN_ISRCAFMT Text 3
CLMD_DAEN_ISWBLFMT Text 3
CLMD_DAEN_ISSANFMT Text 3
CLMD_DAEN_ISAVMFMT Text 3
CLMD_DAEN_ISOTHFMT Text 3
CLMD_DAEN_ISUNKFMT Text 3
Field Data Type
FromDate Date
ToDate Date
Field Data Type
MainReportDataRowCount Int 32
Report - Match Checking Paged
Action:
MATCHCHECKINGPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/matchcheckingpaged
Description: Fetch Match Checking Report for the given PageIndex and Number of Rows to fetch
Type Key DataType Notes
Headers api-key String Your Api-Key
Params Date Date Date
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 0 View All if not provided)
Params UserID Int16 User Identifier
Params UserGroupID Int16 User Group Identifier (0 to View All)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Match Checking Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientInterfaceReference\":\"10700181\",
   \"ClientName\":\"local-Client-100\",
   \"ClientEntityID\":10700181,
   \"ClientLastName\":\"WILSON\",
   \"ClientFirstName\":\"BRIAN\",
   \"ClientMiddleName\":\"\",
   \"ClientCountry1Name\":\"United Kingdom\",
   \"ClientCountry2Name\":\"Unknown\",
   \"ClientCountry3Name\":\"Unknown\",
   \"ClientDateOfBirth\":\"1981-12-07T00:00:00\",
   \"ClientGenderName\":\"Male\",
   \"ClientCriteriaName\":\"local-Client-100 - Person High Risk\",
   \"ClientRiskName\":\"High\",
   \"ClientDateAdded\":\"2017-12-01T00:00:00\",
   \"EntityID\":934883,
   \"EntityFullName\":\"BRIAN KEITH WILSON\",
   \"EntityLastName\":\"WILSON\",
   \"EntityFirstName\":\"BRIAN\",
   \"EntityMiddleName\":\"KEITH\",
   \"EntityGender\":\"Male\",
   \"EntityIsPEP\":\"No\",
   \"EntityIsRCA\":\"No\",
   \"EntityIsWBL\":\"Yes\",
   \"EntityIsSAN\":\"No\",
   \"EntityIsAVM\":\"No\",
   \"EntityIsOTH\":\"No\",
   \"EntityIsUNK\":\"No\",
   \"GeneratedDate\":\"2019-09-30T00:00:00\",
   \"MatchedDate\":\"2019-10-01T00:00:00\",
   \"ActionDays\":1,
   \"Note\":\"grey\",
   \"MatchDiscFlag\":\"Discount\",
   \"MatchCategoryName\":\"Address does not match\",
   \"MetaDate\":\"1972 | 1973\",
   \"MetaCountry\":\"Citizenship : United States\",
   \"ValidToDate\":\"2099-12-31T00:00:00\",
   \"Notify\":\"Yes\",
   \"HandledByUserGroupID\":204,
   \"HandledByUserGroupName\":\"local-Jersey Monitor Users-204\",
   \"HandledByUserID\":101,
   \"HandledByUserName\":\"user101\"}]"
  }],
 "SubreportDataSources": null,
 ""MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientInterfaceReference Text 150
ClientName Text 150
ClientEntityID Int 32
ClientLastName Text 255
ClientFirstName Text 255
ClientMiddleName Text 255
ClientCountry1Name Text 150
ClientCountry2Name Text 150
ClientCountry3Name Text 150
ClientDateOfBirth Date
ClientGenderName Text 150
ClientCriteriaName Text 150
ClientRiskName Text 150
ClientDateAdded Date
EntityID Int 32
EntityFullName Text 255
EntityLastName Text 255
EntityFirstName Text 255
EntityMiddleName Text 255
EntityGender Text 150
EntityIsPEP Text 3
EntityIsRCA Text 3
EntityIsWBL Text 3
EntityIsSAN Text 3
EntityIsAVM Text 3
EntityIsOTH Text 3
EntityIsUNK Text 3
GeneratedDate Date
MatchedDate Date
ActionDays Int 16
Note Text 2GB
MatchDiscFlag Text 8
MatchCategoryName Text 150
MetaDate Text 4000
MetaCountry Text 4000
ValidToDate Date
Notify Text 3
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
Field Data Type
MainReportDataRowCount Int 32
Report - Client Notify Change Paged
Action:
CLIENTNOTIFYCHANGEPAGED
Method:
GET
URL: /api/v1/report/matchmonitor/clientnotifychangepaged
Description: Fetch Client Notify Change Report 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 0 View All if not provided)
Params FromDate Date From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Notify Change Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":100,
   \"ClientName\":\"local-Client-100\",
   \"DataFeedID\":624,
   \"ClientEntityID\":200215042,
   \"ClientLastName\":\"AL ASSAD\",
   \"ClientFirstName\":\"ASMA\",
   \"ClientMiddleName\":\"\",
   \"EntityID\":307912,
   \"EntityFullName\":\"ASMA AL-ASSAD\",
   \"Area\":2,
   \"AreaName\":\"Match Flagged\",
   \"DataFeedDate\":\"2019-08-07T00:00:00\",
   \"Notify\":true,
   \"NotifyName\":\"Yes\",
   \"UserGroupName\":\"STG Jersey Demo Handlers Group\",
   \"UserName\":\"user235\",
   \"Deleted\":false,
   \"DeletedName\":\"No\",
   \"RecordChanged\":true,
   \"RecordChangedName\":\"Yes\",
   \"ClassificationChanged\":false,
   \"ClassificationChangedName\":\"No\",
   \"NameChanged\":false,
   \"NameChangedName\":\"No\",
   \"DateChanged\":false,
   \"DateChangedName\":\"No\",
   \"AddressChanged\":false,
   \"AddressChangedName\":\"No\",
   \"CountryChanged\":false,
   \"CountryChangedName\":\"No\"}]"
  }],
 "SubreportDataSources": null,
 ""MainReportDataRowCount": 1000
}
Field Data Type
ClientID Int 16
ClientName Text 150
DataFeedID Int 32
ClientEntityID Int 32
ClientLastName Text 150
ClientFirstName Text 150
ClientMiddleName Text 150
EntityID Int 32
EntityFullName Text 150
Area Int 16
AreaName Text 150
DataFeedDate Date
Notify Boolean
NotifyName Text 3
UserGroupName Text 150
UserName Text 150
Deleted Boolean
DeletedName Text 3
RecordChanged Boolean
RecordChangedName Text 3
ClassificationChanged Boolean
ClassificationChangedName Text 3
NameChanged Boolean
NameChangedName Text 3
DateChanged Boolean
DateChangedName Text 3
AddressChanged Boolean
AddressChangedName Text 3
CountryChanged Boolean
CountryChangedName Text 3
Field Data Type
MainReportDataRowCount Int 32