Vulos Documentation
  • Identity
    • Welcome to the Vulos Identity Documentation!
    • Quick Start
    • Organizations
    • Scopes and Claims
  • Reference
    • Identity JavaScript SDK
      • The Base Package
        • KYC
          • KycStatus
          • KycInstance
          • KycDetails
          • KycApi
        • Profile
          • UserReference
          • ProfileApi
        • Cache
        • Authentication
          • Application
          • BaseAuth
          • User
          • UserInfo
          • BaseApi
        • Organizations
          • Organization
          • OrganizationMembership
            • OrganizationMembershipWithMetadata
          • OrganizationRole
          • OrganizationApi
      • The Backend Auth Package
        • CodeVerifier
        • BackendAuth
      • The Frontend Auth Package
        • IFrameRefresh
        • StateVerifier
        • FrontendAuth
    • Organization API
      • Organizations
      • Memberships
        • Roles
    • Profile API
    • KYC API
Powered by GitBook
On this page
  • Members
  • api : KycApi
  • id : string
  • Methods
  • constructor(api, id)
  • async status()
  1. Reference
  2. Identity JavaScript SDK
  3. The Base Package
  4. KYC

KycInstance

PreviousKycStatusNextKycDetails

Last updated 2 years ago

Members

api :

The KycApi instance that this object was created with.

id : string

The ID of this KYC instance.

Methods

constructor(api, id)

Create a new instance of the KycInstance object.

  • api must be an instance of ;

  • id must be the ID of a KYC Instance;

This constructor should not be called directly, use ApplicationReference.createKycRequest() or ApplicationReference.listKycRequests() instead.

async status()

Get the status of this KYC instance.

const kycStatus = await kycInstance.status()

This function returns a object.

KycApi
KycApi
KycStatus