Hedera
Search…
⌃K
Links

Create an account

Create an account using the account create API

A transaction that creates a Hedera account. A Hedera account is required to interact with any of the Hedera network services as you need an account to pay for all associated transaction/query fees. You can visit the Hedera Developer Portal to create a previewnet or testnet account. You can also use third-party wallets to generate free mainnet accounts. To process an account create transaction, you will need an existing account to pay for the transaction fee. To obtain the new account ID, request the receipt of the transaction.
When creating a new account using theAccountCreateTransaction()API you will need an existing account to pay for the associated transaction fee.
Transaction Fees
  • Please see the transaction and query fees table for the base transaction fee
  • Please use the Hedera fee estimator to estimate your transaction fee cost
Transaction Signing Requirements
  • The account paying for the transaction fee is required to sign the transaction
Transaction Properties
Field
Description
Key
The key for the new account.
Initial Balance
The initial balance of the account was transferred from the operator account, in HBAR.
Receiver Signature Required
If true, all the account keys must sign any transaction deposited into this account (in addition to all withdrawals).
default: false
Max Automatic Token Associations
Accounts can optionally automatically associate tokens to this account if this property is set. You do not need to associate a token prior to transferring it to this account. The max automatic token association is 1,000 token IDs.
Update: There is no limit on how many tokens you can associate in the 0.25 mainnet release. Currently, live on previewnet and testnet Reference HIP-23 and HIP-367.
Staked ID
The staked ID is the node ID this account is staking to or the account ID of the account this account is staking to. An account can be staked to only one node or one account at a time. See HIP-406. Note: Accounts cannot stake to contract accounts. This will fixed in a future release.
Decline Rewards
Some accounts may stake to a node and decline to earn rewards. If set to true, the account will not receive staking rewards. The default value is false. See HIP-406.​
Memo
Set a note or description that should be recorded with the state of the account entity (maximum length of 100 characters). Anyone can view this memo on the network.
Auto Renew Period
The period of time in which the account will auto-renew in seconds. The account is charged tinybars for every auto-renew period. Duration type is in seconds. For example, one hour would result in an input value of 3,600 seconds. NOTE: This is fixed to approximately 3 months (7890000 seconds). Any other value will return the following error: AUTORENEW_DURATION_NOT_IN_RANGE.
default: 2,592,000 seconds (DISABLED)
Constructor
Description
new AccountCreateTransaction()
Initializes the AccountCreateTransaction object
new AccountCreateTransaction()

Methods

Method
Type
Requirement
setKey(<key>)
Key
Required
setInitialBalance(<initialBalance>)
HBar
Optional
setReceiverSignatureRequired(<booleanValue>)
boolean
Optional
setMaxAutomaticTokenAssociations(<amount>)
int
Optional
setStakedAccountId(<stakedAccountId>)
AccountId
Optional
setStakedNodeId(<stakedNodeId>)
long
Optional
setDeclineStakingReward(<declineStakingReward>)
boolean
Optional
setAccountMemo(<memo>)
String
Optional
setAutoRenewPeriod(<autoRenewPeriod>)
Duration
Disabled
Java
JavaScript
Go
//Create the transaction
AccountCreateTransaction transaction = new AccountCreateTransaction()
.setKey(privateKey.getPublicKey())
.setInitialBalance(new Hbar(1000));
​
//Submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.execute(client);
​
//Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);
​
//Get the account ID
AccountId newAccountId = receipt.accountId;
​
System.out.println("The new account ID is " +newAccountId);
​
//Version 2.0.0
//Create the transaction
const transaction = new AccountCreateTransaction()
.setKey(privateKey.publicKey)
.setInitialBalance(new Hbar(1000));
​
//Sign the transaction with the client operator private key and submit to a Hedera network
const txResponse = await transaction.execute(client);
​
//Request the receipt of the transaction
const receipt = await txResponse.getReceipt(client);
​
//Get the account ID
const newAccountId = receipt.accountId;
​
console.log("The new account ID is " +newAccountId);
​
//v2.0.5
//Create the transaction
transaction := hedera.NewAccountCreateTransaction().
SetKey(privateKey.PublicKey()).
SetInitialBalance(hedera.NewHbar(1000))
​
//Sign the transaction with the client operator private key and submit to a Hedera network
txResponse, err := AccountCreateTransaction.Execute(client)
if err != nil {
panic(err)
}
​
//Request the receipt of the transaction
receipt, err := txResponse.GetReceipt(client)
if err != nil {
panic(err)
}
​
//Get the account ID
newAccountId := *receipt.AccountID
​
fmt.Printf("The new account ID is %v\n", newAccountId)
​
//Version 2.0.0

Get transaction values

Method
Type
Description
getKey()
Key
Returns the public key on the account
getInitialBalance()
Hbar
Returns the initial balance of the account
getAutoRenewPeriod()
Duration
Returns the auto renew period on the account
getDeclineStakingReward()
boolean
Returns whether or not the account declined rewards
getStakedNodeId()
long
Returns the node ID
getStakedAccountId()
AccountId
Returns the node account ID
getReceiverSignatureRequired()
boolean
Returns whether the receiver signature is required or not
Java
JavaScript
Go
//Create an account with 1,000 hbar
AccountCreateTransaction transaction = new AccountCreateTransaction()
// The only _required_ property here is `key`
.setKey(newKey.getPublicKey())
.setInitialBalance(new Hbar(1000));
​
//Return the key on the account
Key accountKey = transaction.getKey();
//Create an account with 1,000 hbar
const transaction = new AccountCreateTransaction()
// The only _required_ property here is `key`
.setKey(newKey.getPublicKey())
.setInitialBalance(new Hbar(1000));
​
//Return the key on the account
const accountKey = transaction.getKey();
//Create an account with 1,000 hbar
AccountCreateTransaction := hedera.NewAccountCreateTransaction().
SetKey(newKey.PublicKey()).
SetInitialBalance(hedera.NewHbar(1000))
​
//Return the key on the account
accountKey, err := AccountCreateTransaction.GetKey()

Create an account via an account alias

Since the introduction of HIP-32, you can create an account via an account alias. An account alias is a single public key address that is used to create the Hedera account. Hedera supports aliases generated using ED25519 or ECDSA (secp256k1) algorithms.
Wallet software can allow the user to create an "account" instantly, for free, even without an internet connection. In this case, it will not create an actual account on Hedera. Instead, it will simply create a public/private key pair for the user. The software will then display this as an "account" with a zero balance, with a "long account ID". This long-form doesn't look like 0.0.123, but instead is an alias consisting of <shard>.<realm>.<bytes>, where the bytes is a base32url representation of the bytes of a serialized HAPI primitive Key, with the trailing = padding characters removed. For example, 0.0.CIQNOWUYAGBLCCVX2VF75U6JMQDTUDXBOLZ5VJRDEWXQEGTI64DVCGQ is the alias address of shard 0 realm 0 with the serialization of a HAPI Key for the ed25519 public key 0xd75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a.
The account alias is immutable, cannot be modified, and it will continue to be associated with that account for as long as it exists. Still, if the account is deleted and removed from Hedera, the alias can be associated with a new account.
The account is officially registered with Hedera when HBARs, fungible or non-fungible tokens are initially deposited to the account alias. The fee to create the accounts is charged in the transaction fee of the transfer transaction used to send the token to the account alias. The account creation transaction is executed first to register the new account and following the transfer transaction to transfer the tokens to the new account.
The consensus timestamp for the create account transaction is one nanosecond before the transfer transaction. The parent transfer transaction and the child account create transaction share the same payer account and timestamp in the transaction ID except that the child transaction has an added nonce value. You will also notice the account and transaction memo set to auto-created account indicating this account was created by using an account alias.
You can return the new account ID in one of the following ways:
  • Requesting the child records of the parent transfer transaction using the parent transfer transaction ID. The child transaction ID in the child transaction record will display a nonce value ([email protected]/1).
  • Requesting the child receipts of the parent transfer transaction using the parent transfer transaction ID. The account ID field will be populated with the new account ID.
  • Requesting the receipt or record of the account create transaction by using the transaction ID of the parent transfer transaction and setting the nonce value to 1
  • Requesting account info using the account alias
  • Looking at the parent transfer transaction record transfer list for the account that has a transfer that equals the transfer value minus the transaction fee
Note: You cannot get the new account ID from the receipt of the transfer transaction like you would expect from a normal account to create a transaction that was not triggered by another transaction. You can use the alias in transfer transactions, account info, and balance queries. The feature will be enabled to support all other transactions and queries in a future release.
Follow the steps below to create an account using an account alias:
  • Create an ED25519 or ECDSA (secp256k1) key pair
    • The public key will be the account alias
    • The private key of the key pair you created will be the private key associated with the new Hedera account that will be created in the following step
  • Convert the public key (account alias) to a Hedera account ID format (0.0.publicKey)
  • Use the TransferTransaction and transfer HBARs, fungible, or your non-fungible token to the public key address in the Hedera account ID format
    • The transfer will trigger an AccountCreateTransaction and create the Hedera account for you
    • Following the transaction that creates your account, the tokens will be transferred to that account
  • Get the new Hedera account ID (0.0.accountNum) by requesting the child record, child receipt, or account info (see above)
Transaction Signing Requirements
  • The account key paying for the transfer transaction fee
Reference HIPs