Integrate with MOSIP e-Signet

Description

This guide provides steps to integrate OpenG2P with e-Signet with MOSIP as the authentication provider.

Pre-requisites

MOSIP IDA is installed
The e-Signet server is installed and configured to connect to MOSIP IDA
MOSIP IDA APIs are accessible from the machine running the e-Signet server
Both Yes/No and KYC APIs are enabled on MOSIP IDA
e-Signet APIs are accessible from machines running OpenG2P
Biometric auth devices (already onboarded on MOSIP) are available for authentication
Email and SMS are enabled on MOSIP IDA for OTP authentication
MOSIP Partner Management Services (PMS) Portal or APIs must be accessible to both MOSIP Partner Admin and OpenG2P Admin
MOSIP Partner Specific User Token (PSUT) ID type is configured. See Configure ID Types.

Steps

Configure OpenG2P as a partner on MOSIP

Create an Auth Partner for OpenG2P on MOSIP.
- Guide for MOSIP 1.2.0
- Guide for MOSIP 1.1.5 (TBD)
Create a MISP Partner for OpenG2P on MOSIP.
Note down the following from the above steps:
1. Auth Partner ID
2. Auth Policy ID
3. Auth API Key
4. MISP License Key
5. Auth partner signed certificate
6. IDA Partner certificate (App id: IDA, Ref Id: PARTNER)

Configure OpenG2P as relying party on e-Signet

Using PMS API

This method is applicable if MOSIP Partner Management APIs are available. These steps are executed by MOSIP Partner Admin

Create an e-Signet OIDC client using PMS OIDC API:

post

Body

idstringOptional

versionstringOptional

requesttimestring · date-timeOptional

metadataobjectOptional

Responses

200

application/json

post

/oidc/client

POST /v1/partnermanager/oidc/client HTTP/1.1
Host: api-internal.mec.mosip.net
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "id": "text",
  "version": "text",
  "requesttime": "2025-10-31T18:13:04.681Z",
  "metadata": {},
  "request": {
    "name": "text",
    "policyId": "text",
    "publicKey": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "authPartnerId": "text",
    "logoUri": "text",
    "redirectUris": [
      "text"
    ],
    "grantTypes": [
      "text"
    ],
    "clientAuthMethods": [
      "text"
    ]
  }
}

200

{
  "id": "text",
  "version": "text",
  "responsetime": "2025-10-31T18:13:04.681Z",
  "metadata": {},
  "response": {
    "clientId": "text",
    "status": "text"
  },
  "errors": [
    {
      "errorCode": "text",
      "message": "text"
    }
  ]
}

authParnterId: Partner ID in this step.
policyId : Policy ID in this step.
publicKey: Generate JWK.
logoUri: URL of your logo accessible publicly.
grantTypes = ["authorization_code"]
clientAuthMethods= ["private_key_jwt"]
redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin

Note down the Client ID as an output of the above step.

Using e-Signet API

This method is applicable if MOSIP Partner Management APIs are not available.

Create an e-Signet OIDC client using the following API:

post

Body

requestTimestringOptional

Responses

200

application/json

post

/client-mgmt/oidc-client

POST /v1/esignet/client-mgmt/oidc-client HTTP/1.1
Host: api-internal.mec.mosip.net
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "requestTime": "text",
  "request": {
    "clientId": "text",
    "clientName": "text",
    "publicKey": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "relyingPartyId": "text",
    "userClaims": [
      "text"
    ],
    "authContextRefs": [
      "text"
    ],
    "logoUri": "text",
    "redirectUris": [
      "text"
    ],
    "grantTypes": [
      "text"
    ],
    "clientAuthMethods": [
      "text"
    ]
  }
}

200

{
  "responseTime": "text",
  "response": {
    "clientId": "text",
    "status": "text"
  },
  "errors": [
    {
      "errorCode": "text",
      "errorMessage": "text"
    }
  ]
}

clientId: Arbitrary string.
clientName: Arbitrary string.
relyingParnterId: Partner ID in this step.
publicKey: Generated JWK.

authContextRefs:

["mosip:idp:acr:biometrics","mosip:idp:acr:generated-code"]

userClaims:

["birthdate","address","gender","name","phone_number","email","picture"]

logoUri: URL of your logo accessible publicly.
grantTypes = ["authorization_code"]
clientAuthMethods= ["private_key_jwt"]
redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin

Enable e-Signet on OpenG2P

These steps are executed by OpenG2P Admin on the OpenG2P Admin interface.

Go to Settings -> General Settings (Menu) -> General Settings (Panel) -> Integrations (Section) -> Oauth Providers

Create a new OIDC Provider with the following details:

Parameter

Value

Client ID

The output of the previous section.

Auth Flow

OpenID Connect (authorization code flow)

Token map

sub:user_id

Client Authentication Method

Private Key JWT

Private Key Method

Private key used for JWK creation in the previous section.

Assertion Type

JWT Bearer

Authorization URL

e-Signet's authorize endpoint.

Example: https://esignet.mec.mosip.net/authorize

Userinfo URL

e-Signet's userinfo API

Example: https://api.mec.mosip.net/v1/esignet/oidc/userinfo

Token URL

e-Signet's token API

Example: https://api.mec.mosip.net/v1/esignet/oauth/token

JWKS URL

e-Signet's JWKS API

Example: https://api.mec.mosip.net/v1/esignet/oauth/.well-known/jwks.json

Use G2P Reg ID

True

G2P Registrant ID Type

MOSIP PSUT ID Type

As configured in step 9 of Prerequisites.

Partner Creation Call Validate URL

True

Specifies whether to call the MOSIP e-KYC API to fetch data into OpenG2P

Partner Creation Validate Response

name:name email:email phone:phone_number birthdate:birthdate gender:gender address:address

Default Group User Creation

User types / Portal

Specifies all users signing up through this OIDC Provider (e-Signet) are only going to be portal users

email

To allow users to sign in with their email and password after initial signup with e-Signet.

PreviousAuthentication NextDeduplication

Last updated 1 year ago