Table of content
Overview
The VNeid service APIs support the Mobile App onboarding journey by integrating with VNeID for digital identity verification.
These APIs enable the system to initiate requests for citizen data sharing and biometric authentication (face verification) with VNeID, and to retrieve the verification results along with the citizen information that the customer has consented to share. It ensures that customers are properly authenticated and that official citizen data is obtained to support CIF creation, account opening, and other services requiring strong identity verification.
Why use these APIs?
- Secure identity verification for onboarding
Ensures customers are authenticated via VNeID with biometric (face) verification before CIF and account creation. - Official citizen data source
Retrieves verified citizen information directly from VNeID with customer consent. - Backend integration layer
Provides a standardized and secure connection between Mobile App, backend systems, and VNeID.
Key features
- POST /int-connector-service/biometric-share-info/api/agent/init
Sends a request to VNeID to initiate a transaction for citizen data sharing and biometric authentication. - POST /int-connector-service/biometric-share-info/api/get-transaction
Retrieves the biometric authentication result and citizen data consented for sharing after successful face authentication.
