Digital Partners
CompanyAbout UsContact Us
Developer Guide

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.

Mobile ID API
POST/api/member/auth/token
RequestJSON
{
"params": "<ENCRYPTED_PARAMS>"
}

Mobile ID SOLUTIONS

01Registration/Onboarding
02Authentication
03Payment Authorization
04eConsent Signature
05Digital ID Verification
06eID Verification
Mobile ID Integration

Build with Digital Partners Mobile ID

Integrate identity registration, authentication, payment authorization and eConsent signature into your services.

01 · Registration

Register and activate a Mobile ID

Digital Partners provides a seamless API solution to manage digital identity registration and device activation.

Process overview

Here’s how to integrate a client and use the registration API in the system in just a few simple steps:

RegistrationConceptual flow

From identity check to a ready Digital ID

A person proves who they are, activates Mobile ID on their phone, and leaves with a trusted credential.

Office visit

Identity is checked in person

Their phone

Mobile ID is activated

Digital ID

Ready to use securely

  1. Step 01

    Verify identity

    The person is identified in person against official records.

  2. Step 02

    Activate the device

    Mobile ID is bound to that one phone.

  3. Step 03

    Confirm in the app

    They set a PIN or use biometrics to finish setup.

  4. Step 04

    Digital ID is ready

    A trusted identity now lives on the device.

Process steps
01

Activation Portal

  • Representatives will log in to the backend system to begin the Mobile ID activation process.
02

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!
03

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.
04

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.
05

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.
06

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.
07

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.
08

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.

02 · Authentication

Authenticate a registered Mobile ID

Digital Partners provides a seamless API solution to manage digital identity authentication.

Process overview

Enter the unique number the client wants to authenticate and capture this number correctly as it's essential for identifying in the authentication process.

AuthenticationConceptual flow

Authenticate securely with Mobile ID

A service asks “is this the right person?”, the phone prompts them, and access is granted only after they confirm.

Your service provider / verifier

Sends an authentication request

Mobile ID App

Receives the secure request

Authenticated

Identity is verified

  1. Step 01

    Authentication requested

    The service requests the user to authenticate their identity using Mobile ID.

  2. Step 02

    Request sent to Mobile ID

    A secure authentication request is sent to the user’s registered Mobile ID device.

  3. Step 03

    User verifies the request

    The user reviews and approves the request using their Mobile ID PIN or supported biometric authentication.

  4. Step 04

    Authentication result returned

    Mobile ID securely returns the authentication result to the requesting service, allowing it to continue only after successful verification.

Process steps
01

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!
02

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.
03

Authenticate

  • Click the Authenticate button to trigger the authentication process.
  • Ensure that the authentication request is securely transmitted.
04

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
05

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.

03 · Payment Authorization

Authorize payments with Mobile ID

Digital Partners provides a secure API solution to initiate and manage payment authorization using Mobile ID.

Process overview

Enter the unique identifier (Mobile ID or customer ID) to initiate the payment authorization process and capture this number accurately for proper user identification.

Payment authorisationConceptual flow

Approve payments securely with Mobile ID

A payment service sends an payment authorisation request to the user’s registered Mobile ID device. The user reviews the payment details and securely approves or declines the request.

Your service provider / verifier

Sends a payment request

Mobile ID App

Displays payment details

Result

Approved or declined

  1. Step 01

    Payment authorisation requested

    The service sends a payment authorisation request containing the transaction details to Mobile ID.

  2. Step 02

    Request sent to Mobile ID

    The payment request is securely delivered to the user’s registered Mobile ID device for review.

  3. Step 03

    Authorise or decline

    The user reviews the transaction and approves or declines it using their Mobile ID PIN or supported biometric authentication.

  4. Step 04

    Authorisation result returned

    Mobile ID securely returns the user’s decision to the requesting service, allowing the transaction to proceed only when approved.

Process steps
01

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.
02

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.
03

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.
04

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
05

Handle Post-Authorization

  • After authorization, the system will return the response to the client's app, confirming or declining the payment.
API Reference

API Integration Examples

Once onboarding is completed through the authentication portal, integrating services can obtain an authentication token and use it to access the Mobile ID APIs listed below.

01

Get token

02

Receive access token

03

Call a Mobile ID API

04

Receive the response

05

Refresh the token when it expires

01

Get Access Token

Issue an access token for a registered Mobile ID member on a specific device. Call this before any protected Mobile ID API.

What to do next

Use access_token as Authorization: Bearer <ACCESS_TOKEN> on protected APIs. Keep refresh_token and request a new pair from the refresh endpoint before access_ttl seconds elapse.

POST/api/member/auth/token

params is an encrypted JSON string containing creference (member reference), oreference (organisation reference), and app_code (application code). XDeviceID is the encrypted device identifier.

Headers
POST /api/member/auth/token

XDeviceID: <ENCRYPTED_DEVICE_ID>
Content-Type: application/json
Accept: application/json
Body
{
  "params": "<ENCRYPTED_PARAMS>"
}
02

Get Available Device

Confirm that a unique number already has an active Mobile ID, and retrieve the registered device name before authentication, Consent, or payment.

What to do next

If status is true, continue with authentication, eConsent signature, or payment authorisation for that unique number.

GET/api/client/{unique_number}
Headers
GET /api/client/{unique_number}

Authorization: Bearer <ACCESS_TOKEN>
Accept: application/json
Request
GET /api/client/1234567890
03

Authentication

Start a Mobile ID authentication for a registered unique number. A push request is sent to the user’s device.

What to do next

Keep the returned ref. Poll POST /api/organization/authenticate/checkStatus with that ref until the result is Successful (code 800), Pending (code 801), or rejected.

POST/api/authentication
Headers
POST /api/authentication

Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": "1234567890",
  "pushPayload": "Please confirm this authentication"
}
04

Payment Authorization

Ask the user to approve a payment on their Mobile ID device. Each transaction_id must be unique.

What to do next

Keep the returned ref. Poll POST /api/organization/authorizepayment/checkStatus until the result is Successful. An approved payment can include a signature.

POST/api/payment-authorization
Headers
POST /api/payment-authorization

Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json
Accept: application/json
Body
{
  "client_id": "1234567890",
  "transaction_id": "TXN-20260315-001",
  "amount": "250.00",
  "currency": "USD",
  "timeout": "2",
  "beneficiary_name": "Example Merchant",
  "beneficiary_bank": "Example Bank",
  "beneficiary_account": "0011223344",
  "reference": "INV-1001",
  "preContextTitle": "Approve this payment"
}
05

Refresh Access Token

Exchange a valid refresh token for a new access token and refresh token when the current access token expires.

What to do next

Replace the stored tokens with the new access_token and refresh_token from data. Continue calling protected APIs with Authorization: Bearer <ACCESS_TOKEN>.

POST/api/member/auth/refresh-token

Send the same encrypted XDeviceID used when the original token was issued. refresh_token is the value returned by Get Access Token.

Headers
POST /api/member/auth/refresh-token

XDeviceID: <ENCRYPTED_DEVICE_ID>
Content-Type: application/json
Accept: application/json
Body
{
  "refresh_token": "<REFRESH_TOKEN>"
}

Start Your Secure Digital Identity Journey Today

Empower your organization with a trusted, scalable, and secure digital identity solution built for modern digital interactions.

Get in Touch