KYCDao/com.kycdao.android.sdk.verificationSession/VerificationSession

VerificationSession

data class VerificationSession : CustomKoinComponent
Content copied to clipboard

A verification session object which contains session related data and session related operations

Instances should be created by calling the VerificationManager-s createSession function.

Functions

Link copied to clipboard
suspend fun acceptDisclaimer()
Content copied to clipboard

Accepts the disclaimer if the disclaimer hasn't benn accepted before.

Link copied to clipboard
suspend fun estimatePayment(yearsPurchased: Int): PaymentEstimation
Content copied to clipboard

Estimates the price based on how long the user wishes to subscribe.

Link copied to clipboard
open override fun getKoin(): Koin
Content copied to clipboard
Link copied to clipboard
suspend fun getMembershipCostPerYearText(): String
Content copied to clipboard

Returns how much the subscription costs per year in USD.

Link copied to clipboard
suspend fun getMintingPrice(): PriceEstimation
Content copied to clipboard

Creates an estimation for the fee of minting.

Link copied to clipboard
fun getNFTImages(): List<TokenImage>
Content copied to clipboard

Provides the user selectable NFT images

Link copied to clipboard
suspend fun login()
Content copied to clipboard

Logs in the user to the current session The user will be redirected to their wallet, where they will have to sign a session data in order to login

Link copied to clipboard
suspend fun mint(): MintingResult
Content copied to clipboard

Mints the previously chosen NFT image

Link copied to clipboard
suspend fun regenerateNFTImages(): List<TokenImage>
Content copied to clipboard

Regenerates the list of available NFT images

Link copied to clipboard
suspend fun requestMinting(selectedImage: String, membershipDuration: Int?)
Content copied to clipboard

Authorizes the minting process for a selected NFT image Returns after the minting of the selected NFT has been authorized

Link copied to clipboard
suspend fun resendConfirmationEmail()
Content copied to clipboard

Sends a confirmation email to the provided email address if the address in question has not been confirmed previously.

Link copied to clipboard
suspend fun resumeOnEmailConfirmed()
Content copied to clipboard

Starts polling the backend and suspends until the email is confirmed.

Link copied to clipboard
suspend fun resumeOnVerificationCompleted()
Content copied to clipboard

Starts polling the backend and suspends until the identity verification result is available. After a 100 retries it stops with a SuspensionTimeOutException.

Link copied to clipboard
suspend fun setPersonalData(personalData: PersonalData)
Content copied to clipboard

Save the personal information of the user. If the provided email address is not yet confirmed then a confirmation email will be sent.

Link copied to clipboard
suspend fun startIdentification(activity: ComponentActivity): IdentityFlowResult
Content copied to clipboard

Starts the identity verification process.

Link copied to clipboard
suspend fun updateEmail(email: String)
Content copied to clipboard

Calling this function lets you update your email address associated to your account.

Properties

Link copied to clipboard
val chainId: String
Content copied to clipboard

The ID of the chain used specified in CAIP-2 format

Link copied to clipboard
val currentEmail: String?
Content copied to clipboard
Link copied to clipboard
val disclaimerAccepted: Boolean
Content copied to clipboard

Represents whether the disclaimer has been accepted or not.

Link copied to clipboard
val disclaimerText: String
Content copied to clipboard

The contents of the disclaimer that the user is required to accept to use the service. It can be accepted by calling the acceptDisclaimer function.

Link copied to clipboard
val emailConfirmed: Boolean
Content copied to clipboard

Represents whether the email address associated with the session has been confirmed or not.

Link copied to clipboard
val hasMembership: Boolean
Content copied to clipboard
Link copied to clipboard
val id: String
Content copied to clipboard

A unique identifier for this session

Link copied to clipboard
val loggedIn: Boolean
Content copied to clipboard

Whether the user is logged in or not.

Link copied to clipboard
val privacyPolicy: URI
Content copied to clipboard

An URL pointing to the privacy policy document.

Link copied to clipboard
val requiredInformationProvided: Boolean
Content copied to clipboard

A value representing whether all the necessary information has been provided or not. The necessary informations include the following: Both residency information and email address has been provided and we know if the user is a legal entity or not.

Link copied to clipboard
val termsOfService: URI
Content copied to clipboard

An URL pointing to the terms of service document.

Link copied to clipboard
val verificationStatus: VerificationStatus
Content copied to clipboard

The verification status of the user

Link copied to clipboard
val walletAddress: String
Content copied to clipboard

Wallet address used to create the session

Link copied to clipboard
val walletSession: WalletSession
Content copied to clipboard

The wallet session associated with this verification session, used to communicate with a wallet