Action: | GET | |||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||
URL: | /api/v1/client/onboardingdatadocument/get | |||||||||||||||||||||||||||
Description: | Fetch a Client Onboarding Data Document 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 | DataDocumentID | Int32 | Data Document Id | |||||||||||||||||||||||||
Params | IncludeDocumentData | Boolean | Document Data needed to be included? (True = Yes, False = No) | |||||||||||||||||||||||||
Params | IncludeThumbnailData | Boolean | Thumbnail Data needed to be included? (True = Yes, False = No, Optional default is True) | |||||||||||||||||||||||||
Params | ReturnEncodedValues | Boolean | Return Base64 Encoded Values of Document Data and Thumbnail Data? (True = Yes, False = No, Optional default is False) | |||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||
Return Data: |
Json or XML of the Client Onboarding Data Document for the Client Onboarding Id associated with a Client Prospect ID { "BusinessUnitID": 10, "ClientProspectID": 450013, "ClientOnboardingID": "300013", "DataDocumentID": 6, "OnboardingDataDocumentTypeID": 1, "OnboardingDataDocumentTypeName": "", "DocumentData": "[Json = integer array] [Xml = byte array] of the document data" "DocumentThumbnailData": [Json = integer array] [Xml = byte array] of the document thumbnail data" "MediaType": "image\/jpeg", "DocumentDataEncoded": "Base64 encoded string of the document data" "DocumentThumbnailDataEncoded": "Base64 encoded string of the document thumbnail data" }] |
|
Action: | GET ALL | |||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||
URL: | /api/v1/client/onboardingdatadocument/getall | |||||||||||||||||||||||||||
Description: | Fetch all Client Onboarding Data Document 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 | IncludeDocumentData | Boolean | Document Data needed to be included? (True = Yes, False = No) | |||||||||||||||||||||||||
Params | IncludeThumbnailData | Boolean | Thumbnail Data needed to be included? (True = Yes, False = No, Optional default is True) | |||||||||||||||||||||||||
Params | ReturnEncodedValues | Boolean | Return Base64 Encoded Values of Document Data and Thumbnail Data? (True = Yes, False = No, Optional default is False) | |||||||||||||||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||
Return Data: |
Json or XML collection of one or many Client Onboarding Data Documents [{ "BusinessUnitID": 10, "ClientProspectID": 450013, "ClientOnboardingID": "300013", "DataDocumentID": 6, "OnboardingDataDocumentTypeID": 1, "OnboardingDataDocumentTypeName": "", "DocumentData": "[Json = integer array] [Xml = byte array] of the document data" "DocumentThumbnailData": [Json = integer array] [Xml = byte array] of the document thumbnail data" "MediaType": "image\/jpeg", "DocumentDataEncoded": "Base64 encoded string of the document data" "DocumentThumbnailDataEncoded": "Base64 encoded string of the document thumbnail data" }] |
|
Action: | ADD | |||||||||
Method: | POST | |||||||||
URL: | /api/v1/client/onboardingdatadocument/add | |||||||||
Description: | Add a Client Data Document 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 | DataDocumentID | Int32 | Data Document ID | |||||||
Body | OnboardingDataDocumentTypeID | Int32 | Onboarding Data Document Type ID | |||||||
Body | OnboardingDataDocumentTypeName | String | Onboarding Data Document Type Name | |||||||
Body | DocumentData | String | Base 64 string of the document | |||||||
Body | MediaType | String | Media Type of the uploaded document | |||||||
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 Document added. { "BusinessUnitID": 10, "ClientProspectID": 450013, "ClientOnboardingID": "300013", "DataDocumentID": 6, "OnboardingDataDocumentTypeID": 1, "OnboardingDataDocumentTypeName": "", "DocumentData": null, "DocumentThumbnailData": "byte array for the document" "MediaType": "image\/jpeg", } |
|
Action: | UPDATE | |||||||||
Method: | PUT | |||||||||
URL: | /api/v1/client/onboardingdatadocument/update | |||||||||
Description: | Update a Client Onboarding Data Document 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 | DataDocumentID | Int32 | Data Document ID | |||||||
Body | OnboardingDataDocumentTypeID | Int32 | Onboarding Data Document Type ID | |||||||
Body | OnboardingDataDocumentTypeName | String | Onboarding Data Document Type Name | |||||||
Body | DocumentData | String | Base 64 string of the document | |||||||
Body | MediaType | String | Media Type of the uploaded document | |||||||
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 Document updated. { "BusinessUnitID": 10, "ClientProspectID": 450013, "ClientOnboardingID": "300013", "DataDocumentID": 6, "OnboardingDataDocumentTypeID": 1, "OnboardingDataDocumentTypeName": "", "DocumentData": null, "DocumentThumbnailData": "null" "MediaType": "image\/jpeg", } |
|
Action: | DELETE | |||||||||
Method: | DELETE | |||||||||
URL: | /api/v1/client/onboardingdatadocument/delete | |||||||||
Description: | Delete a Client Data Document 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 Identifier | |||||||
Body | ClientOnboardingID | Int32 | Client Onboarding Id associated with the above Client Prospect ID | |||||||
Body | DataDocumentID | Int32 | Data Document Id | |||||||
Body | ReturnFormat | String | Json or Xml | |||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||
Return Data: |
Json or XML of the Client Onboarding Data Document deleted. { "BusinessUnitID": 10, "ClientProspectID": 450013, "ClientOnboardingID": "300013", "DataDocumentID": 6, "OnboardingDataDocumentTypeID": 1, "OnboardingDataDocumentTypeName": "", "DocumentData": null, "DocumentThumbnailData": "null" "MediaType": "image\/jpeg", } |
|