Document Integration Services

Name	Description	Introduced In
submitApplicationEvidence	This experience API submits application evidence to Document MS.	2023.04
addApplicationEvidence	This experience API adds evidence to existing application evidence.	2023.04
evidenceBankValidation	This experience API is used to validate evidence in document MS.	2023.04
updateEvidenceOwner	This experience API is used to update evidence owner in Document MS.	2023.04

submitApplicationEvidence

Description:

This experience API submit application evidence to Document MS.

Method:

submitApplicationEvidence

URL:

{baseURL}/services/DocumentIntegrationServices/submitApplicationEvidence

Payload

Body Request:

{
    "fileContent": "VGVzdCBEb2N1bWVudA==",
    "evidenceType": "Passport",
    "ownerSystemId": "corporate-los",
    "fulfilmentId": "AF1110338950",
    "forRequirements": "ProofOfAddress",
    "fileName": "demo.txt",
    "documentGroup": "journey-corporate-los-ABCDE",
    "authorization": "eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJJUklTIiwic3ViIjoiOTg3NjU0MzIxIiwicm9sZUlkIjoiRG9jdW1lbnRPd25lciIsImlzcyI6IkZhYnJpYyIsImRieFVzZXJJZCI6IjAwMDEiLCJleHAiOjMxNjQ4NDY5NjMsImlhdCI6MTU4ODA0Njk2MywidXNlcklkIjoiVDI0IiwiX2lzc21ldGEiOiJodHRwczovL2RieGxlbmRpbmdxYS5rb255Y2xvdWQuY29tL3NlcnZpY2VzL1QyNElTRXh0cmEvZ2V0cHVibGlja2V5IiwianRpIjoiNzk2ZDY1MjctZjZhMC00OGJiLWJiNDUtYWZkMjM3YWU1MGZmIn0.qOWCmNsX40lfLu2aDZvV59-R_hpYQHY0wNGbxARW9Pog3Z7-Y8b1bllkf_Mt38u93C8Pd1rJR1P8_Is3S8g_qYz9yaa3xyCY0_axd7Useow7_CbDbA4hNU_-JsVUt1KWqdOnDIne1-LOGmzQooN3oLEWNV85hkheHvy8iPlT7BmrJ9dJXHowZ5lyY4BPIchRRjx0mlofbv7VipzaxHyqVnLOgohxjNZwb33_T_eeEPH6eOrRT-mmMupWs8Z_gZV7B2Kbzu55OjvmtQua8sdb1jUtQzQXqt6-pnE2IobBUKU9rM6R-1lvoJUh70NRBKdYfC3DobfSfGQRabhuUuUfiw"
}

Response:

{
    "evidenceList": [
        {
            "appEvidenceId": "AE1110338988",
            "requirementKey": "ProofOfAddress",
            "evidenceType": "Passport",
            "evidenceId": "EV1110338987",
            "documentId": "4857978d-8d24-4398-b9e0-0359fbd8b384",
            "status": "submitted"
        }
    ],
    "opstatus": 0,
    "message": "Evidence Submitted successfully",
    "httpStatusCode": 200
}

Error Code(s):

Error Code: 500
Error Message: Denotes Internal Server Error
Error Code: 404
Error Message: Denotes Invalid Input Error

Enterprise Provider:

Document MS

Enterprise API:

/api/v1.0.0/evidences/fulfilments/{fulfilmentId}/appevidences

Transact API:

Field Mapping

Enterprise API Field	Transact API Field	MS API Field
fileContent evidenceType fulfilmentId forRequirements fileName documentGroup authorization ownerSystemId	NA	fileContent evidenceDetail.evidenceType fulfilmentId evidenceDetail.forRequirements fileName documentGroup authorization ownerSystemId

addApplicationEvidence

Description:

This experience API adds evidence to existing application evidence.

Method:

addApplicationEvidence

URL:

{baseURL}/services/DocumentIntegrationServices/addApplicationEvidence

Payload

Body Request:

{
    "fileContent": "VGVzdCBEb2N1bWVudA==",
    "appEvidenceId": "AE1110338988",
    "fileName": "demo2.txt",
    "ownerSystemId": "corporate-los",
    "documentGroup": "journey-corporate-los-ABCDE",
    "authorization": "eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJJUklTIiwic3ViIjoiOTg3NjU0MzIxIiwicm9sZUlkIjoiRG9jdW1lbnRPd25lciIsImlzcyI6IkZhYnJpYyIsImRieFVzZXJJZCI6IjAwMDEiLCJleHAiOjMxNjQ4NDY5NjMsImlhdCI6MTU4ODA0Njk2MywidXNlcklkIjoiVDI0IiwiX2lzc21ldGEiOiJodHRwczovL2RieGxlbmRpbmdxYS5rb255Y2xvdWQuY29tL3NlcnZpY2VzL1QyNElTRXh0cmEvZ2V0cHVibGlja2V5IiwianRpIjoiNzk2ZDY1MjctZjZhMC00OGJiLWJiNDUtYWZkMjM3YWU1MGZmIn0.qOWCmNsX40lfLu2aDZvV59-R_hpYQHY0wNGbxARW9Pog3Z7-Y8b1bllkf_Mt38u93C8Pd1rJR1P8_Is3S8g_qYz9yaa3xyCY0_axd7Useow7_CbDbA4hNU_-JsVUt1KWqdOnDIne1-LOGmzQooN3oLEWNV85hkheHvy8iPlT7BmrJ9dJXHowZ5lyY4BPIchRRjx0mlofbv7VipzaxHyqVnLOgohxjNZwb33_T_eeEPH6eOrRT-mmMupWs8Z_gZV7B2Kbzu55OjvmtQua8sdb1jUtQzQXqt6-pnE2IobBUKU9rM6R-1lvoJUh70NRBKdYfC3DobfSfGQRabhuUuUfiw"
}

Response:

{
    "appEvidenceId": "AE1110338988",
    "requirementKey": "ProofOfAddress",
    "evidenceType": "Passport",
    "evidenceId": "EV1110338987",
    "opstatus": 0,
    "documentId": "693164e1-0c72-4fb9-b22d-95143494cc2c",
    "message": "Document uploaded successfully",
    "status": "submitted",
    "httpStatusCode": 200
}

Error Code(s):

Error Code: 500
Error Message: Denotes Internal Server Error
Error Code: 404
Error Message: Denotes Invalid Input Error

Enterprise Provider:

Document MS

Enterprise API:

/api/v1.0.0/evidences/appevidences/{appEvidenceId}

Transact API:

Field Mapping

Enterprise API Field	Transact API Field	MS API Field
fileContent appEvidenceId fileName documentGroup authorization ownerSystemId	NA	fileContent evidenceDetail.evidenceType fulfilmentId evidenceDetail.forRequirements fileName documentGroup authorization ownerSystemId

evidenceBankValidation

Description:

This experience API is used to validate evidence in document MS.

Method:

evidenceBankValidation

URL:

{baseURL}/services/DocumentIntegrationServices/evidenceBankValidation

Payload

Body Request:

{
    "appEvidenceId": "EV1110338987",
    "evidenceType": "Passport",
    "expiryDate": "2030-01-01",
    "validateResult": "accepted",
    "isReusable": true,
    "comments": "approved",
    "ownerSystemId": "corporate-los",
    "documentGroup": "journey-corporate-los-ABCDE",
    "authorization": "eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJJUklTIiwic3ViIjoiOTg3NjU0MzIxIiwicm9sZUlkIjoiRG9jdW1lbnRPd25lciIsImlzcyI6IkZhYnJpYyIsImRieFVzZXJJZCI6IjAwMDEiLCJleHAiOjMxNjQ4NDY5NjMsImlhdCI6MTU4ODA0Njk2MywidXNlcklkIjoiVDI0IiwiX2lzc21ldGEiOiJodHRwczovL2RieGxlbmRpbmdxYS5rb255Y2xvdWQuY29tL3NlcnZpY2VzL1QyNElTRXh0cmEvZ2V0cHVibGlja2V5IiwianRpIjoiNzk2ZDY1MjctZjZhMC00OGJiLWJiNDUtYWZkMjM3YWU1MGZmIn0.qOWCmNsX40lfLu2aDZvV59-R_hpYQHY0wNGbxARW9Pog3Z7-Y8b1bllkf_Mt38u93C8Pd1rJR1P8_Is3S8g_qYz9yaa3xyCY0_axd7Useow7_CbDbA4hNU_-JsVUt1KWqdOnDIne1-LOGmzQooN3oLEWNV85hkheHvy8iPlT7BmrJ9dJXHowZ5lyY4BPIchRRjx0mlofbv7VipzaxHyqVnLOgohxjNZwb33_T_eeEPH6eOrRT-mmMupWs8Z_gZV7B2Kbzu55OjvmtQua8sdb1jUtQzQXqt6-pnE2IobBUKU9rM6R-1lvoJUh70NRBKdYfC3DobfSfGQRabhuUuUfiw"
}

Response:

{
    "isValid": true,
    "isReusable": true,
    "opstatus": 0,
    "applicationEvidences": [
        {
            "appEvidenceId": "AE1110338988",
            "appFulfilmentId": "AF1110338950",
            "requirementKey": "ProofOfAddress",
            "evidenceId": "EV1110338987",
            "status": "accepted"
        }
    ],
    "message": "Evidence Validated successfully",
    "httpStatusCode": 200
}

Error Code(s):

Error Code: 500
Error Message: Denotes Internal Server Error
Error Code: 404
Error Message: Denotes Invalid Input Error

Enterprise Provider:

Document MS

Enterprise API:

/api/v1.0.0/evidences/{appEvidenceId}

Transact API:

Field Mapping

Enterprise API Field	Transact API Field	MS API Field
appEvidenceId evidenceType expiryDate validateResult isReusable comments ownerSystemId documentGroup authorization	NA	appEvidenceId evidenceType expiryDate validateResult isReusable comments ownerSystemId documentGroup authorization

updateEvidenceOwner

Description:

This experience API is used to update evidence owner in Document MS.

Method:

updateEvidenceOwner

URL:

{baseURL}/services/DocumentIntegrationServices/updateEvidenceOwner

Payload

Body Request:

{
    "oldPartyId": "ENVF123456789",
    "newPartyId": "202110111",
    "ownerSystemId": "corporate-los",
    "documentGroup": "journey-corporate-los-ABCDE",
    "authorization": "eyJraWQiOiJLQTAxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiJJUklTIiwic3ViIjoiOTg3NjU0MzIxIiwicm9sZUlkIjoiRG9jdW1lbnRPd25lciIsImlzcyI6IkZhYnJpYyIsImRieFVzZXJJZCI6IjAwMDEiLCJleHAiOjMxNjQ4NDY5NjMsImlhdCI6MTU4ODA0Njk2MywidXNlcklkIjoiVDI0IiwiX2lzc21ldGEiOiJodHRwczovL2RieGxlbmRpbmdxYS5rb255Y2xvdWQuY29tL3NlcnZpY2VzL1QyNElTRXh0cmEvZ2V0cHVibGlja2V5IiwianRpIjoiNzk2ZDY1MjctZjZhMC00OGJiLWJiNDUtYWZkMjM3YWU1MGZmIn0.qOWCmNsX40lfLu2aDZvV59-R_hpYQHY0wNGbxARW9Pog3Z7-Y8b1bllkf_Mt38u93C8Pd1rJR1P8_Is3S8g_qYz9yaa3xyCY0_axd7Useow7_CbDbA4hNU_-JsVUt1KWqdOnDIne1-LOGmzQooN3oLEWNV85hkheHvy8iPlT7BmrJ9dJXHowZ5lyY4BPIchRRjx0mlofbv7VipzaxHyqVnLOgohxjNZwb33_T_eeEPH6eOrRT-mmMupWs8Z_gZV7B2Kbzu55OjvmtQua8sdb1jUtQzQXqt6-pnE2IobBUKU9rM6R-1lvoJUh70NRBKdYfC3DobfSfGQRabhuUuUfiw"
}

Response:

{
  "opstatus":0,
  "message":"OwnerId Updated successfully",
  "httpStatusCode":200
}

Error Code(s):

Error Code: 500
Error Message: Denotes Internal Server Error
Error Code: 404
Error Message: Denotes Invalid Input Error

Enterprise Provider:

Document MS

Enterprise API:

/api/v1.0.0/evidences/owner/{oldPartyId}

Transact API:

Field Mapping

Enterprise API Field	Transact API Field	MS API Field
newPartyId	NA	ownerId

Field Name

Application/Table name

Dark Mode

Expand/ Collapse

In this topic

Products

Ecosystem

Technology

Other Product documentation

Document Integration Services