Class GrantTokenKycParams

Transaction Parameters for Granting KYC status to an account associated with a Token.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

GrantTokenKycParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public sealed class GrantTokenKycParams : TransactionParams<TransactionReceipt>

Examples

Approve a holder for KYC on a KYC-gated token — transfers by or to this holder are rejected until KYC is granted:

// Mark a holder as KYC-approved for this token. Only tokens created
// with a GrantKycEndorsement support KYC gating; on those tokens,
// transfers are rejected until the holder's KYC flag is granted.
var receipt = await client.GrantTokenKycAsync(token, holder);
Console.WriteLine($"KYC grant status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the token KYC granting submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Holder

The identifier of the account associated or holding the tokens.

Declaration

public EntityId Holder { get; set; }

Property Value

Type	Description
EntityId

Signatory

Additional private key, keys or signing callback method required to authorize the KYC grant. Typically matches the Endorsement assigned to the KYC key for the token if it is not already set as the payer for the transaction.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

Keys/callbacks added here will be combined with those already identified in the client object's context when signing this transaction to change the state of this account.

Token

The identifier of the Fungible or NFT Token Class to grant KYC.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId