Class RevokeTokenKycParams

Transaction Parameters for Revoking KYC status from an account associated with a Token.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

RevokeTokenKycParams

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 RevokeTokenKycParams : TransactionParams<TransactionReceipt>

Examples

Clear a holder's KYC-approved flag; future transfers by or to this holder will fail until KYC is re-granted:

// Clear the KYC-approved flag for a holder. Future transfers by or
// to this holder will be rejected until KYC is re-granted.
var receipt = await client.RevokeTokenKycAsync(token, holder);
Console.WriteLine($"KYC revoke status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the token KYC revocation 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 revocation. 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 revoke the KYC.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId