Tuesday, July 16, 2024

Client - Onboarding Document
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingdocument/get
Description: Fetch a Client Onboarding Document for a Submission
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 DocumentID Int32 Document Identifier
Params IncludeDocumentData Boolean Document Data to be included in the result? (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 Document
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450014,
 "ClientOnboardingID": "300014",
 "ClientOnboardingSubmissionID": "186594",
 "ClientOnboardingDocumentID": "616859",
 "ClientOnboardingDocumentUniqueNumber": "",
 "ClientOnboardingDocumentIssueDate": 2014-07-16,
 "ClientOnboardingDocumentIssueType": "",
 "ClientOnboardingDocumentIssuerCode": "",
 "ClientOnboardingDocumentIssueYear": 0,
 "ClientOnboardingDocumentExpiryDate": 2029-07-16,
 "ClientOnboardingDocumentAlerts": "",
 "DocumentStatus": 0,
 "OnboardingDocumentTypeID": 1
 "OnboardingDocumentTypeName": "passport"
 "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"
 "AuthenticationData": "Fail"
 "FacialMatch": "Pass"
 "FacialMatchScore": "100"
 "DocumentDataEncoded": "Base64 encoded string of the document data"
 "DocumentThumbnailDataEncoded": "Base64 encoded string of the document thumbnail data"
}]
Field Data Type
ClientProspectID Int32
ClientOnboardingID Int32
ClientOnboardingSubmissionID Int32
ClientOnboardingDocumentID Int32
ClientOnboardingDocumentUniqueNumber Text 20
ClientOnboardingDocumentIssueDate Date
ClientOnboardingDocumentIssueType Text200
ClientOnboardingDocumentIssuerCode Text 8
ClientOnboardingDocumentIssueYear Int 16
ClientOnboardingDocumentExpiryDate Date
ClientOnboardingDocumentAlerts Text 2000
DocumentStatus Byte
OnboardingDocumentTypeID Byte
OnboardingDocumentTypeName Text 300
DocumentData Byte[]/Int[]
DocumentThumbnailData Byte[]/Int[]
MediaType Text 50
AuthenticationData Text 10
FacialMatch Text 10
FacialMatchScore Byte
DocumentDataEncoded String
DocumentThumbnailDataEncoded String
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingdocument/getall
Description: Fetch all Client Onboarding Documents for a Submission
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 IncludeDocumentData Boolean Document Data to be included in result? (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 Client Onboarding Documents
[{
 "BusinessUnitID": 10,
 "ClientProspectID": 450014,
 "ClientOnboardingID": "300014",
 "ClientOnboardingSubmissionID": "186594",
 "ClientOnboardingDocumentID": "616859",
 "ClientOnboardingDocumentUniqueNumber": "",
 "ClientOnboardingDocumentIssueDate": 2014-07-16,
 "ClientOnboardingDocumentIssueType": "",
 "ClientOnboardingDocumentIssuerCode": "",
 "ClientOnboardingDocumentIssueYear": 0,
 "ClientOnboardingDocumentExpiryDate": 2029-07-16,
 "ClientOnboardingDocumentAlerts": "",
 "DocumentStatus": 0,
 "OnboardingDocumentTypeID": 1
 "OnboardingDocumentTypeName": "passport"
 "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"
 "AuthenticationData": "Fail"
 "FacialMatch": "Pass"
 "FacialMatchScore": "100"
 "DocumentDataEncoded": "Base64 encoded string of the document data"
 "DocumentThumbnailDataEncoded": "Base64 encoded string of the document thumbnail data"
}]
Field Data Type
ClientProspectID Int32
ClientOnboardingID Int32
ClientOnboardingSubmissionID Int32
ClientOnboardingDocumentID Int32
ClientOnboardingDocumentUniqueNumber Text 20
ClientOnboardingDocumentIssueDate Date
ClientOnboardingDocumentIssueType Text200
ClientOnboardingDocumentIssuerCode Text 8
ClientOnboardingDocumentIssueYear Int 16
ClientOnboardingDocumentExpiryDate Date
ClientOnboardingDocumentAlerts Text 2000
DocumentStatus Byte
OnboardingDocumentTypeID Byte
OnboardingDocumentTypeName Text 300
DocumentData Byte[]/Int[]
DocumentThumbnailData Byte[]/Int[]
MediaType Text 50
AuthenticationData Text 10
FacialMatch Text 10
FacialMatchScore Byte
DocumentDataEncoded String
DocumentThumbnailDataEncoded String
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingdocument/add
Description: Add Client Onboarding Document for a Submission
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 SubmissionID Int32 Onboarding Document Type Id
Body DocumentID Int32 Document Identifier
Body DocumentUniqueNumber Text 20 Document Unique Number of the uploaded document
Body DocumentIssueDate Date Issue date of the document (yyyy-mm-dd or blank)
Body DocumentIssueType Text 200 Issue Type of the document
Body DocumentIssuerCode Text 8 Document Issuer Code
Body DocumentIssueYear Int16 Year of document issue (YYYY or blank)
Body DocumentExpiryDate Date Document expiry date (yyyy-mm-dd or blank)
Body DocumentAlerts Text 2000 Alerts/Notes for the document
Body DocumentStatus Byte Status 0 = Inactive, 1 = Active
Body DocumentTypeID Byte Document Type Identifier
Body OnboardingDocumentTypeName Text 300 Document Type Identifier Name
Body DocumentData Byte [ ] Base 64 string of the document
Body MediaType Text 50 Document Media i.e PDF, Image etc
Body AuthenticationData Text 10 Data Authentication (Pass/Fail)
Body FacialMatch Text 10 Facial Match Status (Pass/Fail)
Body FacialMatchScore Byte Facial Match Score
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Document added.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450014,
 "ClientOnboardingID": "300014",
 "ClientOnboardingSubmissionID": "186594",
 "ClientOnboardingDocumentID": "616859",
 "ClientOnboardingDocumentUniqueNumber": "",
 "ClientOnboardingDocumentIssueDate": 2014-07-16,
 "ClientOnboardingDocumentIssueType": "",
 "ClientOnboardingDocumentIssuerCode": "",
 "ClientOnboardingDocumentIssueYear": 0,
 "ClientOnboardingDocumentExpiryDate": 2029-07-16,
 "ClientOnboardingDocumentAlerts": "",
 "DocumentStatus": 0,
 "OnboardingDocumentTypeID": 1
 "OnboardingDocumentTypeName": "passport"
 "DocumentData": null
 "DocumentThumbnailData": "byte array for the document"
 "MediaType": "image/jpeg"
 "AuthenticationData": "Fail"
 "FacialMatch": "Pass"
 "FacialMatchScore": "100"
}
Field Data Type
ClientOnboardingDocument Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingdocument/update
Description: Update a Client Onboarding Document for a Submission
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 Onboarding Document Type Id
Body DocumentID Int32 Document Identifier
Body DocumentUniqueNumber Text 20 Document Unique Number of the uploaded document
Body DocumentIssueDate Date Issue date of the document (yyyy-mm-dd or blank)
Body DocumentIssueType Text 200 Issue Type of the document
Body DocumentIssuerCode Text 8 Document Issuer Code
Body DocumentIssueYear Int16 Year of document issue (YYYY or blank)
Body DocumentExpiryDate Date Document expiry date (yyyy-mm-dd or blank)
Body DocumentAlerts Text 2000 Alerts/Notes for the document
Body DocumentStatus Byte Status 0 = Inactive, 1 = Active
Body DocumentTypeID Byte Document Type Identifier
Body OnboardingDocumentTypeName Text 300 Document Type Identifier Name
Body DocumentData Byte [ ] Base 64 string of the document
Body MediaType Text 50 Document Media i.e PDF, Image etc
Body AuthenticationData Text 10 Data Authentication (Pass/Fail)
Body FacialMatch Text 10 Facial Match Status (Pass/Fail)
Body FacialMatchScore Byte Facial Match Score
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Document updated.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450014,
 "ClientOnboardingID": "300014",
 "ClientOnboardingSubmissionID": "186594",
 "ClientOnboardingDocumentID": "616859",
 "ClientOnboardingDocumentUniqueNumber": "",
 "ClientOnboardingDocumentIssueDate": 2014-07-16,
 "ClientOnboardingDocumentIssueType": "",
 "ClientOnboardingDocumentIssuerCode": "",
 "ClientOnboardingDocumentIssueYear": 0,
 "ClientOnboardingDocumentExpiryDate": 2029-07-16,
 "ClientOnboardingDocumentAlerts": "",
 "DocumentStatus": 0,
 "OnboardingDocumentTypeID": 1
 "OnboardingDocumentTypeName": "passport"
 "DocumentData": null
 "DocumentThumbnailData": "byte array for the document"
 "MediaType": "image/jpeg"
 "AuthenticationData": "Fail"
 "FacialMatch": "Pass"
 "FacialMatchScore": "100"
}
Field Data Type
ClientOnboardingDocument Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingdocument/delete
Description: Delete a Client Document for a Submission
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 Onboarding Document Type Identifier
Body DocumentID Int32 Document 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 Document deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectID": 450014,
 "ClientOnboardingID": "300014",
 "ClientOnboardingSubmissionID": "186594",
 "ClientOnboardingDocumentID": "616859",
 "ClientOnboardingDocumentUniqueNumber": "",
 "ClientOnboardingDocumentIssueDate": 2014-07-16,
 "ClientOnboardingDocumentIssueType": "",
 "ClientOnboardingDocumentIssuerCode": "",
 "ClientOnboardingDocumentIssueYear": 0,
 "ClientOnboardingDocumentExpiryDate": 2029-07-16,
 "ClientOnboardingDocumentAlerts": "",
 "DocumentStatus": 0,
 "OnboardingDocumentTypeID": 1
 "OnboardingDocumentTypeName": "passport"
 "DocumentData": null
 "DocumentThumbnailData": "byte array for the document"
 "MediaType": "image/jpeg"
 "AuthenticationData": "Fail"
 "FacialMatch": "Pass"
 "FacialMatchScore": "100"
} }
Field Data Type
ClientOnboardingDocument Collection
 Same as Get Method results above.