@sudoplatform/sudo-secure-id-verification
    Preparing search index...

    Interface SudoSecureIdVerificationClient

    Client interface for accessing Secure ID Verification service.

    interface SudoSecureIdVerificationClient {
        captureAndVerifyIdentityDocument(
            idDocumentInfo: VerifyIdentityDocumentInput,
        ): Promise<VerifiedIdentity>;
        checkIdentityVerification(): Promise<VerifiedIdentity>;
        getIdentityDataProcessingConsentContent(
            input: IdentityDataProcessingConsentContentInput,
        ): Promise<IdentityDataProcessingConsentContent>;
        getIdentityDataProcessingConsentStatus(): Promise<
            IdentityDataProcessingConsentStatus,
        >;
        initiateIdentityDocumentCapture(): Promise<IdDocumentCaptureInitiationInfo>;
        isConsentRequiredForVerification(): Promise<boolean>;
        isDocumentCaptureInitiationEnabled(): Promise<boolean>;
        isFaceImageRequiredWithDocumentCapture(): Promise<boolean>;
        isFaceImageRequiredWithDocumentVerification(): Promise<boolean>;
        listSupportedCountries(): Promise<string[]>;
        provideIdentityDataProcessingConsent(
            input: IdentityDataProcessingConsentInput,
        ): Promise<IdentityDataProcessingConsentResponse>;
        reset(): Promise<void>;
        setSignInCallback(callback?: SudoPlatformSignInCallback): void;
        verifyIdentity(pii: VerifyIdentityInput): Promise<VerifiedIdentity>;
        verifyIdentityDocument(
            idDocumentInfo: VerifyIdentityDocumentInput,
        ): Promise<VerifiedIdentity>;
        withdrawIdentityDataProcessingConsent(): Promise<
            IdentityDataProcessingConsentResponse,
        >;
    }

    Implemented by

    Index

    Methods

    • Queries the current identity verification status for the signed in user.

      Returns Promise<VerifiedIdentity>

      Verified identity results.

      NotSignedInError

      ServiceError

      UnknownGraphQLError

      FatalError

    • Retrieves the user's current identity data processing consent status.

      Returns Promise<IdentityDataProcessingConsentStatus>

      Consent status for the user.

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Retrieves whether consent is required before identity verification can succeed in the configured service environment.

      Returns Promise<boolean>

      Boolean

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Retrieves whether initiateIdentityDocumentCapture() can be called in the configured service environment.

      Returns Promise<boolean>

      Boolean

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Retrieves whether face images must be provided as part of ID document capture.

      Returns Promise<boolean>

      Boolean

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Retrieves whether face images must be provided as part of ID document verification.

      Returns Promise<boolean>

      Boolean

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Retrieves the list of countries for which secure ID verification is supported in the environment.

      Returns Promise<string[]>

      List of ISO 3166-1 alpha-2 country codes.

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError

    • Resets internal state and clear any cached data.

      Returns Promise<void>

    • Sets an optional callback to handle sign-in when operations are attempted while not signed in.

      When set, all operations (excepting subscriptions and initialization/reset) will check sign-in status before performing their normal behavior. If the client is not signed in, the callback will be invoked to allow the host app to perform sign-in. Once the callback completes, then the client will attempt the original operation that triggered the callback. If the callback throws an error, then the error will be propagated to the caller and the original operation will not be attempted. To clear the callback, call this method with no arguments or undefined.

      Parameters

      • Optionalcallback: SudoPlatformSignInCallback

      Returns void

    • Withdraws the user's identity data processing consent.

      Returns Promise<IdentityDataProcessingConsentResponse>

      Response indicating if the withdrawal was processed.

      NotSignedInError

      UnknownGraphQLError

      ServiceError

      FatalError