Powered by

# VerificationSession

kycdao-mobile - v0.1.0 / VerificationSession

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

# Table of contents

# Properties

  • chainId
  • disclaimerAccepted
  • disclaimerText
  • emailConfirmed
  • hasMembership
  • id
  • loggedIn
  • privacyPolicyURL
  • requiredInformationProvided
  • termsOfServiceURL
  • verificationStatus
  • walletAddress
  • walletSession

# Methods

  • acceptDisclaimer
  • estimatePayment
  • getMembershipCostPerYear
  • getMintingPrice
  • getNFTImages
  • login
  • mint
  • requestMinting
  • resendConfirmationEmail
  • resumeOnEmailConfirmed
  • resumeOnVerificationCompleted
  • setPersonalData
  • startIdentification
  • updateEmail

# Properties

# chainId

• chainId: string

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

# Defined in

Core/VerificationManager.tsx:125

# disclaimerAccepted

• disclaimerAccepted: boolean

Disclaimer acceptance status of the user

# Defined in

Core/VerificationManager.tsx:131

# disclaimerText

• disclaimerText: string

A disclaimer text to show to the users

# Defined in

Core/VerificationManager.tsx:142

# emailConfirmed

• emailConfirmed: boolean

Email confirmation status of the user

# Defined in

Core/VerificationManager.tsx:129

# hasMembership

• hasMembership: boolean

The membership status of the user

For users that are already members, you should skip the membership purchase step

# Defined in

Core/VerificationManager.tsx:140

# id

• id: string

A unique identifier for the session

# Defined in

Core/VerificationManager.tsx:121

# loggedIn

• loggedIn: boolean

The login state of the user in this session

# Defined in

Core/VerificationManager.tsx:127

# privacyPolicyURL

• privacyPolicyURL: string

Privacy policy link to show

# Defined in

Core/VerificationManager.tsx:146

# requiredInformationProvided

• requiredInformationProvided: boolean

Indicates that the user provided every information required to continue with identity verification

# Defined in

Core/VerificationManager.tsx:133

# termsOfServiceURL

• termsOfServiceURL: string

Terms of service link to show

# Defined in

Core/VerificationManager.tsx:144

# verificationStatus

• verificationStatus: VerificationStatus

Verification status of the user

# Defined in

Core/VerificationManager.tsx:135

# walletAddress

• walletAddress: string

Wallet address used to create the session

# Defined in

Core/VerificationManager.tsx:123

# walletSession

• walletSession: BaseWalletSession

A wallet session associated with this VerificationSession

# Defined in

Core/VerificationManager.tsx:148

# Methods

# acceptDisclaimer

▸ acceptDisclaimer(): Promise<void>

Used for signaling that the logged in user accepts kycDAO's disclaimer

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:198

# estimatePayment

▸ estimatePayment(yearsPurchased): Promise<PaymentEstimation>

Use it for estimating membership costs for number of years

# Parameters

Name Type Description
yearsPurchased number Number of years to purchase a membership for

# Returns

Promise<PaymentEstimation>

The payment estimation

# Defined in

Core/VerificationManager.tsx:293

# getMembershipCostPerYear

▸ getMembershipCostPerYear(): Promise<number>

Use it for displaying annual membership cost to the user

# Returns

Promise<number>

The cost of membership per year in USD

# Defined in

Core/VerificationManager.tsx:284

# getMintingPrice

▸ getMintingPrice(): Promise<PriceEstimation>

Use it for estimating minting price, including gas fees and payment for membership

# Returns

Promise<PriceEstimation>

The price estimation

# Defined in

Core/VerificationManager.tsx:304

# getNFTImages

▸ getNFTImages(): Promise<[TokenImage]>

Provides the selectable kycNFT images

# Returns

Promise<[TokenImage]>

A list of image related data

# Defined in

Core/VerificationManager.tsx:276

# login

▸ login(): Promise<void>

Logs in the user to the current session

The user will be redirected to their wallet where they have to sign a session data to login

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:186

# mint

▸ mint(): Promise<MintingResult>

Used for minting the kycNFT

# Returns

Promise<MintingResult>

Successful minting related data

# Defined in

Core/VerificationManager.tsx:327

# requestMinting

▸ requestMinting(selectedImageId, membershipDuration): Promise<void>

Requesting minting authorization for a selected image and membership duration

You can get the list of available images from getNFTImages

# Parameters

Name Type Description
selectedImageId string The id of the image the user selected to mint
membershipDuration number Membership duration to purchase

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:315

# resendConfirmationEmail

▸ resendConfirmationEmail(): Promise<void>

Resends a confirmation email to the user's email address

Initial confirmation email is sent out automatically after setting or updating email address

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:240

# resumeOnEmailConfirmed

▸ resumeOnEmailConfirmed(): Promise<void>

Suspends the current async task and continues execution when email address becomes confirmed.

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:245

# resumeOnVerificationCompleted

▸ resumeOnVerificationCompleted(): Promise<void>

A function which awaits until the user's identity becomes successfuly verified

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:268

# setPersonalData

▸ setPersonalData(personalData): Promise<void>

Used for setting user related personal information.

# Parameters

Name Type Description
personalData PersonalData Contains the personal data needed from the user

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:214

# startIdentification

▸ startIdentification(): Promise<IdentityFlowResult>

Starts the identity verification process, uses Persona

# Returns

Promise<IdentityFlowResult>

The result of the identity verification flow.

# Defined in

Core/VerificationManager.tsx:261

# updateEmail

▸ updateEmail(newEmail): Promise<void>

Updates the email address of the user

# Parameters

Name Type Description
newEmail string New email address

# Returns

Promise<void>

# Defined in

Core/VerificationManager.tsx:227