Use Case
1. Perform Digital Identity Verification for Mobile App Onboarding
APIs:
- POST /int-connector-service/biometric-share-info/api/agent/init
- POST /int-connector-service/biometric-share-info/api/get-transaction
Purpose:
To perform digital identity verification via VNeID to support the Mobile App onboarding journey, including CIF creation, Mobile App account registration, and Current Account opening, by linking customers to VNeID, requesting citizen data sharing, and performing biometric authentication (face verification).
Scenario:
A customer starts onboarding on the Mobile App to open CIF, register a Mobile App account, and open a current account. The customer chooses to verify identity via VNeID using their Citizen ID card.
System Action:
- The customer enters the onboarding flow on the Mobile App.
- The Mobile App links the customer to VNeID using the Citizen ID.
- The system calls /int-connector-service/biometric-share-info/api/agent/init
to initiate a transaction with VNeID.- If HTTP status code <> 200, an error message will be displayed to the customer, and the application allows the user to trigger a new request.
- If HTTP status code = 200, VNeID returns a transactionId for later retrieval of citizen data and biometric verification results.
- The screen is redirected to the VNeID application.
- The customer:
- Agrees to share citizen information.
- Confirms biometric authentication on VNeID.
- VNeID notifies NCB that the customer has provided consent by sending a consentId via universal link.
- The customer performs biometric verification by capturing a face image on the Mobile App.
- The Mobile App sends biometric data and transaction information to VNeID via /int-connector-service/biometric-share-info/api/get-transaction.
- If HTTP status code <> 200, an error message will be displayed to the customer, and the application allows the user to trigger a new request.
- If HTTP status code = 200, VNeID returns biometric verification result and citizen data consented for sharing then proceeds to the personal information confirmation page.
Error handling:
No | HTTP status code | Message | Description |
1 | 200 | SUCCESS | Request is successfully processed. |
2 | 401 | ACCESS_TOKEN | Token is expired (if any). |
3 | 403 | FORBIDDEN | Access to the service is denied. |
4 | 404 | NOT_FOUND | The requested endpoint does not exist. |
5 | 500 | INTERNAL SERVER ERROR | An error occurred during processing. The system will provide detailed error information. |
6 | 501 | BIOMETRIC ERROR | A biometric authentication error occurred. The system will provide detailed error information. |
Outcome:
- If verification is successful, the system proceeds with further steps in the onboarding flow.
- If verification fails, the onboarding flow is stopped and the customer is requested to retry the identity verification step.
Benefit:
- Ensures strong identity verification before CIF and account creation.
- Retrieves official citizen data directly from VNeID with customer consent.
- Automates and accelerates the onboarding journey.
- Reduces fraud risk and manual verification effort.
- Provides a seamless digital experience for customers.
