Mimoto - BFF

Mimoto serves as a Backend for Frontend (BFF) for Inji Web, handling retrieval of default configurations and downloading VCs. It offers essential APIs to Inji Web, facilitates validations, and forwards requests to relevant services.

To support credential issuance from any issuer compatible with the OpenID4VCI protocol, Mimoto must be onboarded as an OIDC client. Refer here for more details on how to onboard Mimoto (BFF) as an OIDC client.

Detailed API documentation for Mimoto is accessible here.

Configuration details to set up a new provider that can issue VC, can be found in the mimoto-issuers-config.json property file. Refer to mimoto-issuers-config.json of Collab environment.

In mimoto-issuers-config.json, new providers can be added as per the well-known schema.

Mimoto endpoints used by Inji Web:

1. Fetch Issuers:

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

{}

2. Fetch Issuer's Configuration:

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

{}

3. Download PDF:

This API is responsible for generating PDFs for the received VC content. It fetches display properties from the well-known configuration of the issuer and incorporates them into the predefined template of the PDF file.

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

Path parameters

issuer-id*string

credentialType*string

Header parameters

Response

200

OK

Body

application/pdf

string (binary)

Request

JavaScriptCurl

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

Response

"binary"

4. Fetch Issuer Credentials:

This API fetches the list of Credential Types offered by the issuer, sourced from the well-known configuration of the issuer. Users can filter credentials based on search parameter.

https://api.collab.mosip.net/residentmobileapp/issuers/{issuerid}/credentialTypes?search={credentials}

Method Type: GET

Parameter:

issuerid: ID of the issuer in string type.

Query parameter

credentials: Search parameter for credential display name in string type.

Response

Response code 200

{
  "id": "mosip.resident.vid",
  "version": "v1",
  "str": null,
  "responsetime": "2022-10-31T05:08:14.846Z",
  "metadata": null,
  "response": {
    "supportedCredentials": [
      {
        "format": "ldp_vc",
        "id": "InsuranceCredential",
        "scope": "sunbird_rc_insurance_vc_ldp",
        "display": [
          {
            "name": "MOSIP Insurance",
            "logo": {
              "url": "https://api.collab.mosip.net/inji/mosip-logo.png",
              "alt_text": "insurance logo"
            },
            "locale": "en",
            "background_color": "#fafcff",
            "text_color": "#00284d"
          }
        ],
        "proof_types_supported": [
          "jwt"
        ],
        "credential_definition": {
          "type": [
            "VerifiableCredential",
            "InsuranceCredential"
          ],
          "credentialSubject": {
            "fullName": {
              "display": [
                {
                  "name": "Full Name",
                  "locale": "en"
                }
              ]
            },
            "policyName": {
              "display": [
                {
                  "name": "Policy Name",
                  "locale": "en"
                }
              ]
            },
            "policyNumber": {
              "display": [
                {
                  "name": "Policy Number",
                  "locale": "en"
                }
              ]
            },
            "gender": {
              "display": [
                {
                  "name": "Gender",
                  "locale": "en"
                }
              ]
            },
            "expiresOn": {
              "display": [
                {
                  "name": "Expiry Date",
                  "locale": "en"
                }
              ]
            },
            "dob": {
              "display": [
                {
                  "name": "Date Of Birth",
                  "locale": "en"
                }
              ]
            }
          }
        }
      },
      {
        "format": "ldp_vc",
        "id": "LifeInsuranceCredential_ldp",
        "scope": "life_insurance_vc_ldp",
        "display": [
          {
            "name": "Sunbird Life Insurance",
            "logo": {
              "url": "https://sunbird.org/images/sunbird-logo-new.png",
              "alt_text": "Sunbird life insurance logo"
            },
            "locale": "en",
            "background_color": "#fefcfa",
            "text_color": "#7C4616"
          }
        ],
        "proof_types_supported": [
          "jwt"
        ],
        "credential_definition": {
          "type": [
            "VerifiableCredential",
            "LifeInsuranceCredential"
          ],
          "credentialSubject": {
            "fullName": {
              "display": [
                {
                  "name": "Full Name",
                  "locale": "en"
                }
              ]
            },
            "policyName": {
              "display": [
                {
                  "name": "Policy Name",
                  "locale": "en"
                }
              ]
            },
            "policyNumber": {
              "display": [
                {
                  "name": "Policy Number",
                  "locale": "en"
                }
              ]
            },
            "gender": {
              "display": [
                {
                  "name": "Gender",
                  "locale": "en"
                }
              ]
            },
            "policyExpiresOn": {
              "display": [
                {
                  "name": "Expiry Date",
                  "locale": "en"
                }
              ]
            },
            "dob": {
              "display": [
                {
                  "name": "Date Of Birth",
                  "locale": "en"
                }
              ]
            }
          }
        }
      }
    ],
    "authorization_endpoint": "https://esignet.collab.mosip.net/authorize"
  },
  "errors": null
}