/tokenization/deployCreate Token from Template
Outcome - Deploys a token from a contract template. Pick the standard and the template, then give the template its config. The owner is an address (ownerAddress) or one of your clients (ownerClientId): give exactly one. Send JSON, or multipart/form-data to attach an image. The token comes back with status PENDING; it can be operated once DEPLOYED.
Body Parameters
standardnumber | stringrequiredToken standard, as its number or its name: 1 = ERC20, 2 = ERC3643, 5 = ERC721.
templatestringrequiredTemplate of the standard: erc20-v1 (ERC20), erc721-v1 (ERC721), erc3643-v1 or title-fraction-v1 (ERC3643). Any other pair returns 422.
configobjectrequiredThe template's settings. Each template takes only its own fields, listed below.
Show child parameters (9)
canMintbooleanerc20-v1: requirederc20-v1: allow MINT after creation. A capability set to false can never be used.
canBurnbooleanerc20-v1, erc721-v1: requirederc20-v1 and erc721-v1: allow BURN.
canPausebooleanerc20-v1, erc721-v1: requirederc20-v1 and erc721-v1: allow PAUSE and UNPAUSE.
documentstringmax(20000)erc20-v1 and erc721-v1: legal or descriptive text stored with the token.
identityRegistryAddressstringerc3643-v1, title-fraction-v1: requirederc3643-v1 and title-fraction-v1: your ERC-3643 identity registry. Only addresses verified in it can receive the token.
complianceAddressstringerc3643-v1: requirederc3643-v1: your compliance contract. It must not be bound to another token yet.
onchainIdAddressstringerc3643-v1: the token's own ONCHAINID.
escrowAddressstringtitle-fraction-v1: requiredtitle-fraction-v1: the TradeTrust title escrow that holds the title. It must be active and hold the title.
depositorAddressstringtitle-fraction-v1: requiredtitle-fraction-v1: the title's current beneficiary. The fractions are minted to this address, and it can cancel before fractionalizing.
networkIdnumberrequiredEVM network to deploy on. See Get Token Supported Networks.
namestringrequiredmin(2)max(255)Token name.
symbolstringrequiredmin(2)max(45)Token symbol.
decimalsnumber0 to 18Decimals. ERC20 and ERC3643: required, 0 to 18 (title-fraction-v1: exactly 0). ERC721: not accepted.
initialSupplystringdigits onlyerc20-v1 only: whole tokens minted at creation, digits only. Required above 0 when canMint is false. ERC3643 and ERC721 refuse it: their supply comes from later operations.
ownerAddressstringAddress that will own the contract. Give ownerAddress or ownerClientId.
ownerClientIdstringYour client id (externalId): the client's wallet on this network owns the contract. Give ownerAddress or ownerClientId.
recipientAddressstringerc20-v1: address that receives initialSupply. Defaults to the owner.
payerPublicAddressstringA wallet of this vault on this network that pays the deployment fee, instead of the gas station.
imagefileToken image. Only with multipart/form-data.
idempotencyKeystringYour unique key for this creation. Repeating it returns the first token instead of creating another.
Responses
Response attributes
messagestringSuccess message
dataobjectThe token, with status PENDING until the contract is deployed
Show child attributes (32)
idnumberToken ID. Use it in the token routes (Get Token by ID, Get Token Roles, Token Operations).
networkIdnumberNetwork the contract is deployed on
deployingWalletIdstringID of the vault wallet that sent the deployment
templateVersionstring | nullContract template: erc20-v1, erc721-v1, erc3643-v1 or title-fraction-v1. null for Solana tokens.
namestringToken name
symbolstringToken symbol
decimalsnumberDecimals of the token. Amounts in the API are in whole units with up to this many decimals.
feesstring | nullDeployment fee paid, in the network's coin. null until deployed.
contractAddressstring | nullContract address. null until deployed.
assetIdnumber | nullAsset created for the token once deployed: wallets of this asset hold the token. null until deployed.
vaultIdnumberVault that created the token
internalOwnerTypestring | nullCLIENT when the owner is a client's wallet, MASTER when it is a master wallet of the vault, null when the owner is outside RoxCustody
internalOwnerTargetIdnumber | nullThe RoxCustody client ID when internalOwnerType is CLIENT
ownerAddressstringOwner of the contract (the OWNER role)
recipientAddressstringAddress that received the initial supply (equal to ownerAddress when none was given)
configobjectThe config sent at creation (template settings). Solana and v1 tokens also carry metadataUrl and additional here.
verificationMessagestring | nullThe block explorer's answer to the source-code verification
verificationStatusstringSource-code verification on the block explorer: PENDING, VERIFIED, REJECTED, LimitReached or UNEXPECTED_ERROR
imagestring | nullImage URL, when an image was uploaded
isCollectionbooleantrue for an NFT collection
parentIdnumber | nullFor an NFT, its collection
parentobject | nullFor an NFT, its collection
childrenCountnumberFor a collection, number of NFTs in it
networkobjectThe network
Show child attributes (12)
idnumberNetwork ID
namestringNetwork name
symbolstringSymbol of the network's coin
createdAtstringCreation date
updatedAtstringLast update date
typestringPUBLIC or PRIVATE
statusstringNetwork status, for example ACTIVE
logostringNetwork logo URL
isSwappablebooleanWhether swaps are available on this network
categorystringNetwork family, for example EVM or Solana
chainobjectChain details: id, name, nativeCurrency, rpcUrls, blockExplorers and testnet
addressFormatobjectAddress format: prefixes and lengthRange
createdAtstringCreation date
updatedAtstringLast update date
typestringAsset type of the token: ERC20 for every fungible EVM token (ERC-20 and ERC-3643 alike), NFT_COLLECTION for an ERC-721 collection, TOKEN or NFT on Solana
standardstring | nullToken standard: ERC20, ERC3643, ERC721, SPL_TOKEN or SOLANA_NFT
statusstringDeployment status: PENDING, DEPLOYED, REVERTED, INSUFFICIENT_GAS, ERROR or NONCE_TOO_LOW
tokenExplorerUrlstring | nullLink to the contract on the block explorer. null until deployed.
initialSupplystringSupply minted at creation, in whole units. "0" for ERC-3643 and ERC-721, whose supply comes from later operations.
vaultobjectThe vault that created the token: id, name, category, vaultType, gasStationCategoryId (set when fees are gasless) and its other settings
statusnumberHTTP status code
Was this page helpful?