Skip to content

README.md

Latest commit

 

History

History
74 lines (55 loc) · 3.16 KB

README.md

File metadata and controls

74 lines (55 loc) · 3.16 KB
Raw

INJI VCI Client

Features

  • Request credential to Credential issuer and send the output Credential response

Note: Consumer of this library will be taking the responsibility of processing or parsing the credential for rendering or any other purpose as per requirement

Installation

Snapshot builds are available here.

implementation "io.mosip:inji-vci-client:0.1.0-SNAPSHOT"

Supported Credential formats

  1. ldp_Vc
  2. mso_mdoc

Refer here for the format constant

APIs

Request Credential

Request for credential from the providers (credential issuer), and receive the credential back.

val credentialResponse: CredentialResponse? = VCIClient().requestCredential(
                        issuerMetadata,
                        proof,
                        accessToken
                    )
Parameters
Name Type Description Sample
issuerMetaData IssuerMetaData Data object of the issuer details IssuerMetaData(credentialAudience, credentialEndpoint, downloadTimeout, credentialType, credentialFormat)
proofJwt Proof The proof used for making credential request. Supported proof types : JWT. JWTProof(jwtValue)
accessToken String token issued by providers based on auth code ""
Construction of issuerMetadata
  1. Format: ldp_vc
val issuerMetadata = IssuerMetaData(
                        CREDENTIAL_AUDIENCE,
                        CREDENTIAL_ENDPOINT, 
                        DOWNLOAD_TIMEOUT, 
                        CREDENTIAL_TYPE, 
                        CredentialFormat.LDP_VC )
  1. Format: mso_mdoc
val issuerMetadata = IssuerMetaData(
                        CREDENTIAL_AUDIENCE,
                        CREDENTIAL_ENDPOINT, 
                        DOWNLOAD_TIMEOUT, 
                        DOC_TYPE,
                        CLAIMS, 
                        CredentialFormat.MSO_MDOC )
Exceptions
  1. DownloadFailedException is thrown when the credential issuer did not respond with credential response
  2. NetworkRequestTimeoutException is thrown when the request is timedout

More details

An example app is added under /example folder which can be referenced for more details