IO Wallet SDK
    Preparing search index...

    Module @pagopa/io-wallet-oid4vci

    OpenID4VCI helpers for IT-Wallet credential issuance flows, including metadata discovery, credential-offer parsing, authorization completion, credential request parsing/verification, credential response creation, and wallet-provider attestation utilities.

    Detailed function documentation is maintained in source JSDoc and surfaced by TypeScript declarations and IDEs.

    pnpm add @pagopa/io-wallet-oid4vci
    

    The package uses callback injection for HTTP, signing, hashing, verification, and encryption so SDK consumers can provide platform-specific implementations.

    Classes

    CreateCredentialResponseError
    CredentialAuthorizationHeaderError
    CredentialOfferError
    FetchCredentialResponseError
    FetchMetadataError
    InvalidDpopProofError
    MissingDpopProofError
    NonceRequestError
    Oid4vciError
    ParseCredentialRequestError
    VerifyCredentialRequestJwtProofError
    VerifyKeyAttestationJwtError
    WalletProvider
    WalletProviderError

    Interfaces

    BaseCredentialRequestOptions
    BaseWalletAttestationOptions
    CompleteAuthorizationOptions
    CreateCredentialResponseOptionsV1_0
    CreateCredentialResponseOptionsV1_3
    CreateCredentialResponseOptionsV1_4
    CreateCredentialResponseResult
    CredentialRequestOptionsV1_0
    CredentialRequestOptionsV1_3
    DeferredFlowOptionsV1_0
    DeferredFlowOptionsV1_3
    ExtractGrantDetailsOptions
    ExtractGrantDetailsOptionsV1_3
    ExtractGrantDetailsOptionsV1_4
    ExtractGrantDetailsResultV1_3
    ExtractGrantDetailsResultV1_4
    FetchCredentialResponseOptions
    FetchMetadataOptions
    ImmediateFlowOptions
    KeyAttestationOptions
    ParseCredentialOfferUriOptions
    ParseCredentialRequestExpectedValues
    ParseCredentialRequestOptions
    ParsedCredentialProof
    ParsedCredentialRequest
    ResolveCredentialOfferOptions
    ResolveCredentialOfferOptionsV1_3
    ResolveCredentialOfferOptionsV1_4
    ValidateCredentialOfferOptions
    ValidateCredentialOfferOptionsV1_3
    ValidateCredentialOfferOptionsV1_4
    VerifyAuthorizationResponseFormPostJWTOptions
    VerifyAuthorizationResponseOptions
    VerifyCredentialRequestJwtProofBaseOptions
    VerifyCredentialRequestJwtProofOptionsV1_0
    VerifyCredentialRequestJwtProofOptionsV1_3
    VerifyCredentialRequestJwtProofResultV1_0
    VerifyCredentialRequestJwtProofResultV1_3
    VerifyKeyAttestationJwtOptions
    VerifyKeyAttestationJwtResult

    Type Aliases

    AuthorizationCodeGrant
    AuthorizationCodeGrantV1_3
    AuthorizationCodeGrantV1_4
    AuthorizationResponse
    CompleteAuthorizationResult
    CreateCredentialResponseOptions
    CreateCredentialResponseResultWithFlow
    CredentialObject
    CredentialOffer
    CredentialOfferGrants
    CredentialOfferGrantsV1_3
    CredentialOfferGrantsV1_4
    CredentialOfferUri
    CredentialOfferV1_3
    CredentialOfferV1_4
    CredentialRequest
    CredentialRequestOptions
    CredentialRequestOptionsV1_4
    CredentialRequestV1_0
    CredentialRequestV1_3
    CredentialResponse
    CredentialResponseEncryption
    CredentialResponseV1_0
    CredentialResponseV1_3
    DeferredCredentialResponseV1_0
    DeferredCredentialResponseV1_3
    ExtractGrantDetailsResult
    FetchStatusListCallback
    ImmediateCredentialResponse
    KeyAttestationHeader
    KeyAttestationPayload
    KeyAttestationStatus
    MetadataResponse
    MetadataResponseV1_0
    MetadataResponseV1_3
    MetadataResponseV1_4
    ProofJwtHeader
    ProofJwtHeaderV1_0
    ProofJwtHeaderV1_3
    ProofJwtPayload
    SendAuthorizationResponseAndExtractCodeOptions
    StatusList
    VerifyCredentialRequestJwtProofOptions
    VerifyCredentialRequestJwtProofOptionsV1_4
    VerifyCredentialRequestJwtProofResult
    VerifyCredentialRequestJwtProofResultV1_4
    WalletAttestationOptions

    Variables

    keyAttestationTypeHeader
    zAuthorizationCodeGrantV1_3
    zAuthorizationCodeGrantV1_4
    zAuthorizationResponse
    zCredentialObject
    zCredentialOfferGrantsV1_3
    zCredentialOfferGrantsV1_4
    zCredentialOfferV1_3
    zCredentialOfferV1_4
    zCredentialRequestV1_0
    zCredentialRequestV1_3
    zCredentialResponseEncryption
    zCredentialResponseV1_0
    zCredentialResponseV1_3
    zDeferredCredentialResponseV1_0
    zDeferredCredentialResponseV1_3
    zImmediateCredentialResponse
    zKeyAttestationAlg
    zKeyAttestationHeader
    zKeyAttestationPayload
    zKeyAttestationStatus
    zKeyAttestationTypeHeader
    zMetadataResponse
    zMetadataResponseV1_0
    zMetadataResponseV1_3
    zMetadataResponseV1_4
    zProofJwtHeaderV1_0
    zProofJwtHeaderV1_3
    zProofJwtPayload
    zStatusList

    Functions

    completeAuthorization
    createCredentialRequest
    createCredentialResponse
    extractGrantDetails
    fetchCredentialResponse
    fetchMetadata
    parseCredentialOfferUri
    parseCredentialRequest
    resolveCredentialOffer
    sendAuthorizationResponseAndExtractCode
    validateCredentialOffer
    verifyAuthorizationResponse
    verifyAuthorizationResponseFormPostJWT
    verifyCredentialRequestJwtProof
    verifyKeyAttestationJwt