Propose proof

For digital wallets, this method generates a QR code to initialize device engagement for offline exchange over Bluetooth Low Energy (BLE).

In addition to creating a QR code to be shared with a mobile verifier device, this method starts BLE advertising and creates a proof in PENDING state. After the connection between devices is established and the proof request is received, the state changes to REQUESTED and the wallet awaits a holder decision to submit or reject the request.

See ISO mDL for details.

Function

React Native

proposeProof(
    exchange: string,
    organisationId: string
  ): Promise<ProposeProofResponse>

iOS

func proposeProof(exchange: String, organisationId: String) throws  -> ProposeProofResponseBindingDto

Android

fun `proposeProof`(`exchange`: kotlin.String, `organisationId`: kotlin.String): ProposeProofResponseBindingDto

Parameters

• exchange - Specify an exchange protocol to govern the credential exchange. Supported:

  • ISO_MDL - ISO mDL offline exchange over Bluetooth Low Energy.

• organisationId - The organization ID of the digital wallet.

Return value

React Native

export interface ProposeProofResponse {
  proofId: string;
  interactionId: string;
  url: string;
}

iOS

public struct ProposeProofResponseBindingDto {
    public var proofId: String
    public var interactionId: String
    public var url: String
}

Android

data class ProposeProofResponseBindingDto (
    var `proofId`: kotlin.String,
    var `interactionId`: kotlin.String,
    var `url`: kotlin.String
)

Fields

• proofId - ID of the newly created proof.

• interactionId - ID of the newly created interaction.

• url - QR code used to establish device engagement.