Skip to main content
A Token resource represents a QRC token tracked by Qustody. The resource is created in DRAFT state, transitions to DEPLOYED once an on-chain contract is associated, and continues to track every subsequent operation. See the full Token object.

POST /v1/tokens

Create a token configuration. This call does not deploy the contract on Quantum Chain — see Deploy token.
AspectDetail
MethodPOST
Path/v1/tokens
AuthenticationBearer API key
Required permissionstokens:create
IdempotencyIdempotency-Key header recommended
Approval policyOptional pre-deploy review (configurable)
Blockchain effectNone — config only
Webhook eventstoken.created

Request body

{
  "standard": "QRC-20",
  "templateId": "tpl_qrc20_v1",
  "name": "Example Institutional Token",
  "symbol": "EIT",
  "decimals": 18,
  "initialSupply": "0",
  "supplyPolicy": {
    "mintable": true,
    "burnable": true,
    "maxSupply": "1000000000000000000000000"
  },
  "admin": {
    "vaultAccountId": "vault_123",
    "approvalPolicyId": "policy_456"
  },
  "network": "quantum-chain-testnet"
}

Response (201)

{
  "id": "token_abc123",
  "standard": "QRC-20",
  "templateId": "tpl_qrc20_v1",
  "name": "Example Institutional Token",
  "symbol": "EIT",
  "decimals": 18,
  "status": "DRAFT",
  "network": "quantum-chain-testnet",
  "adminVaultAccountId": "vault_123",
  "approvalPolicyId": "policy_456",
  "createdAt": "2026-04-27T10:00:00Z"
}

GET /v1/tokens

List tokens. Supports filtering by status, standard, network, and adminVaultAccountId.

GET /v1/tokens/{tokenId}

Fetch a single token by its Qustody ID.

PATCH /v1/tokens/{tokenId}

Update mutable fields on a token in DRAFT state. Once the token has been deployed, only metadata fields (name, description, tags) remain mutable.

Status values

ValueMeaning
DRAFTConfiguration created but not yet deployed.
DEPLOYINGDeployment transaction submitted; awaiting confirmation.
DEPLOYEDContract address confirmed on chain.
PAUSEDToken paused (if the standard supports pause).
RETIREDToken deactivated within Qustody; on-chain state untouched.
FAILEDDeployment failed; see failureReason.

Errors

CodeTypeMeaning
1100VALIDATIONInvalid request body.
1700TOKEN_STANDARD_NOT_SUPPORTEDUnsupported standard.
1701TOKEN_TEMPLATE_NOT_FOUNDUnknown templateId.
1300TX_NOT_FOUNDReferenced approval policy or vault account missing.
1601IDEMPOTENCY_CONFLICTSame Idempotency-Key reused with different body.