Skip to main content

Send verification request (v3)

POST 
/v3/config/digital-wallet/openid/sdjwt/verification/send

This endpoint is used to send verification request based on OID4VP specification.

Request​

Body

    requestByReference booleanrequired

    If true, then the Authorization Request must be resolved by a URI and the URI is specified in request_uri query parameter in openid4vp:// wallet invocation link.

    presentationDefinitionId stringrequired

    Identifier for the presentation definition ID

    transactionData object
    property name* any
    urlPrefix string

    The url prefix to be used for authorisation request, default value is openid4vp://?

    individualId string

    The identifier of the individual. If specified, the verifier will send the request directly to the configured individuals device.

    mapperId string

    The mapper identifier of the individual. If specified, the verifier will send the request directly to the configured individuals device.

Responses​

Response Headers
    Schema
      verificationHistory object
      presentationExchangeId stringrequired

      Identifier for the presentation definition

      vpTokenQrCode stringrequired

      Authorization Request defined as per OID4VP draft 20 specification.

      presentationSubmission objectrequired
      presentation_submission objectrequired
      definition_id stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      descriptor_map object[]required
    • Array [
      • format stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      id stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      path stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      path_nested objectrequired
      format stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      id stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

      path stringrequired

      For further reference, please visit: https://identity.foundation/presentation-exchange/#presentation-submission

    • ]
      • id stringrequired
      status stringrequired

      Possible values: [request_sent, request_received, presentation_acked]

      It support 3 presentation request statuses: 1. request_sent: Indicates the presentation request has been sent to the holder. 2. request_received: Indicates the presentation request has been received/scanned by the holder. 3. presentation_acked: Indicates the presentation submission from holder is received by the verifier.

      verified booleanrequired

      Validate signatures as well as the presentation submission against the presentation definition.

      createdAt numberrequired

      Timestamp when the record was created.

      updatedAt numberrequired

      Timestamp when the record was updated.

      presentationDefinitionId stringrequired

      Identifier for the presentation definition

      holder objectrequired

      Contains the metadata describing a holder. For e.g. Name, location, logo e.t.c

      name stringrequired

      Identifier of the holder. For .e.g. DID or Name obtained from client metadata if available.

      walletUnitAttestation string

      Specifies the wallet unit attestation credential.

      walletUnitAttestationPoP string

      Specifies the wallet unit attestation pop credential.

      walletUnitAttestationVerified boolean

      Specifies the wallet unit attestation credential is verified.

      presentation object[]

      The credential being presented to the verifier

      vpTokenResponse string[]required

      The verifiable credential jwt being presented to the verifier

      transactionData object
      property name* any
      transactionDataBase64 string

      The base 64 encoded value of the transaction data.

      presentationValidity object[]

      Specifies comprehensive information about the validity of the presentation

      walletUnitValidity object[]

      Specifies comprehensive information about the validity of the presented wallet unit attestation

      clientIdScheme string

      Possible values: [redirect_uri, did, verifier_attestation, x509_san_dns]

      Defines the client id scheme for the verification

      directPostRedirectUri string

      Defines the redirect uri for the verifier

      responseMode string

      Possible values: [direct_post, direct_post.jwt]

      Defines the response mode to be used for verification

      verifierAttestation string
      individualId string

      The identifier of the individual which the verification request is send to

      mapperId string

      The mapper identifier of the individual which the verification request is send to

    Loading...
    Last updated on