Tuesday, July 16, 2024

Client - Onboarding Data Request
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingdatarequest/get
Description: Fetch a Client Onboarding Data Request for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectID Int32 Client Prospect Identifier
Params ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Params DataRequestID String(GUID) Data Request Id
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request for the Client Onboarding Id associated with a Client Prospect ID
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "00d99b73-6eb8-4a19-8a6c-fc22a6c67459",
 "Message": "Please complete the data submission",
 "DataRequestedOn": "2024-07-16 11:01:02",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA",
 "ProspectMiddleName": "",
 "ProspectLastName": "AL-ASSAD",
 "ProspectEmail": "test@kyc360.com",
 "EmailTemplateID": 999
}]
Field Data Type
BusinessUnitID Int 32
ClientProspectID Int 32
ClientOnboardingID Int 32
DataRequestID Text 40
Message Text 3000
DataRequestedOn Date
DataRequestOpenedDate Date
DataRequestSubmittedDate Date
DataRequestStatus Byte
ExpiryDate Date
ProspectFirstName Text 255
ProspectMiddleName Text 255
ProspectLastName Text 255
ProspectEmail Text 250
EmailTemplateID Int 32
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingdatarequest/getall
Description: Fetch all Client Onboarding Data Request for a Client Onboarding ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectID Int32 Client Prospect Identifier
Params ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of one or many Client Onboarding Data Requests
[{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "00d99b73-6eb8-4a19-8a6c-fc22a6c67459",
 "Message": "Please complete the data submission",
 "DataRequestedOn": "2024-07-16 00:00:00",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA",
 "ProspectMiddleName": "",
 "ProspectLastName": "AL-ASSAD",
 "ProspectEmail": "test@kyc360.com",
 "EmailTemplateID": 999
}]
Field Data Type
BusinessUnitID Int 32
ClientProspectID Int 32
ClientOnboardingID Int 32
DataRequestID Text 40
Message Text
DataRequestedOn Date
DataRequestOpenedDate Date
DataRequestSubmittedDate Date
DataRequestStatus Byte
ExpiryDate Date
ProspectFirstName Text 255
ProspectMiddleName Text 255
ProspectLastName Text 255
ProspectEmail Text 250
EmailTemplateID Int 32
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingdatarequest/add
Description: Add a Client Data Request for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body Message Text Message to be sent as part of the data request (optional if WLWP enabled and EmailTemplateID is provided)
Body ExpiryDate Date Expiry date of the data request (yyyy-mm-dd or blank)
Body ActionUserID Int16 Identifier of the User performing action.
Body EmailTemplateID Int32 If WLWP enabled, Email Template Identifier (optional - message will be added in data request if not provided)
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request added.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "6e11d6d7-8340-4f78-b5b3-1fa99aed842b",
 "Message": "Please submit the details requested",
 "DataRequestedOn": "2024-07-16 00:00:00",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA",
 "ProspectMiddleName": "",
 "ProspectLastName": "AL-ASSAD",
 "ProspectEmail": "test@kyc360.com",
 "EmailTemplateID": 999
}
Field Data Type
ClientOnboardingDataRequest Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingdatarequest/update
Description: Update a Client Onboarding Data Request for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body DataRequestID Text 40 Data Request ID
Body Message Text Message to be sent as part of the data request (optional if WLWP enabled and EmailTemplateID is provided)
Body DataRequestedOn Date Data Requested date (yyyy-mm-dd or blank)
Body DataRequestOpenedDate Date Data Request opened date (yyyy-mm-dd or blank)
Body DataRequestSubmittedDate Date Data Request submitted date (yyyy-mm-dd or blank)
Body DataRequestStatus Byte Data Request Status (optional)
Body ExpiryDate Date Expiry date of the data request (yyyy-mm-dd or blank)
Body ActionUserID Int16 Identifier of the User performing action.
Body EmailTemplateID Int32 If WLWP enabled, Email Template Identifier (optional - message will be updated in data request if not provided)
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request updated.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "6e11d6d7-8340-4f78-b5b3-1fa99aed842b",
 "Message": "Please submit the details requested",
 "DataRequestedOn": "2024-07-16 00:00:00",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA",
 "ProspectMiddleName": "",
 "ProspectLastName": "AL-ASSAD",
 "ProspectEmail": "test@kyc360.com",
 "EmailTemplateID": 999
}
Field Data Type
ClientOnboardingDataRequest Collection
 Same as Get Method results above.
Action:
SEND
Method:
POST
URL: /api/v1/client/onboardingdatarequest/send
Description: Send a data collection request for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body DataRequestID Text 40 Data Request ID
Body SendEmailLinkTo Text 150 Email to be sent to (Optional - the email will be sent to the prospect if not provided)
Body EmailTemplateID Int32 Email Template Identifier (optional - default message (configured in data request) will be sent if not provided)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request sent.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "6e11d6d7-8340-4f78-b5b3-1fa99aed842b",
 "Message": "Please submit the details requested",
 "DataRequestedOn": "2024-07-16 00:00:00",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA",
 "ProspectMiddleName": "",
 "ProspectLastName": "AL-ASSAD",
 "ProspectEmail": "test@kyc360.com",
 "EmailTemplateID": 999
}
Field Data Type
ClientOnboardingDataRequest Collection
 Same as Get Method results above.
Action:
GENERATEDATACOLLECTIONLINK
Method:
POST
URL: /api/v1/client/onboardingdatarequest/GenerateDataCollectionLink
Description: Get a data request link for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body DataRequestID Text 40 Data Request ID
Body ActionUserID Int16 Identifier of the User performing action.
Body UpdateDataRequestedOn Bool Data Request link update sent on flag
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request Link.
{
 "DataRequestLink": "https://xxxx.batch.riskscreen.com/onboardingdataexternal/index/XXFFF",
}
Field Data Type
ClientOnboardingDataLinkRequest Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingdatarequest/delete
Description: Delete a Client Data Request for a Client Onboarding ID of a Client Prospect ID
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectID Int32 Client Prospect Id
Body ClientOnboardingID Int32 Client Onboarding Id associated with the above Client Prospect ID
Body DataRequestID Text 40 Data Request ID
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Data Request deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450001,
 "ClientOnboardingID": "300001",
 "DataRequestID": "6e11d6d7-8340-4f78-b5b3-1fa99aed842b",
 "Message": "Please submit the details requested",
 "DataRequestedOn": "2024-07-16 00:00:00",
 "DataRequestOpenedDate": "2024-07-16 13:05:03",
 "DataRequestSubmittedDate": "2024-07-16 14:07:02",
 "DataRequestStatus": 1,
 "ExpiryDate": 2024-07-17 00:00:00,
 "ProspectFirstName": "ASMA"
 "ProspectMiddleName": ""
 "ProspectLastName": "AL-ASSAD"
 "ProspectEmail": "test@kyc360.com"
} }
Field Data Type
ClientOnboardingDataRequest Collection
 Same as Get Method results above.