Monday, May 20, 2024

Report - Client Onboarding Summary
Action:
CLIENTONBOARDINGSUMMARY
Method:
GET
URL: /api/v1/report/clientonboarding/clientonboardingsummary
Description: Fetch Client Onboarding 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 OnboardingTypeID Int16 Onboarding Type Identifier (optional - value defaulted to 0 View All if not provided)
Params OnboardingStageID Byte Onboarding Stage Identifier (0 = View All, 1 = Data Collection, 2 = Data Approval, 3 = Identity Verification, 4 = Identity Approval, 5 = Screening, 6 = Compliance Approval, 99 = All Active, 100 = Rejected, 101 = Awaiting Handler Submission, 102 = Onboarded, 103 = Awaiting Handler Approval, 104 = Awaiting Supervisor Approval, 105 = Awaiting Manager Approval, 106 = Awaiting Director Approval)
Params HandledByUserGroupID Int16 User Group Identifier of the user handling the prospect (0 to View All)
Params HandledByUserID Int16 User Identifier (optional - value defaulted to 0 View All if not provided)
Params IsTestSystem Boolean Executing on TEST System? (True = Yes, False = No, Optional default is False)
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 Onboarding Summary Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":102,
   \"BusinessUnitID\":10,
   \"ClientName\":\"LocalClient\",
   \"BusinessUnitName\":\"Default\",
   \"ClientProspectID\":300072,
   \"ClientProspectName\":\"Anthony White\",
   \"ClientOnboardingTypeName\":\"Onboarding Type\",
   \"ClientOnboardingID\":456789,
   \"ClientOnboardingStageStatusName\":\"Data Collection\",
   \"ClientOnboardingIDPalUUID\":\"UUIID4D\",
   \"HandledByUserGroupName\":\"Handler Group\",
   \"HandledByUserName\":\"Support\",
   \"ClientProspectAddedDate\":\"2018-06-19T00:00:00\",
   \"ClientOnboardingAddedDate\":\"2018-06-19T00:00:00\",
   \"ClientOnboardingURL\":\"https://batch.riskscreen.com/onboarding/edit/456789?prospectid=300072\"
 }],
 "SubreportDataSources": [{
  "key": "ClientOnboardingSummary_SR0-ClientID-102-BusinessUnitID-10-ClientProspectID-300072-ClientOnboardingID-456789",
  "value": [{
   "Name": "ReportDataSet1",
   "Value": "[{
    \"ClientProspectID\":300072,
    \"ClientOnboardingID\":456789,
    \"ClientOnboardingStageDate\":\"2018-06-19T00:00:00\",
    \"ClientOnboardingStageName\":\"Data Collection\"}]"
  },
  {
   "Name": "ReportDataSet2",
   "Value": "[{
    \"ClientProspectID\":300072,
    \"ClientOnboardingID\":456789,
    \"ClientOnboardingApprovalUserRole\":\"Handler\",
    \"ClientOnboardingApprovalStatusName\":\"Submitted for approval\",
    \"ClientOnboardingApprovalNotes\":\"No flag or matches\",
    \"ClientOnboardingApprovalUserName\":\"Support\",
    \"ClientOnboardingApprovalAuthDate\":\"2018-06-20T13:45:00\"}]"
  },
  {
   "Name": "ReportDataSet3",
   "Value": "[{
    \"ClientProspectID\":300072,
    \"ClientOnboardingID\":456789,
    \"ClientOnboardingAuditAction\":\"Handler\",
    \"ClientOnboardingAuditDate\":\"2018-06-20T13:45:00\",
    \"ClientOnboardingAuditActioningUserName\":\"Support\",
    \"ClientOnboardingAuditDataChanges\":\"null\"}]"
  }]
 }]
}
Field Data Type
ClientID Int 16
BusinessUnitID Int 32
ClientName Text 150
BusinessUnitName Text 255
ClientProspectID Int 32
ClientProspectName Text 255
ClientOnboardingTypeName Date
ClientOnboardingID Int 32
ClientOnboardingStageStatusName Text 255
ClientOnboardingIDPalUUID Text 255
HandledByUserGroupName Text 255
HandledByUserName Text 255
ClientProspectAddedDate Date
ClientOnboardingAddedDate Date
ClientOnboardingURL Text 255
Field Data Type
ClientProspectID Int 32
ClientOnboardingID Int 32
ClientOnboardingStageDate Date
ClientOnboardingStageName Text 150
ClientOnboardingApprovalUserRole Text 255
ClientOnboardingApprovalStatusName Text 255
ClientOnboardingApprovalNotes Text 255
ClientOnboardingApprovalUserName Text 255
ClientOnboardingApprovalAuthDate Date
ClientOnboardingTotalStageDuration Int 16
ClientOnboardingAuditAction Text 255
ClientOnboardingAuditDate Date
ClientOnboardingAuditActioningUserName Text 255
ClientOnboardingAuditDataChanges Text 255
Action:
CLIENTONBOARDINGDCFSUMMARY
Method:
GET
URL: /api/v1/report/clientonboarding/dcfSummary
Description: Fetch Client Onboarding Data Collection Form 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 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 Onboarding Summary Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":102,
   \"ClientName\":\"LocalClient\",
   \"BusinessUnitID\":10,
   \"BusinessUnitName\":\"Default\",
   \"ProspectsDCFSentCount\":\"3\",
   \"OnBoardingsDCFSentCount\":\"3\",
   \"TotalNoOfDCFSent\":2,
   \"DCFLinkOpenedCount\":\"1\",
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Text 255
ProspectsDCFSentCount Int 32
OnBoardingsDCFSentCount Int 32
TotalNoOfDCFSent Int 32
DCFLinkOpenedCount Int 32
Action:
CLIENTONBOARDINGDCFRESPONSETIME
Method:
GET
URL: /api/v1/report/clientonboarding/dcfresponsetime
Description: Fetch Client Onboarding Data Collection Form Response Time Report
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 From Date (yyyy-mm-dd)
Params ToDate Date To Date (yyyy-mm-dd)
Params FirstRequestSentLapsedDays Int32 Lapsed Days since first request sent (default 0 if not provided)
Params LinkNotClickedLapsedDays Int32 Lapsed days since link was not clicked (default 0 if not provided)
Params LinkClickedNotSubmittedLapsedDays Int32 Lapsed days since link was clicked but not submitted (default 0 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Entity Detail Report
{
 "ReportDataSources": [
 {
  "Name": "ReportDataSet1",
  "Value": "[{
   \"ClientID\":102,
   \"ClientName\":\"LocalClient\",
   \"BusinessUnitID\":10,
   \"BusinessUnitName\":\"Default\",
   \"TotalNoOfDCFSent\":\"3\",
   \"ClientProspectID\":\"450023\",
   \"ClientProspectFirstName\":VLADIMIR,
   \"ClientProspectLastName\":PUTIN,
   \"ClientOnboardingID\":200,
   \"OnboardingTypeID\":null,
   \"OnboardingTypeName\":Person,
   \"DataRequestID\":209e10de-dfee-4085-94e1-74a46ac14c9f,
   \"RequestSentDate\":\"21/12/2021 07:09:36\",
   \"RequestExpiryDate\":\"25/12/2021 07:09:36\",
   \"HandledByUserGroupID\":\"230\",
   \"HandledByUserGroupName\":\"Admin Group\",
   \"HandledByUserID\":\"101\",
   \"HandledByUserName\":\"Chandramohan Ganorkar\",
   \"LapsedDays\":\"806\" }]"
 },
 {
  "Name": "ReportDataSet2",
  "Value": "[{
   \"ClientID\":102,
   \"ClientName\":\"LocalClient\",
   \"BusinessUnitID\":10,
   \"BusinessUnitName\":\"Default\",
   \"TotalNoOfDCFSent\":\"3\",
   \"ClientProspectID\":\"450023\",
   \"ClientProspectFirstName\":VLADIMIR,
   \"ClientProspectLastName\":PUTIN,
   \"ClientOnboardingID\":200,
   \"OnboardingTypeID\":null,
   \"OnboardingTypeName\":Person,
   \"DataRequestID\":209e10de-dfee-4085-94e1-74a46ac14c9f,
   \"RequestSentDate\":\"21/12/2021 07:09:36\",
   \"RequestExpiryDate\":\"25/12/2021 07:09:36\",
   \"HandledByUserGroupID\":\"230\",
   \"HandledByUserGroupName\":\"Admin Group\",
   \"HandledByUserID\":\"101\",
   \"HandledByUserName\":\"Chandramohan Ganorkar\",
   \"LapsedDays\":\"806\" }]"
 }],
 {
  "Name": "ReportDataSet3",
  "Value": "[{
   \"ClientID\":102,
   \"ClientName\":\"LocalClient\",
   \"BusinessUnitID\":10,
   \"BusinessUnitName\":\"Default\",
   \"TotalNoOfDCFSent\":\"3\",
   \"ClientProspectID\":\"450023\",
   \"ClientProspectFirstName\":VLADIMIR,
   \"ClientProspectLastName\":PUTIN,
   \"ClientOnboardingID\":200,
   \"OnboardingTypeID\":null,
   \"OnboardingTypeName\":Person,
   \"DataRequestID\":209e10de-dfee-4085-94e1-74a46ac14c9f,
   \"RequestSentDate\":\"21/12/2021 07:09:36\",
   \"RequestExpiryDate\":\"25/12/2021 07:09:36\",
   \"HandledByUserGroupID\":\"230\",
   \"HandledByUserGroupName\":\"Admin Group\",
   \"HandledByUserID\":\"101\",
   \"HandledByUserName\":\"Chandramohan Ganorkar\",
   \"LapsedDays\":\"806\" }]"
 }],
 "SubreportDataSources": null
}
Field Data Type
ClientID Int 16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Text 255
ClientProspectID Text 255
TotalNoOfDCFSent Text 255
ClientProspectFirstName Text 510
ClientProspectLastName Text 510
ClientOnboardingID Text 150
OnboardingTypeID Int32
OnboardingTypeName Text 300
DataRequestID Guid
RequestSentDate DateTime
RequestExpiryDate DateTime
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
LapsedDays Int 32
Field Data Type
ClientID Int 16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Text 255
ClientProspectID Text 255
TotalNoOfDCFSent Text 255
ClientProspectFirstName Text 510
ClientProspectLastName Text 510
ClientOnboardingID Text 150
OnboardingTypeID Int32
OnboardingTypeName Text 300
DataRequestID Guid
RequestSentDate DateTime
RequestExpiryDate DateTime
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
LapsedDays Int 32
Field Data Type
ClientID Int 16
ClientName Text 150
BusinessUnitID Int 32
BusinessUnitName Text 255
ClientProspectID Text 255
TotalNoOfDCFSent Text 255
ClientProspectFirstName Text 510
ClientProspectLastName Text 510
ClientOnboardingID Text 150
OnboardingTypeID Int32
OnboardingTypeName Text 300
DataRequestID Guid
RequestSentDate DateTime
RequestExpiryDate DateTime
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
LapsedDays Int 32
Report - Client Onboarding Monitor And Alert
Action:
ClientOnboardingMonitorAndAlert
Method:
GET
URL: /api/v1/report/clientonboarding/ClientOnboardingMonitorAndAlert
Description: Fetch Client Onboarding Alerts 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 FilterType Int16 Report filter type 0 = Future Alerts, 1 = Historic Alerts (optional - value defaulted to 0 Future Alerts if not provided)
Params OnboardingTypeID Int16 Onboarding Type Identifier (optional - value defaulted to 0 View All if not provided)
Params MonitorAreaID Byte Monitor Area (0 = View All, 1 = Risk, 2 = Property, 3 = Identity Verification, 4 = Onboarded Date) (optional - value defaulted to 0 View All if not provided)
Params HandledByUserGroupID Int16 User Group Identifier of the user handling the prospect (optional - value defaulted to 0 View All if not provided)
Params HandledByUserID Int16 User Identifier (optional - value defaulted to 0 View All if not provided)
Params IsTestSystem Boolean Executing on TEST System? (True = Yes, False = No, Optional default is False)
Params FilterDate Date Filter Date (yyyy-mm-dd) (optional - value defaulted to -3 Months from Today's Date when FilterType = 0 or to +3 months from Today when FilterType = 1 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of Client Onboarding Summary Report
{
 "ReportDataSources": [{
  "Name": "ReportDataSet1",
  "Value": "[{
   \"FilterTypeID\":1,
   \"FilterTypeName\":\"Historic Alerts\",
   \"BusinessUnitName\":\"Default\",
   \"ClientProspectID\":300072,
   \"ClientProspectName\":\"Anthony White\",
   \"ClientOriginOnboardingID\":456789,
   \"ClientOriginOnboardingRiskAsessment\":\"Standard\",
   \"ClientOnboardingID\":456799,
   \"ClientProspectURL\":\"https://batch.riskscreen.com/onboarding/edit/456789?prospectid=300072\",
   \"AlertDueDate\":\"2018-06-19\",
   \"TriggerTypeID\":2,
   \"TriggerTypeName\":\"Property\",
   \"TriggerOptionID\":\"51234 - 23451\",
   \"TriggerOptionName\":\"PropertyGroup1 - DoB\",
   \"TriggerOptionValue\":\"2018-06-19\",
   \"TriggerActionID\":2,
   \"TriggerActionName\":\"Email Alerts And Start Onboarding Type\",
   \"TriggerOnboardingTypeID\":213,
   \"TriggerOnboardingTypeName\":\"Journey 1\",
   \"TriggerEmailTemplateID\":123,
   \"TriggerEmailTemplateName\":\"Template 1\",
   \"TriggerEmailRecepientIDs\":\"1,2\",
   \"TriggerEmailRecepientName\":\"Handler,Supervisor\",
   \"TriggerEmailRecepientValWithID\":\"[Handler - 103][Supervisor - 0]\",
   \"TriggerEmailRecepientValWithName\":\"[Handler - TestHandler][Supervisor - All]\"
   \"TriggerCopyDCF\":0
 }]
}
Field Data Type
FilterTypeID int 32
FilterTypeName Text 30
BusinessUnitName Text 255
ClientProspectID Int 32
ClientProspectName Text 255
ClientOriginOnboardingID Int 32
ClientOriginOnboardingRiskAsessmentText 20
ClientOnboardingID Int 32
ClientProspectURL Text 255
AlertDueDate Text 100
TriggerTypeID Byte
TriggerTypeName Text 20
TriggerOptionID Text 100
TriggerOptionName Text 100
TriggerOptionValue Text 100
TriggerActionID Byte
TriggerActionName Text 50
TriggerOnboardingTypeID Int 32
TriggerOnboardingTypeName Text 50
TriggerEmailTemplateID Int 32
TriggerEmailTemplateName Text 50
TriggerEmailRecepientIDs Text 100
TriggerEmailRecepientName Text 100
TriggerEmailRecepientValWithID Text 200
TriggerEmailRecepientValWithName Text 200
TriggerCopyDCF Byte