Kyc

Asset Tokenization Studio Team

Kyc

Manages internal KYC records and exposes paginated KYC status queries.

Implements IKyc and delegates persistent state to KycStorageWrapper. Mutating operations require the token to be operational, activated and unpaused, except initialisation, which is restricted to an unregistered facet. Time-dependent status checks use TimeTravelStorageWrapper as the canonical timestamp source.

Methods

activateInternalKyc

function activateInternalKyc() external nonpayable returns (bool success_)

Activates internal KYC enforcement for the token.

Returns

Name	Type	Description
success_	bool	True when the call succeeds without reverting.

deactivateInternalKyc

function deactivateInternalKyc() external nonpayable returns (bool success_)

Deactivates internal KYC enforcement for the token.

Returns

Name	Type	Description
success_	bool	True when the call succeeds without reverting.

getKycAccountsCount

function getKycAccountsCount(enum IKyc.KycStatus _kycStatus) external view returns (uint256 kycAccountsCount_)

Returns the number of accounts with a given KYC status.

Parameters

Name	Type	Description
_kycStatus	enum IKyc.KycStatus	The status to filter by: GRANTED or NOT_GRANTED.

Returns

Name	Type	Description
kycAccountsCount_	uint256	The count of accounts matching the given status.

getKycAccountsData

function getKycAccountsData(enum IKyc.KycStatus _kycStatus, uint256 _pageIndex, uint256 _pageLength) external view returns (address[] accounts_, struct IKyc.KycData[] kycData_)

Returns a paginated list of accounts and their KYC data for a given KYC status.

Parameters

Name	Type	Description
_kycStatus	enum IKyc.KycStatus	The status to filter by: GRANTED or NOT_GRANTED.
_pageIndex	uint256	Zero-based page index; skips _pageIndex * _pageLength entries.
_pageLength	uint256	Maximum number of entries to return per page.

Returns

Name	Type	Description
accounts_	address[]	The accounts matching the given KYC status in the requested page.
kycData_	IKyc.KycData[]	The KYC data records corresponding to each account in accounts_.

getKycFor

function getKycFor(address _account) external view returns (struct IKyc.KycData kyc_)

Returns all KYC metadata recorded for an account.

Parameters

Name	Type	Description
_account	address	The account to query.

Returns

Name	Type	Description
kyc_	IKyc.KycData	The full KycData struct for that account.

getKycStatusFor

function getKycStatusFor(address _account) external view returns (enum IKyc.KycStatus kycStatus_)

Returns the current KYC status for an account.

Parameters

Name	Type	Description
_account	address	The account to check.

Returns

Name	Type	Description
kycStatus_	enum IKyc.KycStatus	GRANTED or NOT_GRANTED.

grantKyc

function grantKyc(address _account, string _vcId, uint256 _validFrom, uint256 _validTo, address _issuer) external nonpayable returns (bool success_)

Grants KYC to an account with the supplied verifiable-credential metadata.

Parameters

Name	Type	Description
_account	address	User whose KYC is being granted.
_vcId	string	Verifiable-credential identifier issued by the issuer.
_validFrom	uint256	Start timestamp of the KYC validity period.
_validTo	uint256	End timestamp of the KYC validity period.
_issuer	address	Address of the entity issuing the KYC.

Returns

Name	Type	Description
success_	bool	True when the grant succeeds without reverting.

initializeInternalKyc

function initializeInternalKyc(bool _internalKycActivated) external nonpayable

Initialises the internal KYC capability on the token.

Parameters

Name	Type	Description
_internalKycActivated	bool	undefined

isInternalKycActivated

function isInternalKycActivated() external view returns (bool)

Returns whether internal KYC enforcement is currently active.

Returns

Name	Type	Description
_0	bool	True if internal KYC is activated, false otherwise.

revokeKyc

function revokeKyc(address _account) external nonpayable returns (bool success_)

Revokes the KYC previously granted to an account.

Parameters

Name	Type	Description
_account	address	User whose KYC is being revoked.

Returns

Name	Type	Description
success_	bool	True when the revocation succeeds without reverting.

Events

InternalKycStatusUpdated

event InternalKycStatusUpdated(address indexed operator, bool activated)

Emitted when the internal KYC enforcement status is toggled.

Parameters

Name	Type	Description
operator indexed	address	The address that triggered the status update.
activated	bool	The new activation state of the internal KYC.

KycGranted

event KycGranted(address indexed account, address indexed issuer)

Emitted when KYC is granted to an account.

Parameters

Name	Type	Description
account indexed	address	The address for which the KYC is granted.
issuer indexed	address	The address of the issuer of the KYC.

KycInitialized

event KycInitialized(bool internalKycActivated)

Emitted once when the KYC capability is initialised on a token.

Fires exclusively from initializeInternalKyc after the storage write succeeds.

Parameters

Name	Type	Description
internalKycActivated	bool	Whether internal KYC enforcement was enabled at initialisation.

KycRevoked

event KycRevoked(address indexed account, address indexed issuer)

Emitted when KYC is revoked from an account.

Parameters

Name	Type	Description
account indexed	address	The address for which the KYC is revoked.
issuer indexed	address	The address of the issuer revoking the KYC.

Errors

AccountHasNoRole

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters

Name	Type	Description
account	address	The account that lacks the role.
role	bytes32	The role that is not held.

AccountIsNotIssuer

error AccountIsNotIssuer(address issuer)

Thrown when an address is required to be a listed issuer but is not.

Parameters

Name	Type	Description
issuer	address	The address that failed the issuer membership check.

AssetNotOperational

error AssetNotOperational(bytes32 configId, uint256 versionId)

Raised by InitializerStorageWrapper.checkOperational (and the related isConfigVersionOperational helper) when an operation is attempted on a configuration version that has not yet been marked operational.

Parameters

Name	Type	Description
configId	bytes32	Resolver-proxy configuration whose operational status was checked.
versionId	uint256	Configuration version whose operational status was checked.

Deactivated

error Deactivated()

Thrown when an operation guarded by onlyActivated is attempted on a token whose deactivation flag has already been set.

FacetAlreadyRegistered

error FacetAlreadyRegistered(bytes32 facetId, uint256 lastVersion)

Raised when an initialiser tries to register a facet that already has a non-zero last registered version (i.e. the facet is being re-initialised on a fresh install).

Parameters

Name	Type	Description
facetId	bytes32	Identifier of the offending facet.
lastVersion	uint256	Last version recorded for that facet at the time of the check.

InvalidDates

error InvalidDates()

Reverts when a date set is invalid.

Used when the failing date constraint does not require exposing values.

InvalidKycStatus

error InvalidKycStatus()

InvalidZeroAddress

error InvalidZeroAddress()

IsPaused

error IsPaused()

Thrown when an operation that requires the token to be unpaused is attempted while the token is paused (own flag or any external pause contract).

KycIsNotGranted

error KycIsNotGranted()

UnrecognizedResolverProxyVersion

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters

Name	Type	Description
_resolverProxyVersion	bytes8	proxy version that is not compatible with the BLR.

WalletRecovered

error WalletRecovered()

Thrown when attempting to recover a wallet that has already been recovered.

ZeroAddressNotAllowed

error ZeroAddressNotAllowed()

Reverts when the zero address is supplied where it is not permitted.

Prevents invalid account, contract, or recipient references.