Enable KYC account flag

Grants KYC to the Hedera accounts for the given Hedera token. This transaction must be signed by the token's KYC Key.
If the provided account is not found, the transaction will resolve to INVALID_ACCOUNT_ID.
If the provided account has been deleted, the transaction will resolve to ACCOUNT_DELETED.
If the provided token is not found, the transaction will resolve to INVALID_TOKEN_ID.
If the provided token has been deleted, the transaction will resolve to TOKEN_WAS_DELETED.
If an Association between the provided token and account is not found, the transaction will resolve to TOKEN_NOT_ASSOCIATED_TO_ACCOUNT.
If no KYC Key is defined, the transaction will resolve to TOKEN_HAS_NO_KYC_KEY.
Once executed the Account is marked as KYC Granted.
Transaction Signing Requirements:
KYC key
Transaction fee payer account key
Constructor
Description
new TokenGrantKycTransaction()
Initializes the TokenGrantKycTransaction object
1
new TokenGrantKycTransaction()
Copied!
Methods
V2
V1
​
Method
Type
Description
Required
setTokenId(<tokenId>)
TokenId
The token for this account to have passed KYC
Required
setAccountId(<accountId>)
AccountId
The account for this token to have passed KYC
Required
Java
1
//Enable KYC flag on account
2
TokenGrantKycTransaction transaction = new TokenGrantKycTransaction()
3
    .setAccountId(accountId)
4
    .setTokenId(tokenId);
5
​
6
//Freeze the unsigned transaction, sign with the kyc private key of the token, submit the transaction to a Hedera network
7
TransactionResponse txResponse = transaction.freezeWith(client).sign(kycKey).execute(client);
8
    
9
//Request the receipt of the transaction
10
TransactionReceipt receipt = txResponse.getReceipt(client);
11
    
12
//Obtain the transaction consensus status
13
Status transactionStatus = receipt.status;
14
​
15
System.out.println("The transaction consensus status is " +transactionStatus);
16
​
17
//v2.0.1
Copied!
JavaScript
1
//Enable KYC flag on account and freeze the transaction for manual signing
2
const transaction = await new TokenGrantKycTransaction()
3
     .setAccountId(accountId)
4
     .setTokenId(tokenId)
5
     .freezeWith(client);
6
​
7
//Sign with the kyc private key of the token
8
const signTx = await transaction.sign(kycKey);
9
​
10
//Submit the transaction to a Hedera network    
11
const txResponse = await signTx.execute(client);
12
​
13
//Request the receipt of the transaction
14
const receipt = await txResponse.getReceipt(client);
15
    
16
//Get the transaction consensus status
17
const transactionStatus = receipt.status;
18
​
19
console.log("The transaction consensus status " +transactionStatus.toString());
20
​
21
//v2.0.5
Copied!
Go
1
//Enable KYC flag on account and freeze the transaction for manual signing
2
transaction, err = hedera.NewTokenGrantKycTransaction().
3
		SetAccountID(accountId).
4
		SetTokenID(tokenId).
5
		FreezeWith(client)
6
​
7
if err != nil {
8
		panic(err)
9
}
10
​
11
//Sign with the kyc private key of the token, submit the transaction to a Hedera network
12
txResponse, err := transaction.Sign(kycKey).Execute(client)
13
		
14
if err != nil {
15
		panic(err)
16
}
17
​
18
//Request the receipt of the transaction
19
receipt, err = txResponse.GetReceipt(client)
20
​
21
if err != nil {
22
		panic(err)
23
}
24
	
25
//Get the transaction consensus status
26
status := receipt.Status
27
​
28
fmt.Printf("The transaction consensus status is %v\n", status)
29
​
30
//v2.1.0
Copied!
Method
Type
Description
Requirement
setTokenId(<tokenId>)
TokenId
The token for this account to have passed KYC
Required
setAccountId(<accountId>)
AccountId
The account for this token to have passed KYC
Required
Java
1
//Enable KYC flag on account
2
TokenGrantKycTransaction transaction = new TokenGrantKycTransaction()
3
    .setTokenId(newTokenId)
4
    .setAccountId(newAccountId);
5
​
6
//Build the unsigned transaction, sign with the kyc private key of the token, submit the transaction to a Hedera network
7
TransactionId transactionId = transaction.build(client).sign(kycKey).execute(client);
8
    
9
//Request the receipt of the transaction
10
TransactionReceipt getReceipt = transactionId.getReceipt(client);
11
    
12
//Obtain the transaction consensus status
13
Status transactionStatus = getReceipt.status;
14
​
15
System.out.println("The transaction consensus status is " +transactionStatus);
16
//Version: 1.2.2
Copied!
JavaScript
1
//Enable KYC flag on account
2
const transaction = new TokenGrantKycTransaction()
3
    .setTokenId(newTokenId)
4
    .setAccountId(newAccountId);
5
​
6
//Build the unsigned transaction, sign with the kyc private key of the token, submit the transaction to a Hedera network
7
const transactionId = await transaction.build(client).sign(kycKey).execute(client);
8
    
9
//Request the receipt of the transaction
10
const getReceipt = await transactionId.getReceipt(client);
11
    
12
//Obtain the transaction consensus status
13
const transactionStatus = getReceipt.status;
14
​
15
console.log("The transaction consensus status is " +transactionStatus);
16
//Version 1.4.2 
Copied!
​
Unfreeze an account
Disable KYC account flag
Last modified 6d ago
Copy link
Contents
Methods