Get proof request details

Returns details on a proof request.

Function

React Native

getProof(proofId: ProofDetail["id"]): Promise<ProofDetail>

iOS

func getProof(proofId: String) throws  -> ProofRequestBindingDto

Android

fun `getProof`(`proofId`: String): ProofRequestBindingDto

Parameters

• proofId - ID of proof request. For wallets, this value comes from the handle invitation function.

Return value

React Native

export interface ProofDetail {
  id: string;
  createdDate: string;
  lastModified: string;
  proofInputs: ProofInput[];
  state: ProofStateEnum;
  role: ProofRoleEnum;
  proofSchema?: ProofSchemaListItem;
  verifier?: IdentifierListItem;
  holder?: IdentifierListItem;
  protocol: string;
  transport: string;
  redirectUri?: string;
  retainUntilDate?: string;
  requestedDate?: string;
  completedDate?: string;
  claimsRemovedAt?: string;
}

iOS

public struct ProofResponseBindingDto {
    public var id: String
    public var createdDate: String
    public var lastModified: String
    public var verifier: GetIdentifierListItemBindingDto?
    public var holder: GetIdentifierListItemBindingDto?
    public var state: ProofStateBindingEnum
    public var role: ProofRoleBindingEnum
    public var proofSchema: GetProofSchemaListItemBindingDto?
    public var `protocol`: String
    public var transport: String
    public var redirectUri: String?
    public var proofInputs: [ProofInputBindingDto]
    public var retainUntilDate: String?
    public var requestedDate: String?
    public var completedDate: String?
    public var claimsRemovedAt: String?
}

Android

data class ProofResponseBindingDto (
    var `id`: kotlin.String,
    var `createdDate`: kotlin.String,
    var `lastModified`: kotlin.String,
    var `verifier`: GetIdentifierListItemBindingDto?,
    var `holder`: GetIdentifierListItemBindingDto?,
    var `state`: ProofStateBindingEnum,
    var `role`: ProofRoleBindingEnum,
    var `proofSchema`: GetProofSchemaListItemBindingDto?,
    var `protocol`: kotlin.String,
    var `transport`: kotlin.String,
    var `redirectUri`: kotlin.String?,
    var `proofInputs`: List<ProofInputBindingDto>,
    var `retainUntilDate`: kotlin.String?,
    var `requestedDate`: kotlin.String?,
    var `completedDate`: kotlin.String?,
    var `claimsRemovedAt`: kotlin.String?
)

Fields

• verifier - ID of verifier's identifier.

• holder - ID of holder's identifier.

• protocol - Verification protocol used to make the request.

• transport - Transport protocol used to transmit proof request.

• proofSchema - Proof schema information.

• state - See the proof request states guides for verifiers and for holders.

  • [CREATED, PENDING, REQUESTED, ACCEPTED, REJECTED, ERROR, RETRACTED]

• redirectUri - When a shared proof is accepted, the holder is redirected to the resource specified here.

• proofInputs - The values submitted by the holder.