Type alias VerifierBase

Type declaration

• Readonly close: (() => Promise<Result<void, CloseVerifierError>>)

  • • (): Promise<Result<void, CloseVerifierError>>

    • Closes the verifier

      Returns Promise<Result<void, CloseVerifierError>>

      A promise that resolves to a Result containing void on ok or a CloseVerifierError on error.

      Remarks

      Verifier instance will not function after it is closed.

• Readonly compact: {
      getCacheExpiry: (() => Promise<Date | undefined>);
      refreshCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>);
      refreshIssuerCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>);
      refreshRevocationCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>);
      verify: ((options) => Promise<Result<VerifyCompactCredentialResult, VerifyCompactCredentialError>>);
  }

  • Readonly getCacheExpiry: (() => Promise<Date | undefined>)

    • • (): Promise<Date | undefined>

      • Returns the cache item with the most-soon-to-expire expiry date.

        Returns Promise<Date | undefined>

  • Readonly refreshCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>

      • Refreshes all cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>

  • Readonly refreshIssuerCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>

      • Refreshes only issuer cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>

  • Readonly refreshRevocationCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>

      • Refreshes only revocation cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>

  • Readonly verify: ((options) => Promise<Result<VerifyCompactCredentialResult, VerifyCompactCredentialError>>)

    • • (options): Promise<Result<VerifyCompactCredentialResult, VerifyCompactCredentialError>>

      • Verifies a Compact Credential.

        Parameters

        • options: VerifyCompactCredentialOptions

          VerifyCompactCredentialOptions containing a credential payload to verify and a mapping config for property transformation.

        Returns Promise<Result<VerifyCompactCredentialResult, VerifyCompactCredentialError>>

        A promise that resolves to a Result containing VerifyCompactCredentialResult on ok or a VerifyCompactCredentialError on error.

• Readonly compactSemantic: {
      getCacheExpiry: (() => Promise<Date | undefined>);
      refreshCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>);
      refreshIssuerCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>);
      refreshRevocationCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>);
      verify: ((options) => Promise<Result<VerifyCompactSemanticCredentialResult, VerifyCompactCredentialError>>);
  }

  • Readonly getCacheExpiry: (() => Promise<Date | undefined>)

    • • (): Promise<Date | undefined>

      • Returns the cache item with the most-soon-to-expire expiry date.

        Returns Promise<Date | undefined>

  • Readonly refreshCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>

      • Refreshes all cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError | RevocationListResolverError>>>

  • Readonly refreshIssuerCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>

      • Refreshes only issuer cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<IssuerResolverError>>>

  • Readonly refreshRevocationCache: (() => Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>)

    • • (): Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>

      • Refreshes only revocation cached items.

        Returns Promise<Result<RefreshCacheSuccess, RefreshCacheError<RevocationListResolverError>>>

  • Readonly verify: ((options) => Promise<Result<VerifyCompactSemanticCredentialResult, VerifyCompactCredentialError>>)

    • • (options): Promise<Result<VerifyCompactSemanticCredentialResult, VerifyCompactCredentialError>>

      • Verifies a credential.

        Parameters

        • options: VerifyCompactCredentialOptions

          VerifyCompactCredentialOptions containing a credential payload to verify and a mapping config for property transformation.

        Returns Promise<Result<VerifyCompactSemanticCredentialResult, VerifyCompactCredentialError>>

        A promise that resolves to a Result containing VerifyCompactCredentialResult on ok or a VerifyCompactCredentialError on error.

• Readonly ecosystem: Omit<EcosystemService, "initialise">

• Readonly isOpen: (() => boolean)

  • • (): boolean

    • Indicates if the verifier is open.

      Returns boolean

• Readonly mobile: {
      addTrustedIssuerCertificates: ((certificates) => Promise<Result<string[], AddTrustedIssuerCertificatesError>>);
      createProximityPresentationSession: ((options) => Promise<Result<void, CreateProximityPresentationSessionError>>);
      deleteTrustedIssuerCertificate: ((certificateId) => Promise<void>);
      getTrustedIssuerCertificates: (() => Promise<TrustedIssuerCertificate[]>);
      sendProximityPresentationRequest: ((options) => Promise<Result<MobileCredentialResponse, SendProximityPresentationRequestError>>);
      terminateProximityPresentationSession: (() => Promise<void>);
  }

  • addTrustedIssuerCertificates: ((certificates) => Promise<Result<string[], AddTrustedIssuerCertificatesError>>)

    • • (certificates): Promise<Result<string[], AddTrustedIssuerCertificatesError>>

      • Add a trusted issuer certificate to storage.

        Issuer certificates are used to verify Mobile Credentials when added to storage. This function validates the certificate in accordance with the IACA profile defined in 18013-5 with the additional constraint of requiring the certificate to be self signed. The operation is idempotent, meaning repeated calls to add the same issuer certificates do not result in duplicates, as the ID's of the existing certificates as stored by the SDK are returned.

        Parameters

        • certificates: readonly string[]

          the list of trusted issuer certificates in pem encoded string format.

        Returns Promise<Result<string[], AddTrustedIssuerCertificatesError>>

        A promise that resolves to an array of IDs for the added certificates on ok or AddTrustedIssuerCertificatesError on error.

  • createProximityPresentationSession: ((options) => Promise<Result<void, CreateProximityPresentationSessionError>>)

    • • (options): Promise<Result<void, CreateProximityPresentationSessionError>>

      • Creates a proximity based presentation session with a Mobile Credential holder using ISO 18013-5 based DeviceRetrieval.

        Parameters

        • options: CreateProximityPresentationSessionOptions

          CreateProximityPresentationSessionOptions containing a callback function for each event.

        Returns Promise<Result<void, CreateProximityPresentationSessionError>>

        A promise that resolves to void on ok or CreateProximityPresentationSessionError on error.

  • deleteTrustedIssuerCertificate: ((certificateId) => Promise<void>)

    • • (certificateId): Promise<void>

      • Deletes a trusted issuer certificate from storage.

        This operation is idempotent, meaning calls to this function for issuer certificates that do not exist will not return an error.

        Parameters

        • certificateId: string

          the ID of the trusted issuer certificate to delete.

        Returns Promise<void>

  • getTrustedIssuerCertificates: (() => Promise<TrustedIssuerCertificate[]>)

    • • (): Promise<TrustedIssuerCertificate[]>

      • Retrieves all trusted issuer certificates from storage.

        Returns Promise<TrustedIssuerCertificate[]>

        A promise that resolves to an array of TrustedIssuerCertificate.

  • sendProximityPresentationRequest: ((options) => Promise<Result<MobileCredentialResponse, SendProximityPresentationRequestError>>)

    • • (options): Promise<Result<MobileCredentialResponse, SendProximityPresentationRequestError>>

      • This function uses the requested Mobile Credentials to construct and send a request to the holder. Once the request had been sent, a response is awaited. According to ISO 18013-5 specification, if no response is received after 300 seconds the request will timeout.

        Parameters

        • options: SendProximityPresentationRequestOptions

          SendProximityPresentationRequestOptions represents a request for presentation of Mobile Credentials.

        Returns Promise<Result<MobileCredentialResponse, SendProximityPresentationRequestError>>

        A promise that resolves to MobileCredentialResponse on ok or SendProximityPresentationRequestError on error.

  • terminateProximityPresentationSession: (() => Promise<void>)

    • • (): Promise<void>

      • Terminates a proximity based presentation session with a Mobile Credential holder using ISO 18013-5 based DeviceRetrieval.

        Returns Promise<void>

        A promise that resolves to void