Client interface for accessing Secure ID Verification service.

interface SudoSecureIdVerificationClient {
    captureAndVerifyIdentityDocument(
        idDocumentInfo: VerifyIdentityDocumentInput,
    ): Promise<VerifiedIdentity>;
    checkIdentityVerification(
        queryOption?: QueryOption,
    ): Promise<VerifiedIdentity>;
    initiateIdentityDocumentCapture(): Promise<IdDocumentCaptureInitiationInfo>;
    isDocumentCaptureInitiationEnabled(
        queryOption?: QueryOption,
    ): Promise<boolean>;
    isFaceImageRequired(queryOption?: QueryOption): Promise<boolean>;
    listSupportedCountries(queryOption?: QueryOption): Promise<string[]>;
    reset(): Promise<void>;
    verifyIdentity(pii: VerifyIdentityInput): Promise<VerifiedIdentity>;
    verifyIdentityDocument(
        idDocumentInfo: VerifyIdentityDocumentInput,
    ): Promise<VerifiedIdentity>;
}

Implemented by

Methods

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

    Parameters

    • OptionalqueryOption: QueryOption

      Control for using local cache or make a network call

    Returns Promise<VerifiedIdentity>

    Verified identity results.

    NotSignedInError

    ServiceError

    UnknownGraphQLError

    FatalError

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

    Parameters

    Returns Promise<boolean>

    Boolean

    NotSignedInError

    UnknownGraphQLError

    ServiceError

    FatalError

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

    Parameters

    Returns Promise<boolean>

    Boolean

    NotSignedInError

    UnknownGraphQLError

    ServiceError

    FatalError

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

    Parameters

    • OptionalqueryOption: QueryOption

      Control for using local cache or make a network call

    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>

MMNEPVFCICPMFPCPTTAAATR