Built by developers for developers
Developers unlock the full potential of applications with Mobile ID solutions. Try Integrations with robust, secure identity management solutions with flexible APIs and comprehensive documentation for a seamless experience.
Developer’s Guide for Digital Partners Mobile ID
Registration
Digital Partners provides a seamless API solution to manage digital identity registration and device activation.
Here’s how to integrate a client and use the registration API in the system in just a few simple steps:
Activation Portal
- Representatives will log in to the backend system to begin the Mobile ID activation process.
Unique Number
- Representatives will start by entering the unique number provided to the client through official records. This number is crucial as it ties the digital identity to the individual.
- Ensure unique numbers are captured correctly during registration, and the client is who they say they are!
Location Selection
- The registration form includes a location selection dropdown of where the activation is happening.
- Representatives can select the appropriate city from a static dropdown list, which is pre-configured based on the country that has hosts in the solution in their servers.
- Ensure that the correct city is selected during registration as this is crucial for the proper functioning of the system and for data registries.
Device Activation
- Representatives will click the "Activate Device" button to initialize the device registration and enrollment process.
- The device is associated with a digital ID for secure authentication upon activation.
Enter User Details
- Representatives can retrieve Full Name, Mother's Name, and Date of Birth (DOB) from the API, or the database on the Unique Number provided by the client (i.e government).
- Ensure the details are accurate by comparing to the physical ID of the client, as they are essential for identity verification.
Receive Activation Code
- The representatives will personally handle the Mobile ID activation or registration when the client visits the office – for complete security and transparency.
- Instead of sending the activation code via SMS or email, the representatives will provide it directly to the client to complete the registration process.
- This ensures a secure step in the activation process and in the solution as a whole.
Mobile App Confirmation
- After receiving the activation code, the client can enter it into the mobile app to finalize the registration/activation and the activation of the Digital ID.
- The client then sets a six-digit PIN Code of their own as a passcode or uses their biometrics i.e. finger scan or face for later on authentications, payment authorizations etc.
Registration Response
- Upon successful activation by the client, the registration system will generate a confirmation response that is visible on the dashboard of the client’s device and a successful registration response on the registration API system of the representative.
Registration Process depicted as above
Authentication
Enter the Unique Number (That the client used for registration for Mobile ID)
- Enter the unique number the client wants to authenticate.
- Capture this number correctly as it's essential for identifying in the authentication process.
Get Available Devices
- Click on the "Get available devices" button to retrieve and select an available authentication device for the user that matches their device they installed their Mobile ID.
- Ensure unique numbers are captured correctly during registration, and the client is who they say they are!
Add Push Payload (Optional)
- A user may enter additional data into the app by selecting the "Specify push payload" option.
- Use this to transmit any necessary contextual information for the app during authentication.
Authenticate
- Click the Authenticate button to trigger the authentication process.
- Ensure that the authentication request is securely transmitted.
Push Notification for Mobile Authentication
- When the user clicks on the push notification, they will be prompted to enter the PIN they created during registration or whatever other means like fingerprint or face scan for authentication.
- This step verifies the authenticity of the user, ensuring they are genuine, and owner of the device and Mobile ID being used for authentication
Authentication Response
- Once a client authenticates, an authentication response will be displayed on the dashboard.
- The same response will also appear on the mobile app under the "My History" menu.
Authentication Process depicted as above
Payment Authorization
Enter the Unique Number (That the client used for registration for Mobile ID)
- Enter the unique identifier (Mobile ID or customer ID) to initiate the payment authorization process.
- Capture this number accurately for proper user identification.
Get Available Devices
- Retrieve the devices linked by selecting "Get available devices." Choose the device for payment authorization.
- Ensure that the device selected corresponds to the correct unique number for secure transactions.
Add Push Payload (Optional)
- Optionally, enter additional data (e.g., order details) with the push payload option.
- Use this step to enhance custom functionality during payment authorization.
Submit Payment Information
- Enter payment details such as amount and description and display a confirmation message for the user.
- Ensure that all transaction details are securely captured and transmitted.
Notify and Authorize
- A push notification will be sent to the client's device, requesting payment authorization.
- Verify that the mobile app is configured to receive and handle push notifications smoothly
Handle Post-Authorization
- After authorization, the system will return the response to the client's app, confirming or declining the payment.
Payment Authorization Process depicted as above
Consent Signature
Enter the Unique Number (That the client used for registration for Mobile ID)
- Enter the unique identifier (Mobile ID or customer ID) to initiate the consent signature process.
- Ensure the ID is accurate to avoid errors during authentication.
Get Available Devices
- Retrieve the linked devices by selecting "Get available devices." Choose the device that will receive the consent request.
- Always confirm that the correct device is chosen for secure consent signing.
Add Push Payload (Optional)
- Optionally, enter additional data (e.g., document ID) with the consent request.
- Use this to transmit any necessary contextual information for the app during the Consent Signature.
Enter Consent Text
- Provide the consent text that a client will sign, such as “Please sign the document.” Clients can also add metadata if needed.
Select SDO Format and Sign
- Choose the format for the Signed Digital Object (SDO), like JWT or XML, and send the consent request by clicking "Sign."
- Select the appropriate SDO format based on the system's compatibility and security requirements.
Notify and Capture Signature
- A push notification will be sent to the client's selected device, prompting them to sign. The signed response is then returned to your app.
- Ensure the mobile app is set up to receive push notifications without delay to optimize the signing process.
Handle Post-Signature Response
- Once signed, the response is returned, confirming or declining your consent.
Consent Signature Process depicted as above
Useful Links
Contact Info
