VerifiedIdentity Structure Reference


                    
                    
                    owner

User ID of the user who provided identity details for verification.

Declaration

Swift

public let owner: String


                    
                    
                    verified

true if the identity was verified successfully.

Declaration

Swift

public let verified: Bool


                    
                    
                    verifiedAt

Date and time at which the identity was verified.

Declaration

Swift

public let verifiedAt: Date?


                    
                    
                    verificationMethod

Verification method used.

Declaration

Swift

public let verificationMethod: VerificationMethod


                    
                    
                    canAttemptVerificationAgain

Indicates whether or not identity verification can be attempted again for this user. Set to false in cases where the maximum number of attempts has been reached or a finding from the identity verification attempt means that it should not proceed.

Declaration

Swift

public let canAttemptVerificationAgain: Bool


                    
                    
                    idScanUrl

URL to upload the scanned documents for identity verification.

Declaration

Swift

public let idScanUrl: String?


                    
                    
                    requiredVerificationMethod

If identity is not verified, indicates required method of verification that the user must go through

Declaration

Swift

public let requiredVerificationMethod: VerificationMethod?


                    
                    
                    acceptableDocumentTypes

Where required verification method is GOVERNMENT_ID, lists the set of acceptable ID document types that can be presented to verify the identity

Declaration

Swift

public let acceptableDocumentTypes: [IdDocumentType]


                    
                    
                    documentVerificationStatus

Indicates the status of verification of submitted ID documents

Declaration

Swift

public let documentVerificationStatus: DocumentVerificationStatus


                    
                    
                    verificationLastAttemptedAt

Date and time when verification was last attempted for this identity.

Declaration

Swift

public let verificationLastAttemptedAt: Date?


                    
                    
                    attemptsRemaining

Number of verification attempts remaining.

Declaration

Swift

public let attemptsRemaining: Int


                    
                    
                    consented

Whether consent has been provided for identity data processing.

Declaration

Swift

public let consented: Bool?


                    
                    
                    init(owner:verified:verifiedAt:verificationMethod:canAttemptVerificationAgain:idScanUrl:requiredVerificationMethod:acceptableDocumentTypes:documentVerificationStatus:verificationLastAttemptedAt:attemptsRemaining:consented:)

Initializes a VerifiedIdentity instance.

Declaration

Swift

public init(
    owner: String,
    verified: Bool,
    verifiedAt: Date? = nil,
    verificationMethod: VerificationMethod,
    canAttemptVerificationAgain: Bool,
    idScanUrl: String? = nil,
    requiredVerificationMethod: VerificationMethod? = nil,
    acceptableDocumentTypes: [IdDocumentType] = [],
    documentVerificationStatus: DocumentVerificationStatus = .notRequired,
    verificationLastAttemptedAt: Date? = nil,
    attemptsRemaining: Int,
    consented: Bool? = nil
)

Parameters

`owner`	User ID of the user who provided identity details for verification.
`verified`	Indicates whether or not the identity has been verified.
`verifiedAt`	Date and time at which the identity was verified.
`verificationMethod`	Verification method used.
`canAttemptVerificationAgain`	Indicates whether or not the user can attempt to verify their identity again.
`idScanUrl`	URL to upload the scanned documents for identity verification.
`requiredVerificationMethod`	Required verification method to use if not verified
`acceptableDocumentTypes`	Array of acceptable ID document types if required verification method is GOVERNMENT_ID
`documentVerificationStatus`	Status of ongoing ID document verification
`verificationLastAttemptedAt`	Date and time when verification was last attempted for this identity.
`attemptsRemaining`	Number of verification attempts remaining.
`consented`	Whether consent has been provided for identity data processing