Mimoto

Mimoto is a BFF(Backend for Frontend) for Inji. It's being used to get default configuration, download verifiable credentials (VC) and activate VC. It provides all necessary APIs to the Inji and acts as a proxy for resident services. Mimoto gets the request from Inji, performs all the validations and forwards it to respective services. Additionally, it subscribes to the web-sub event to be able to download the VC once it's ready.

Detailed API documentation of Mimoto is available here.

Below are some of the important APIs.

Support for downloading VC from multiple Issuers

• To get list of issuers, the below API is called.

• To get list issuer's configuration, the below API is called.

Below are 2 types of issuers fo downloading VC:

1. Download via UIN/VID

2. Download via eSignet

Download via UIN/VID

Inji allows the users to enter their unique ID (UIN or VID) and download the credentials. Multiple Mimoto APIs are being called to complete the process in the backend.

• After entering the unique ID, the user is asked to enter an OTP on the next screen. In the backend, below API is called to send the OTP to the user as an email or SMS.

Generate Credential - Request Otp

Request new otp

POSThttps://api.collab.mosip.net/residentmobileapp/req/otp

Body

application/json

individualIdstring

individualIdTypestring

otpChannelarray of string

transactionIDstring

Response

200

OK

Body

application/json

idstring

versionstring

strnull

responsetimenull

metadatanull

responseobject

errorsnull

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/req/otp', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individualId": "1289358704",
      "individualIdType": "UIN",
      "otpChannel": [
        "EMAIL",
        "PHONE"
      ],
      "transactionID": "1234567890"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "version": "text",
  "response": {
    "maskedMobile": "text",
    "maskedEmail": "text"
  }
}

• After the user enters the OTP, Inji calls the below Mimoto API to request a new credential.

Generate Credential - request new credential

Credential request

POSThttps://api.collab.mosip.net/residentmobileapp/credentialshare/request

Body

application/json

individualIdstring

otpstring

transactionIDstring

userstring

Response

200

OK

Body

application/json

idstring

versionstring

strnull

responsetimestring

metadatanull

responseobject

errorsnull

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/credentialshare/request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individualId": "2057135194",
      "otp": "111111",
      "transactionID": "1234567890",
      "user": "mono"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "version": "text",
  "responsetime": "text",
  "response": {
    "id": "text",
    "requestId": "text"
  }
}

• The credentials are downloaded asynchronously after the request is processed. First, the API mentioned below is called to check the status of the credentials.

Generate Credential - Check Status of Credential Share

Credential request status

GEThttps://api.collab.mosip.net/residentmobileapp/credentialshare/request/status/{requestId}

Path parameters

requestId*string

The credential request id

requestId*string

Response

200

OK

Body

application/json

idnull

versionnull

strnull

responsetimestring

metadatanull

responseobject

errorsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/credentialshare/request/status/{requestId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "responsetime": "text",
  "response": {
    "id": "text",
    "requestId": "text",
    "statusCode": "text"
  },
  "errors": [
    {}
  ]
}

• After the credential status is ISSUED, the app initiates download. The API below will be called to download the credential.

Generate Credential - Download Credential

download VC

POSThttps://api.collab.mosip.net/residentmobileapp/credentialshare/download

Body

application/json

individualIdstring

requestIdstring

Response

200

OK

Body

application/json

credentialJsonNode (object)

verifiableCredentialJsonNode (object)

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/credentialshare/download', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individualId": "2057135194",
      "requestId": "2bc3bb7f-6156-46d1-ae03-bf7b76e0c257"
    }),
});
const data = await response.json();

Response

{}

Download via eSignet

Inji allows the users to download VC by redirecting to user to eSignet UI. Multiple APIs are being called to complete the process in the backend.

• Inji initiates authenticate API by redirecting user to eSignet UI. On eSignet UI, user is given option to enter the unique ID, the user is asked to enter an OTP on the next screen. In the backend, below API is called to get token.

• After getting token response, Inji initiates download request. Refer here

Activate credentials

Credentials have to be activated in order to use them for online login. When a user selects Activate option, an OTP is sent to the user and credentials are activated.

• To send an OTP to a user, the below API is called.

Wallet Binding - Generate Otp

This api is used to generate otp for wallet binding. This api is used as a proxy to call Identity Provider - Send Binding OTP Endpoint api internally.

POSThttps://api.collab.mosip.net/residentmobileapp/binding-otp

Body

application/jsonapplication/xmlmultipart/form-data

requestTimestring

requestobject

Response

200

OK

Body

application/json

idstring

versionstring

responsetimestring

metadataobject

responseobject

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/binding-otp', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestTime": "{{$isoTimestamp}}",
      "request": {
        "individualId": "3816083254",
        "otpChannels": [
          "EMAIL"
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "version": "text",
  "responsetime": "text",
  "response": {
    "maskedEmail": "text",
    "maskedMobile": "text"
  }
}

• After successful OTP validation, a keypair is generated in the phone and the public key is synced with server. The mimoto receives a certificate and create thumbprint which it stores in the keystore securely. This is called as the activation process.

Wallet Binding - Bind Credential with wallet

This api is used to bind the credential with wallet. This api is used as a proxy to call Identity Provider - Wallet binding Endpoint api internally.

POSThttps://api.collab.mosip.net/residentmobileapp/wallet-binding

Body

application/jsonapplication/xmlmultipart/form-data

requestTimestring

The request time

requestobject

Response

200

OK

Body

application/json

versionnullable string

idnullable string

responsetimenullable string

metadatanullable string

responseobject

errorsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/wallet-binding', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestTime": "2023-01-17T05:38:41.869Z",
      "request": {
        "authFactorType": "WLA",
        "format": "jwt",
        "individualId": "3816083254",
        "publicKey": "-----BEGIN RSA PUBLIC KEY-----\nMIICCgKCAgEAxo8hdrLl6nXyPSeSJu8xgmBBwVutacZS57rmIlHeKJfjYhKLT51v\n0k2IQqN2v6A3HOZqzKXh41p3RrxdSndkqqHwS0BLEVPNpKqYoEbe0tUICDpDSFaa\n7w87Z/OSGrw8bKpxmUT0xZ70+DGPhnWlMvPV5xenG1bVtf/vEq7cwQei1iNbNQRb\nqw/57e9LgmXdmbh/v5XOllT7rlUFmVFm4V4J3u6NH9iOPGlIKTplBlYyxlx6ayaR\n09Z6z4RJICG1MIipCv5qJwuzzXXpBja6gEG4xsN5K4W6b5GLt3IuzMMaQmReseRR\n46s53vBp7aqq1wrjs/CZ1SZqZ5ZG/nUchjTv+Nir0vPR9acvPB5j5qDgfdVz2sT/\nYL1HoeFPOIgcY1ydz+tUBm9F4AMCMZa7GbEmtAIWvxlQp6emo50/opdb51B3Teh3\neVQ+JqYYhOpuTEv0uHfhonXEsNfpGyttjR0FSAH2c6mI6UULi/PfLgcvKuqkhE+7\nlB0SFd852C993GqsY7qfxW1GvJpXYRvo6oRoFO8sj+St36MkmzJbm56AQn/9KWd5\nRLh13xrIUVRnW48y/Blchw/C68Ez1bmCyDeVe1WBPwel0zPl62jCtKawzCQiZcTL\n/ejmlKFHKQd980MwWN18OVakKU52CkO0NT+9ovgi0TRfLKvG6PQ1qGECAwEAAQ==\n-----END RSA PUBLIC KEY-----\n",
        "challengeList": [
          {
            "authFactorType": "OTP",
            "challenge": "111111",
            "format": "alpha-numeric"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "version": "text",
  "id": "text",
  "responsetime": "text",
  "metadata": "text",
  "response": {
    "certificate": "text",
    "encryptedWalletBindingId": "text",
    "expireDateTime": "text",
    "thumbprint": "text",
    "keyId": "text"
  },
  "errors": []
}

Configuration

The configurable properties for mimoto can be found at mimoto-default.properties. This property file is maintained as one for each deployment environment. On this repository, each environment configuration is placed in a corresponding branch specific to that environment.

Refer to mimoto-default.properties of Collab environment.

The implementers can choose to use the existing configurations or add new configurations to them.

Issuers Listing

The user is currently on the + button on the Home screen, which will open Add new card screen, where all the issuers are displayed Below issuers list API gives out all the issuers list

This API provides data with search capability to populate the list of supported issuers in Inji Web, which is then displayed under the List of Issuers

GEThttps://api.collab.mosip.net/residentmobileapp/issuers

Query parameters

Response

200

OK

Body

application/json

issuersany

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/issuers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

To get complete configuration of the specific issuer, below api is called.

This API provides the complete configuration details for the specific issuers passed in the path variable

GEThttps://api.collab.mosip.net/residentmobileapp/issuers/{issuer-id}

Path parameters

issuer-id*string

Response

200

OK

Body

application/json

issuersany

Request

JavaScriptCurl

const response = await fetch('https://api.collab.mosip.net/residentmobileapp/issuers/{issuer-id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}