Action: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/client/onboardingsubmission/get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch a Client Onboarding Submission for an Onboarding | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | SubmissionID | Int32 | Submission Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Client Onboarding Submission { "BusinessUnitID": 10, "ClientProspectID": 450001, "ClientOnboardingID": 300001, "SubmissionID": 174864, "Phone": "7829123800", "FirstName": "", "LastName": "", "MaidenName": "", "Email": "", "GenderID": 1, "GenderName": "Male", "DateOfBirth": "1972-09-17 00:00:00", "CountryOfBirthID": 0, "CountryOfBirth": "Jersey", "AddressLine1": "St. Helier, Jersey", "AddressLine2": "", "City": "St Helier", "County": "St Helier", "CountryID": 0, "CountryName": "Jersey", "PostalCode": "Je3 8QW", "PassportExpiryDate": null, "IDExpiryDate": null, "OSType": "13.5.1", "HardwareType": "iPhone XS Max", "FreeMemory": "49 MB", "AvailableStorage": "183.19 GB", "ApprovalNotes": "test approval", "SubmissionSource": 1, "SubmissionStatus": 0, "AddressVerificationResult": 1 "IdDetectResult": 1, "EVerificationDetails": "Overall Result: Full Match for 1+1 verification", "EVerificationCustomField": "VAT ID:21312313" } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/client/onboardingsubmission/getall | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Client Onboarding Submissions for an Onboarding | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML collection of Client Onboarding Submissions [{ "BusinessUnitID": 10, "ClientProspectID": 450001, "ClientOnboardingID": 300001, "SubmissionID": 174864, "Phone": "7829123800", "FirstName": "", "LastName": "", "MaidenName": "", "Email": "", "GenderID": 1, "GenderName": "Male", "DateOfBirth": "1972-09-17 00:00:00", "CountryOfBirthID": 0, "CountryOfBirth": "Jersey", "AddressLine1": "St. Helier, Jersey", "AddressLine2": "", "City": "St Helier", "County": "St Helier", "CountryID": 0, "CountryName": "Jersey", "PostalCode": "Je3 8QW", "PassportExpiryDate": null, "IDExpiryDate": null, "OSType": "13.5.1", "HardwareType": "iPhone XS Max", "FreeMemory": "49 MB", "AvailableStorage": "183.19 GB", "ApprovalNotes": "test approval", "SubmissionSource": 1, "SubmissionStatus": 0, "AddressVerificationResult": 1 "IdDetectResult": 1 "EVerificationDetails": "Overall Result: Full Match for 1+1 verification", "EVerificationCustomField": "VAT ID:21312313" }] |
|
Action: | ADD | |||||||||
Method: | POST | |||||||||
URL: | /api/v1/client/onboardingsubmission/add | |||||||||
Description: | Add a Client Onboarding Submission for an Onboarding | |||||||||
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 Identifier | |||||||
Body | ClientOnboardingID | Int32 | Client Onboarding Identifier | |||||||
Body | SubmissionID | Int32 | Submission Identifier | |||||||
Body | Phone | Text 20 | Phone Number | |||||||
Body | FirstName | Text 510 | First Name | |||||||
Body | LastName | Text 510 | Last Name | |||||||
Body | MaidenName | Text 510 | Maiden Name | |||||||
Body | Text 500 | Email Address | ||||||||
Body | GenderID | Byte | Gender Id | |||||||
Body | GenderName | Text 300 | Gender Name (Leave it blank since currently not being used) | |||||||
Body | DateOfBirth | Date | Date of Birth (yyyy-mm-dd or blank) | |||||||
Body | CountryOfBirthID | Int32 | Country of birth Id or blank | |||||||
Body | CountryOfBirth | Text 200 | Country of birth name | |||||||
Body | AddressLine1 | Text 100 | Address Line 1 | |||||||
Body | AddressLine2 | Text 100 | Address Line 2 | |||||||
Body | City | Text 100 | City name | |||||||
Body | County | Text 100 | County name | |||||||
Body | CountryID | Int16 | Country Id or blank | |||||||
Body | CountryName | Text 200 | Country name | |||||||
Body | PostalCode | Text 20 | Postal Code | |||||||
Body | PassportExpiryDate | Date | Passport expiry date (yyyy-mm-dd or blank) | |||||||
Body | IDExpiryDate | Date | Identity proof document expiry date (yyyy-mm-dd or blank) | |||||||
Body | OSType | Text 100 | Operating System Type of the device used for submission | |||||||
Body | HardwareType | Text 100 | Hardware type/Model Name of the device used for submission | |||||||
Body | FreeMemory | Text 100 | Free memory available on the device | |||||||
Body | AvailableStorage | Text 100 | Available storage on the device | |||||||
Body | ApprovalNotes | Text 3000 | Approval notes on the submission | |||||||
Body | SubmissionSource | Byte | Submission Source (1 = IDPal, 2 = Manual) | |||||||
Body | SubmissionStatus | Byte | Submission Status (0 = NotReceived , 1 = Received, 2 = ReceivedWithError, 3 = ReportFlaggedByUser, 4 = ClientDueDigilanceGenerated, 5 = ClientDueDigilanceGeneratedWithError) | |||||||
Body | AddressVerificationResult | Byte | Address Verification result (Pass, Fail, Error) | |||||||
Body | IdDetectResult | Byte | ID Detect result (Pass, Fail, Error) | |||||||
Body | EVerificationDetails | Text 8000 | E-Verification Details | |||||||
Body | EVerificationCustomField | Text 3000 | E-Verification Custom Field | |||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||
Body | ReturnFormat | String | Json or Xml | |||||||
Return Data: |
Json or XML of the Client Onboarding Submission added. { "BusinessUnitID": 10, "ClientProspectID": 450001, "ClientOnboardingID": 300001, "SubmissionID": 174865, "Phone": "0742156666", "FirstName": "Chandramohan", "LastName": "Ganorkar", "MaidenName": "", "Email": "chandramohanganorkar@kycglobal.com", "GenderID": 1, "GenderName": "Male", "DateOfBirth": "1988-05-15 00:00:00", "CountryOfBirthID": 0, "CountryOfBirth": "India", "AddressLine1": "Kensington Place", "AddressLine2": "", "City": "St. Helier", "County": "St. Helier", "CountryID": 0, "CountryName": "Jersey", "PostalCode": "JE2 3PX", "PassportExpiryDate": "1923-05-15 00:00:00", "IDExpiryDate": "1922-05-15 00:00:00", "OSType": "iOS14", "HardwareType": "iPhone 6s", "FreeMemory": "2GB", "AvailableStorage": "64GB", "ApprovalNotes": "Test Approval", "SubmissionSource": 1, "SubmissionStatus": 1, "AddressVerificationResult": 1 "IdDetectResult": 1 "EVerificationDetails": "Overall Result: Full Match for 1+1 verification", "EVerificationCustomField": "VAT ID:21312313" } |
|
Action: | UPDATE | |||||||||
Method: | PUT | |||||||||
URL: | /api/v1/client/onboardingsubmission/update | |||||||||
Description: | Update a Client Onboarding Submission for an Onboarding | |||||||||
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 Identifier | |||||||
Body | ClientOnboardingID | Int32 | Client Onboarding Identifier | |||||||
Body | SubmissionID | Int32 | Submission Identifier | |||||||
Body | Phone | Text 20 | Phone Number | |||||||
Body | FirstName | Text 510 | First Name | |||||||
Body | LastName | Text 510 | Last Name | |||||||
Body | MaidenName | Text 510 | Maiden Name | |||||||
Body | Text 500 | Email Address | ||||||||
Body | GenderID | Byte | Gender Id | |||||||
Body | GenderName | Text 300 | Gender Name (Leave it blank since currently not being used) | |||||||
Body | DateOfBirth | Date | Date of Birth (yyyy-mm-dd or blank) | |||||||
Body | CountryOfBirthID | Int32 | Country of birth Id or blank | |||||||
Body | CountryOfBirth | Text 200 | Country of birth name | |||||||
Body | AddressLine1 | Text 100 | Address Line 1 | |||||||
Body | AddressLine2 | Text 100 | Address Line 2 | |||||||
Body | City | Text 100 | City name | |||||||
Body | County | Text 100 | County name | |||||||
Body | CountryID | Int16 | Country Id or blank | |||||||
Body | CountryName | Text 200 | Country name | |||||||
Body | PostalCode | Text 20 | Postal Code | |||||||
Body | PassportExpiryDate | Date | Passport expiry date (yyyy-mm-dd or blank) | |||||||
Body | IDExpiryDate | Date | Identity proof document expiry date (yyyy-mm-dd or blank) | |||||||
Body | OSType | Text 100 | Operating System Type of the device used for submission | |||||||
Body | HardwareType | Text 100 | Hardware type/Model Name of the device used for submission | |||||||
Body | FreeMemory | Text 100 | Free memory available on the device | |||||||
Body | AvailableStorage | Text 100 | Available storage on the device | |||||||
Body | ApprovalNotes | Text 3000 | Approval notes on the submission | |||||||
Body | SubmissionSource | Byte | Submission Source (1 = IDPal, 2 = Manual) | |||||||
Body | SubmissionStatus | Byte | Submission Status (0 = NotReceived , 1 = Received, 2 = ReceivedWithError, 3 = ReportFlaggedByUser, 4 = ClientDueDigilanceGenerated, 5 = ClientDueDigilanceGeneratedWithError) | |||||||
Body | AddressVerificationResult | Byte | Address Verification result (Pass, Fail, Error) | |||||||
Body | IdDetectResult | Byte | ID Detect result (Pass, Fail, Error) | |||||||
Body | EVerificationDetails | Text 8000 | E-Verification Details | |||||||
Body | EVerificationCustomField | Text 3000 | E-Verification Custom Field | |||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||
Body | ReturnFormat | String | Json or Xml | |||||||
Return Data: |
Json or XML of the Client Onboarding Submission updated. { "BusinessUnitID": 10, "ClientProspectID": 450001, "ClientOnboardingID": 300001, "SubmissionID": 174865, "Phone": "0742156666", "FirstName": "Chandramohan", "LastName": "Ganorkar", "MaidenName": "", "Email": "chandramohanganorkar@kycglobal.com", "GenderID": 1, "GenderName": "Male", "DateOfBirth": "1988-05-15 00:00:00", "CountryOfBirthID": 0, "CountryOfBirth": "India", "AddressLine1": "Kensington Place", "AddressLine2": "", "City": "St. Helier", "County": "St. Helier", "CountryID": 0, "CountryName": "Jersey", "PostalCode": "JE2 3PX", "PassportExpiryDate": "1923-05-15 00:00:00", "IDExpiryDate": "1922-05-15 00:00:00", "OSType": "iOS14", "HardwareType": "iPhone 6s", "FreeMemory": "2GB", "AvailableStorage": "64GB", "ApprovalNotes": "Test Approval", "SubmissionSource": 1, "SubmissionStatus": 1, "AddressVerificationResult": 1 "IdDetectResult": 1 "EVerificationDetails": "Overall Result: Full Match for 1+1 verification", "EVerificationCustomField": "VAT ID:21312313" } |
|
Action: | DELETE | |||||||||
Method: | DELETE | |||||||||
URL: | /api/v1/client/onboardingsubmission/delete | |||||||||
Description: | Delete a Client Submission for an Onboarding | |||||||||
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 Identifier | |||||||
Body | ClientOnboardingID | Int32 | Client Onboarding Identifier | |||||||
Body | SubmissionID | Int32 | Submission Identifier | |||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||
Body | ReturnFormat | String | Json or Xml | |||||||
Return Data: |
Json or XML of the Client Onboarding Submission deleted. { "BusinessUnitID": 10, "ClientProspectID": 450001, "ClientOnboardingID": 300001, "SubmissionID": 174865, "Phone": "0742156666", "FirstName": "Chandramohan", "LastName": "Ganorkar", "MaidenName": "", "Email": "chandramohanganorkar@kycglobal.com", "GenderID": 1, "GenderName": "Male", "DateOfBirth": "1988-05-15 00:00:00", "CountryOfBirthID": 0, "CountryOfBirth": "India", "AddressLine1": "Kensington Place", "AddressLine2": "", "City": "St. Helier", "County": "St. Helier", "CountryID": 0, "CountryName": "Jersey", "PostalCode": "JE2 3PX", "PassportExpiryDate": "1923-05-15 00:00:00", "IDExpiryDate": "1922-05-15 00:00:00", "OSType": "iOS14", "HardwareType": "iPhone 6s", "FreeMemory": "2GB", "AvailableStorage": "64GB", "ApprovalNotes": "Test Approval", "SubmissionSource": 1, "SubmissionStatus": 1, "AddressVerificationResult": 1 "IdDetectResult": 1 "EVerificationDetails": "Overall Result: Full Match for 1+1 verification", "EVerificationCustomField": "VAT ID:21312313" } } |
|