Usage

This section provides an overview of how to use the key SDK components and capabilities.

Capabilities

• Request and verify mDocs via a proximity presentation workflow as per ISO/IEC 18013-5:2021.

Components

Classes

The following classes are the core components of all SDK interactions:

• MobileCredentialVerifier : This class serves as the entry point for any interaction with the SDK.
• ProximityPresentationSession : This class represents a proximity presentation session with a holder using device retrieval, as per ISO/IEC 18013-5:2021.

Methods

General

• initialise : Initializes the MobileCredentialVerifier class.

Refer to the Initialize SDK section for more information and usage examples.

Credential verification

• createProximityPresentationSession : Use this method to establish a secure communication channel with a holder device for a proximity presentation session.
• requestMobileCredentials : Use this method of the ProximityPresentationSession class method to request information for verification once a connection is established with a holder’s device.

Certificate management

• addTrustedIssuerCertificates : Use this method to add an issuer’s certificate to the application storage. Credentials can only be verified if their issuer’s valid certificate exists in the application storage. Prior to adding a certificate, the SDK validates it as per the IACA profile defined in ISO/IEC 18013-5:2021.

Structures

• MobileCredentialRequest : Used to define what information is requested for verification.
• MobileCredentialResponse : Includes the credentials returned by a holder’s device in response to a verification request.
• MobileCredentialPresentation : Represents a credential shared by the holder, including its branding, claims and verification result.