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

    Interface VerifiedIdentity

    Represents current state of a verified identity

    interface VerifiedIdentity {
        acceptableDocumentTypes?: IdDocumentType[];
        attemptsRemaining: number;
        canAttemptVerificationAgain: boolean;
        documentVerificationStatus: DocumentVerificationStatus;
        idScanUrl?: string;
        owner: string;
        requiredVerificationMethod?: VerificationMethod;
        verificationLastAttemptedAt: Date;
        verificationMethod: VerificationMethod;
        verified: boolean;
        verifiedAt: Date;
    }
    Index

    Properties

    acceptableDocumentTypes? attemptsRemaining canAttemptVerificationAgain documentVerificationStatus idScanUrl? owner requiredVerificationMethod? verificationLastAttemptedAt verificationMethod verified verifiedAt

    Properties

    acceptableDocumentTypes?: IdDocumentType[]

    If the user is required to submit images of an identity document then this array will be present and contain the set of acceptable document types for this user.

    attemptsRemaining: number

    The number of attempts remaining for the user to verify their identity.

    canAttemptVerificationAgain: boolean

    Whether or not verification can be attempted again

    documentVerificationStatus: DocumentVerificationStatus

    Value indicates state of the document verification process or "notRequired" if no identity document is required to complete verification.

    idScanUrl?: string

    URL to which images are to be submitted to complete verification by document.

    owner: string

    Subject of the user to whom this record pertains

    requiredVerificationMethod?: VerificationMethod

    Method by which user is required to verify in order to be considered verified.

    verificationLastAttemptedAt: Date

    The date and time at which verification was last attempted, whether successful or otherwise.

    verificationMethod: VerificationMethod

    Method by which user is currently verified

    verified: boolean

    Whether or not the user's identity has been verified to the required level

    verifiedAt: Date

    If verified, the date at which the verification occurred

    Settings

    Member Visibility

    On This Page

    Properties