Use Cases
1. Upload customer images for onboarding journey (NTB)
APIs:
- POST /int-ecm-service/v1/login
- POST /int-ecm-service/v1/document/upload-on-boarding
Purpose
To upload customer identity images (both sides of ID card and selfie) to ECM after eKYC, liveness detection, and biometric matching during onboarding.
Scenario
During the onboarding journey for a New-to-Bank (NTB) customer, the system captures the customer’s ID card (front and back) and selfie image. These images need to be stored in ECM for identity verification and future audit purposes.
System Action
- The channel system invokes the /int-ecm-service/v1/login API to obtain a time-limited access token.
- Only if the token is successfully returned, the channel proceeds to the next API:
- The channel system invokes the /int-ecm-service/v1/document/upload-on-boarding API multiple times, with the number of calls depending on the number of images to be uploaded, as the API supports uploading only one image per request.
- For each API call, the channel system uses the access token to send a single image (e.g., ID card front, ID card back, or customer selfie) along with the required metadata to ECM.
- ECM performs the following:
- Validates the request
- Stores each image
After each successful upload, the system receives a response containing the corresponding document ID for the stored image.
Error handling
No | HTTP status code | code | Description | Resolution |
| 1 | 400 | ESB.027.02.008 | Validation errors: mandatory fields are missing, values (for example: username/password) do not exist. | Show message error defined by PO |
2 | 400 | ESB.027.01.008 | Connection error to targetService. | Show message error defined by PO |
3 | 400 | ESB.027.01.009 | Invalid FunctionCode | Show message error defined by PO |
4 | 401 | Token is not valid or expired (if any). | Show message error defined by PO | |
5 | 403 | Access to the service is denied. | Show message error defined by PO | |
6 | 500 | An internal error occurred. | Show message error defined by PO |
Outcome
Customer images are successfully uploaded and stored in ECM for verification and future reference.
Benefit
- Enables secure storage of customer identity data.
- Ensures compliance and audit traceability.
2. Download customer image for loan onboarding journey.
APIs:
- POST /int-ecm-service/v1/login
- POST /int-ecm-service/v1/document/download
Purpose
To retrieve the customer’s image from ECM and display the customer’s portrait for his/her to confirm alongwith personal data.
Scenario
During the loan onboarding journey for an ETB customer, the system needs to display the customer’s portrait on the information confirmation screen.
System Action
- The channel system invokes the /int-ecm-service/v1/login API to obtain a time-limited access token.
- Only if the token is successfully returned, the channel proceeds to the next API:
- The channel system invokes the /int-ecm-service/v1/document/download API via the integration service using the access token and document_id to request the customer image from ECM.
- ECM validates and returns the image to the channel system.
Error handling
No | HTTP status code | code | Description | Resolution |
| 1 | 400 | ESB.027.02.008 | Validation errors: mandatory fields are missing, values (for example: username/password) do not exist. | Show message error defined by PO |
2 | 400 | ESB.027.01.008 | Connection error to targetService. | Show message error defined by PO |
3 | 400 | ESB.027.01.009 | Invalid FunctionCode | Show message error defined by PO |
4 | 401 | Token is not valid or expired (if any). | Show message error defined by PO | |
5 | 403 | Access to the service is denied. | Show message error defined by PO | |
6 | 500 | An internal error occurred. | Show message error defined by PO |
Outcome
The customer image is successfully retrieved and displayed on the confirmation screen.
Benefit
- Enables seamless and secure retrieval of customer images from ECM.
- Enhances customer verification and user trust during onboarding.
