# Tokeny - Documentation Documentation
> Tokeny Documentation - Upgrade to Onchain Finance - Issue, manage, and distribute assets on blockchain while ensuring compliance.
## Guides
- [What is Onchain Finance](https://docs.tokeny.com/docs/what-is-onchain-finance.md)
- [The Onchain Finance OS](https://docs.tokeny.com/docs/who-is-tokeny.md): The Enterprise-grade Onchain Finance Enabler
- [Industry Case Studies](https://docs.tokeny.com/docs/industry-case-studies.md)
- [Solutions Overview](https://docs.tokeny.com/docs/solutions-overview-1.md): Discover the most advanced tokenization platform
- [Glossary](https://docs.tokeny.com/docs/glossary.md)
- [Overview](https://docs.tokeny.com/docs/t-rex-platform.md): The Turnkey White-Label Platform for Digital Asset Marketplaces
- [Servicing App](https://docs.tokeny.com/docs/servicing-app.md): Issue, Manage and Distribute Tokenized Assets
- [Investor App](https://docs.tokeny.com/docs/investor-app.md): An all-in-one app for your investors to Discover, Subscribe, Manage Tokens.
- [What Networks Do We Support?](https://docs.tokeny.com/docs/what-networks-do-we-support.md)
- [What Wallets Do We Support?](https://docs.tokeny.com/docs/supported-wallets.md)
- [Connected Wallets](https://docs.tokeny.com/docs/connected-wallets.md)
- [Integrated Non-custodial wallets](https://docs.tokeny.com/docs/integrated-non-custodial-wallets.md)
- [Onboard Investors](https://docs.tokeny.com/docs/onboard-investors.md)
- [Qualify Investors](https://docs.tokeny.com/docs/qualify-investors.md)
- [Manage Subscriptions Orders ](https://docs.tokeny.com/docs/subscriptions-2.md)
- [Subscription Order Calculation Handbook](https://docs.tokeny.com/docs/subscription-order-calculation-handbook.md): This article provides an overview of how investment calculations are handled when a user enters different input values: Token Amount (T), Net Investment Amount (IA), or Amount to Pay (AP). It outlines the formulas, fee calculations, and rounding rules for each scenario.
- [Manage Redemptions Orders](https://docs.tokeny.com/docs/redemptions-2.md)
- [Redemption Order Calculation Handbook](https://docs.tokeny.com/docs/redemption-order-calculation-handbook.md): This article outlines the calculation methodology for redeeming tokens in an Open-ended scenario. It provides a formula for determining the estimated amount received after redemption, including rounding rules and exchange rate considerations.
- [Fees](https://docs.tokeny.com/docs/fee-inputs-and-schema.md): Our platform introduces an Enhanced Subscription Model, which integrates advanced investor input options and diversified fee structures. This feature is designed to offer issuers and investors a more tailored and efficient investment experience. In this article we will outline both the types of investor inputs and fee schemaβs we can accommodate.
- [Operate Your Secondary Market](https://docs.tokeny.com/docs/secondary-market-1.md)
- [Billboard](https://docs.tokeny.com/docs/secondary-market-copy.md)
- [Being listed on Centralized Exchanges](https://docs.tokeny.com/docs/secondary-market-copy-1.md)
- [Token Actions](https://docs.tokeny.com/docs/token-actions.md)
- [Position Reports](https://docs.tokeny.com/docs/create-position-reports.md)
- [What Types Of Transfers Do We Support?](https://docs.tokeny.com/docs/transfer-types-1.md)
- [Overview](https://docs.tokeny.com/docs/general-info-copy.md): Leverage the onchain operating system through APIs
- [Getting started](https://docs.tokeny.com/docs/t-rex-engine-overview.md)
- [Getting API access](https://docs.tokeny.com/docs/getting-api-access-1.md)
- [Getting the token_id](https://docs.tokeny.com/docs/getting-the-token_id.md)
- [Manage validation errors in the body of requests](https://docs.tokeny.com/docs/managing-errors.md)
- [Manage headers](https://docs.tokeny.com/docs/manage-headers.md)
- [Entities in the APIs](https://docs.tokeny.com/docs/entities-in-the-apis.md)
- [Single Sign-On (SSO)](https://docs.tokeny.com/docs/single-sign-on-sso.md)
- [Assets API](https://docs.tokeny.com/docs/assets-apis-copy.md): Get familiar with Tokeny's T-REX Engine Assets API - your Tokenisation Engine entrypoint
- [Issue Tokens](https://docs.tokeny.com/docs/tokenize-assets.md): Learn how to create and deploy your ERC-3643
- [Creator: Token deployment and configuration](https://docs.tokeny.com/docs/token-deployment-and-config.md)
- [Deploy tokens with the same address across different networks](https://docs.tokeny.com/docs/deploy-tokens-with-the-same-address-across-different-networks.md)
- [Owner: Configure token compliance](https://docs.tokeny.com/docs/owner-configure-token-compliance.md)
- [Manage Tokens](https://docs.tokeny.com/docs/tokens-management.md): Manage the lifecycle of your ERC-3643
- [Enrich Tokens Data](https://docs.tokeny.com/docs/enrich-tokens-data.md): Provide data for your deployed tokens
- [Investor: Token allowances](https://docs.tokeny.com/docs/token-allowances-1.md)
- [Investor: Direct transfer](https://docs.tokeny.com/docs/direct-transfer.md)
- [Investor: Swap tokens](https://docs.tokeny.com/docs/swap-tokens.md)
- [Agent: Manage Token actions](https://docs.tokeny.com/docs/token-actions-1.md)
- [Distribution API](https://docs.tokeny.com/docs/distribution-apis-copy.md): Unlocking distribution for tokenised assets
- [Catalog of Assets](https://docs.tokeny.com/docs/catalog-api.md): Building the largest catalog of tokenized assets
- [Retrieve Tokens Catalog](https://docs.tokeny.com/docs/retrieve-tokens-catalog.md)
- [Primary Market](https://docs.tokeny.com/docs/primary-market-api.md): Set up Subscription and Redemption for your token
- [Subscriptions endpoints](https://docs.tokeny.com/docs/subscription-endpoints.md)
- [Configuring Subscriptions](https://docs.tokeny.com/docs/configuring-subscriptions.md)
- [Managing the Net Asset Value (NAV)](https://docs.tokeny.com/docs/how-to-manage-the-net-asset-value-nav.md)
- [Managing the token Price of a close-ended subscription](https://docs.tokeny.com/docs/managing-the-token-price.md)
- [Agent: Managing open-ended subscriptions orders](https://docs.tokeny.com/docs/agent-managing-open-ended-subscriptions-orders.md)
- [Agent: Managing close-ended subscriptions orders](https://docs.tokeny.com/docs/agent-managing-close-ended-subscriptions-orders.md)
- [Agent: Managing open-ended Redemption orders](https://docs.tokeny.com/docs/agent-managing-open-ended-redemption-orders.md)
- [Secondary Market](https://docs.tokeny.com/docs/secondary-market.md): Set up the secondary market for your tokens
- [Identities API](https://docs.tokeny.com/docs/identities-apis-copy.md): Your entry point for all things related to onchain user management
- [Qualifying investors](https://docs.tokeny.com/docs/qualify-new-investors.md)
- [How to create an account and verify a wallet](https://docs.tokeny.com/docs/how-to-create-and-verify-a-wallet.md)
- [Onchain Identities](https://docs.tokeny.com/docs/onchain-identities-1.md): Manage onchain identities through the ONCHAINID open source protocol
- [Wallets Management](https://docs.tokeny.com/docs/wallets-management.md): Learn how to manage wallets linked to Identities
- [Portfolio Management](https://docs.tokeny.com/docs/portfolio-management.md): Learn how to manage the portfolio of your Identities
- [Permissions Management](https://docs.tokeny.com/docs/permissions-management.md): Manage offchain and onchain permissions of your agents
- [Blockchain signature flow](https://docs.tokeny.com/docs/blockchain-signature-flow.md)
- [Wallet delegated signature through webhooks](https://docs.tokeny.com/docs/sign-transactions-with-external-wallets.md): Making the most out of webhook technology to seamlessly sign transactions on Tokeny's T-REX Engine
- [Frequently Asked Questions (FAQ)](https://docs.tokeny.com/docs/frequently-asked-questions-faq.md): This section addresses common questions developers and integrators might have when working with the Tokeny API. It complements the existing documentation by clarifying certain concepts, sharing best practices, and offering guidance on less obvious aspects of API usage.
- [Distributors: guide to integrate T-REX Engine APIs](https://docs.tokeny.com/docs/distributors-guide-to-integrate-t-rex-engine-apis.md)
- [Step 0: Getting started with T-REX Engine APIs](https://docs.tokeny.com/docs/getting-started-with-t-rex-engine-apis.md)
- [Step 1: Accessing the Catalog of assets](https://docs.tokeny.com/docs/accessing-the-catalog-of-assets.md)
- [Step 2: Qualifying investors](https://docs.tokeny.com/docs/qualifying-investors.md)
- [Step 3: Routing primary market orders](https://docs.tokeny.com/docs/routing-primary-market-orders.md)
- [Overview](https://docs.tokeny.com/docs/overview-1.md): The Token standard for RWA Tokenization
- [ERC-3643 Permissioned Tokens](https://docs.tokeny.com/docs/the-erc-3643-token-standard.md)
- [Built-in Compliance Framework](https://docs.tokeny.com/docs/built-in-compliance-framework.md): On-chain identities and Compliance modules
- [Ecosystem & Interoperability](https://docs.tokeny.com/docs/ecosystem-interoperability.md): A standardized and open framework to enhance interoperability
- [Overview](https://docs.tokeny.com/docs/overview-2.md): The largest interoperable ecosystem for tokenized assets
- [DINO network](https://docs.tokeny.com/docs/dino.md): The Open Distribution Network for Tokenized Assets
- [Components](https://docs.tokeny.com/docs/components.md)
- [Liquidity Smart contracts](https://docs.tokeny.com/docs/dino-smart-contracts.md): A complete ecosystem for tokenized assets distribution
- [Onchain cash](https://docs.tokeny.com/docs/onchain-cash.md): Enabling onchain settlement
- [Oracles and data feeds](https://docs.tokeny.com/docs/oracles-and-data-feeds.md): Connecting assets data to the blockchain rails
- [Distributors](https://docs.tokeny.com/docs/distributors.md): Using the blockchain as the global interoperable marketplace
- [Leandexer](https://docs.tokeny.com/docs/leandexer.md): Instantly track any smart contract events with seamless real-time notification
- [DeFi](https://docs.tokeny.com/docs/defi.md): Natively compatible DeFi for digital securities
- [Services providers](https://docs.tokeny.com/docs/services-providers.md): Compatible and useful service providers
- [Wallets](https://docs.tokeny.com/docs/wallets.md): Wallets are used to sign operations
- [Custodians](https://docs.tokeny.com/docs/custodians.md): Custody of crypto vs custody of tokenized securities
- [Identity providers](https://docs.tokeny.com/docs/identity-providers.md): KYC agents and identity solutions
- [Support](https://docs.tokeny.com/docs/support.md): Tokeny's team is at your service
- [Cybersecurity](https://docs.tokeny.com/docs/cyber-security.md): Policy + Procedure + People + Management + Technology
- [SOC2 certifications](https://docs.tokeny.com/docs/soc2.md)
- [Blockchain Events Pricing](https://docs.tokeny.com/docs/blockchain-events-pricing.md): Details of events recorded in the billing
- [Terms & Copyright ](https://docs.tokeny.com/docs/copyright.md): Some legal stuffs are always needed
- [Sustainability](https://docs.tokeny.com/docs/sustainability.md)
## API Reference
- [Get Tokens Catalog](https://docs.tokeny.com/reference/gettokenscatalog.md): Fetch a list of information fields for the given tokens. Please note that the information fetched may differ depending on permissions.
π Note that the authentication must provide sufficient privileges to access the information of the account.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [π List Accounts](https://docs.tokeny.com/reference/listaccounts-1.md): List and explore existing accounts in the Servicing Platform as an Administrator.
π No filter parameters are currently accepted.
- [Create Account](https://docs.tokeny.com/reference/createaccount-1.md): Create a new `Account` based on a valid access token. No special access level is required to use this endpoint.
- [Get Account](https://docs.tokeny.com/reference/getaccount-1.md): Get an existing Account details. The token must have access to the account or have administrator privileges.
- [π List API Keys](https://docs.tokeny.com/reference/listapikeys-1.md): List existing API keys in the Servicing Platform as an Infra Administrator.
π No filter parameters are currently accepted.
- [π Get one API Key](https://docs.tokeny.com/reference/getapikey-1.md): List one API key in the Servicing Platform as an Infra Administrator.
π No filter parameters are currently accepted.
- [Create API key](https://docs.tokeny.com/reference/createoneapikey-2.md): Create a new API key based on params passed.
- [Delete one API Key](https://docs.tokeny.com/reference/deleteapikey-1.md): Delete one API key in the Servicing Platform as an Infra Administrator.
- [/api/auth/signin](https://docs.tokeny.com/reference/authnestcontroller_signin-1.md)
- [/api/auth/requestaccess](https://docs.tokeny.com/reference/authnestcontroller_requestaccess-1.md)
- [List of all billboard offers: active and inactive ](https://docs.tokeny.com/reference/listallbillboardoffers-1.md): For token admin only - List and explore existing offers
- [List of all billboard offers created by requester user](https://docs.tokeny.com/reference/listmebillboardoffers-1.md): List existing offers created by the user
- [List of billboard offers not created by requester user](https://docs.tokeny.com/reference/listbillboardoffers-1.md): List and explore existing offers which have not been created by the requester account.
- [Get one of Billboard Offer](https://docs.tokeny.com/reference/getonebillboardoffer-1.md): Get one of Billboard Offer by offerId. Please note that the requester account must be agent or owner of any of the tokens involved in the offer, or either be super admin.
- [Get one of Billboard Offer](https://docs.tokeny.com/reference/getonebillboardofferme-1.md): Get one billboard Offer by offerId for a qualified investor.
- [Get one of Billboard Offer contact information](https://docs.tokeny.com/reference/getonebillboardoffercontact-1.md): Get the contact information of one billboard offer by offerId. Please note that the requester account must be agent or owner of any of the tokens involved in the offer, or either be super admin.
- [Get one of Billboard Offer contact information by holder](https://docs.tokeny.com/reference/getonebillboardoffercontactme-1.md): Get the contact information of one billboard offer by offerId for one qualified investor.
- [Create a billboard offer](https://docs.tokeny.com/reference/postbillboardoffer-1.md): Create a billboard offer via Dino API
π Note that the authentication must provide management rights over account. The required permission is ACCOUNT_MANAGEMENT.
- [Activate one Billboard Offer](https://docs.tokeny.com/reference/activateonebillboardoffer-1.md): Activate one Billboard Offer by offerId. Please note that only token admins are eligible for this operation.
- [Deactivate one Billboard Offer](https://docs.tokeny.com/reference/deactivateonebillboardoffer-1.md): Deactivate one Billboard Offer by offerId. Please note that only token admins are eligible for this operation.
- [Cancel one Billboard Offer](https://docs.tokeny.com/reference/cancelonebillboardoffer-1.md): Cancel one Billboard Offer providing its offerId. Please note that the requester account must be the same one that created the offer in the first place.
- [Complete one Billboard Offer](https://docs.tokeny.com/reference/confirmonebillboardoffer.md): Complete one Billboard Offer providing its offerId. Please note that the requester account must be the same one that created the offer in the first place.
- [List of all billboard ACTIVE offers by marketplace used by issuer](https://docs.tokeny.com/reference/listallactivebillboardoffersbymarketplace.md): List and explore existing offers by marketplace
- [List of all billboard offers by marketplace: active and inactive ](https://docs.tokeny.com/reference/listallbillboardoffersbymarketplace.md): For token admin only - List and explore existing offers by marketplace
- [List of all billboard offers by marketplace: active and inactive created by ssoid](https://docs.tokeny.com/reference/listallmyoffersbymarketplace.md): For token admin only - List and explore existing offers by marketplace
- [Create billboard settings](https://docs.tokeny.com/reference/postbillboardosettings-1.md): Create `Billboard settings` for the given token. As an issuer, it is essential to have at least one token deployed to activate the billboard feature.
π Note that the authentication must provide management rights over account. The required permission is ISSUER_MANAGEMENT.
- [Get billboard settings](https://docs.tokeny.com/reference/getbillboardsettings-1.md): Get Billboard settings for the given token.
π Note that the authentication must provide management rights over account. The required permission is ISSUER_MANAGEMENT.
- [/api/health](https://docs.tokeny.com/reference/healthnestcontroller_checkhealth-3.md)
- [Import Many Holders](https://docs.tokeny.com/reference/importholders-1.md): Import information of many holders. This operation will create holder profiles if they do not already exist and update already created holders (existence check made on wallet, identity address and email uniqueness).
Each holder must have an email, an identity address and at least a wallet as minimal information. A proof of the issuer access rights over the holder information (and his/her consent for information storage) must also be provided by the issuer. All other information are optionals.
In the provided list, if any email, identity address or wallet is defined twice, the operation will be rejected integrally. All specified ownerAccountId must also refer to registered accounts for the operation to succeed.
π The authentication must provide management rights over the issuer importing the holders (only ISSUER and AGENT users are allowed)
- [Get Holder Profile](https://docs.tokeny.com/reference/getmeholder-1.md): Get the requester's holder profile with its information.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Update Loged Holder](https://docs.tokeny.com/reference/updatemeholder-1.md): Update the requester Holder profile with its information.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Create a bank account for the current identity](https://docs.tokeny.com/reference/createbankaccount.md): Allow an agent or token holder to create a new bank account.
- [Get bank accounts](https://docs.tokeny.com/reference/getallbankaccounts.md): Allow an agent or token holder to get all the bank accounts.
- [Update a bank account](https://docs.tokeny.com/reference/updatebankaccount.md): Allow an agent or token holder to update a bank account.
- [Delete a bank account](https://docs.tokeny.com/reference/deletebankaccount.md): Allow an agent or token holder to delete a bank account.
- [Get Many Holders](https://docs.tokeny.com/reference/getholders.md): Get information about many holders. If the user is not super admin, the fetched list will reduce to the holders that can be managed by this account.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant. User must be super admin or issuer to use this endpoint.
- [Get Holder](https://docs.tokeny.com/reference/getholder-1.md): Get a Holder profile with its information.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant. User must be super admin or issuer to use this endpoint.
- [Whitelist a list of investors](https://docs.tokeny.com/reference/whitelistinvestor-1.md): It performs the next list of operations for an array of holder ids, identity ids or wallet addresses:
1. Deploys OID for those identityID if not deployed.
2. Adds wallet as management for those identities.
3. Issues KYC claims for those identities.
4. Adds OID-wallet-country to token identity registry.
π Note that the authentication must provide sufficient privileges to access the information of the token.Verification will search for users with ISSUER and AGENT roles.
- [Patch holders in identity service with current wallets](https://docs.tokeny.com/reference/migratewalletholder-1.md): For ADMIN only
- [Get issuer by issuer id](https://docs.tokeny.com/reference/getissuerbyid.md): Get issuer profile.
π Note that the authentication must provide administrative privileges. The required permission is an API key with READ_OPERATIONS.
- [Get issuers](https://docs.tokeny.com/reference/getissuers.md): List issuer profiles.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [Create Issuer](https://docs.tokeny.com/reference/createissuer-1.md): Create an Issuer profile owned by the specified Account.
π The creation of an Issuer profile is reserved to Administrators. Please contact us to gain access to the API.
- [Initiate deploy a token](https://docs.tokeny.com/reference/initiatedeploytoken.md): Initiate deploy a token.
π The initiation of an deployment for a token is reserved to token owners. This action is explicitly forbidden to global admins.
- [Get Token](https://docs.tokeny.com/reference/gettokens-1.md): Get list of existing token by its issuer.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Create an upload request for an Issuer logo](https://docs.tokeny.com/reference/createissuerlogouploadrequest.md): Create an upload request for an Issuer logo.
π Initiating an issuer logo upload is reserved to accounts with PLATFORM_ADMIN permission.
- [Get Issuer](https://docs.tokeny.com/reference/getissuer-for-an-issuer-portal.md): Get details of an Issuer profile in the provided issuer portal.
π Note that the authentication must provide management rights over the Issuer.The required permission is ISSUER_MANAGEMENT.
- [Get issuer portal Tokens](https://docs.tokeny.com/reference/getissuerportaltokens.md): Get list of existing token by issuer portal.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Get required claims associated with all tokens linked to the issuer](https://docs.tokeny.com/reference/get-required-claims-by-issuer.md): Gets a list of all claim topics linked to any of the tokens associated with the trusted issuer.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Create a new Issuer](https://docs.tokeny.com/reference/admincreateissuerv2.md): Create a new Issuer.
π Only Tokeny Admin can create an Issuer.
- [Get all issuers](https://docs.tokeny.com/reference/admingetissuersv2.md): Get all issuers.
π Only Tokeny Admin can use this endpoint.
- [Update an Issuer](https://docs.tokeny.com/reference/adminpatchissuerv2.md): Update an Issuer.
π Only Tokeny Admin can create an Issuer.
- [Create a new Issuer Account](https://docs.tokeny.com/reference/admincreateissueraccountv2.md): Create a new Issuer Account.
π Only Tokeny Admin can create an Issuer.
- [Get all issuers accounts for a issuer](https://docs.tokeny.com/reference/admingetissuersaccountsv2.md): Get all issuers accounts for an issuer.
π Only Tokeny Admin can use this endpoint.
- [Delete an issuer account](https://docs.tokeny.com/reference/admindeleteissueraccountv2.md): Delete an issuer account.
π Only Tokeny Admin can use this endpoint.
- [Update an Issuer Account](https://docs.tokeny.com/reference/adminpatchissueraccountv2.md): Update an Issuer Account.
π Only Tokeny Admin can update an Issuer Account.
- [Create a new Issuer Account.](https://docs.tokeny.com/reference/createissueraccountv2.md): Create a new Issuer Account.
π Only Issuer Admin can create an Account.
- [Get all Issuer Accounts for a Issuer.](https://docs.tokeny.com/reference/retrieveallissueraccountv2.md): Retrieve all Issuer Accounts for an Issuer.
π Only Issuer Admin can retrieve the Accounts.
- [Delete an Issuer Account.](https://docs.tokeny.com/reference/deleteissueraccountv2.md): Delete an Issuer Account.
π Only Issuer Admin can delete an Issuer Account.
- [Update an Issuer Account.](https://docs.tokeny.com/reference/updateissueraccountv2.md): Update an Issuer Account.
π Only Issuer Admin can update an Issuer Account.
- [Update an Issuer.](https://docs.tokeny.com/reference/updateissuerv2.md): Update an Issuer.
π Only Issuer Admin can update an Issuer.
- [Get audit logs for an issuer](https://docs.tokeny.com/reference/getissuerauditlogs.md): Retrieve audit logs for the specified issuer.
π The requester must be an issuer account owner.
- [Export audit logs for an issuer as CSV](https://docs.tokeny.com/reference/getissuerauditlogscsv.md): Export audit logs for the specified issuer as a CSV file.
The requester must be an issuer account owner.
- [Get a list of all Issuer for a Issuer Portal.](https://docs.tokeny.com/reference/retrieveallissuerbyportalv2.md): Get a list of all Issuers for an Issuer Portal.
π Deppend on permissions the response will be different.
- [Get issuer portal Tokens V2](https://docs.tokeny.com/reference/getissuerportaltokensv2.md): Get list of existing token by issuer portal.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Get marketplaces of a logged user](https://docs.tokeny.com/reference/getmarketplaces-1.md): Get all marketplaces that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get Tokens from a marketplace of a logged user](https://docs.tokeny.com/reference/getmemarketplacetokens-1.md): Get all tokens from a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise, information returned are limited to the ones defined in the access grant.
- [Get unread message counts from a marketplace of a logged user](https://docs.tokeny.com/reference/getmemarketplacemessagesunread-1.md): Get all unread message counts from a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get pending request counts from a marketplace of a logged user](https://docs.tokeny.com/reference/getmemarketplacerequestspending-1.md): Get all pending request counts from a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get current billboard offers from a marketplace portal of a logged user](https://docs.tokeny.com/reference/getmarketplaceportalbillboardoffers.md): Get all billboard offers from a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get projects for a marketplace](https://docs.tokeny.com/reference/getmarketplaceprojects-1.md): Get projects for a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Create projects for a marketplace](https://docs.tokeny.com/reference/createmarketplaceproject-1.md): Create projects for a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get projects for a marketplace the investor is authorized to manage.](https://docs.tokeny.com/reference/getmarketplaceprojectsme.md): Get projects for a marketplace the investor is authorized to manage.
- [Get support email for a marketplace](https://docs.tokeny.com/reference/getmarketplacesupportemail.md): Get the support email of a marketplace the logged user is authorized to manage.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant access to the data.
- [Update projects for a marketplace](https://docs.tokeny.com/reference/updatemarketplaceproject-1.md): Update projects for a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Delete a project for a marketplace](https://docs.tokeny.com/reference/deletemarketplaceproject-1.md): Delete a project for a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Update status of a marketplace project](https://docs.tokeny.com/reference/updatemarketplaceprojectstatus.md): Update the status of a marketplace project the logged user has authorization for. Users must be able to administrate the marketplace.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Create billboard settings for a marketplace](https://docs.tokeny.com/reference/createmarketplacebillboardsettings.md): Create billboard settings for a marketplace that the logged user can manage marketplace
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get one of Marketplace Billboard Settings](https://docs.tokeny.com/reference/getonemarketplacebillboardoffer.md): Get one of Marketplace Billboard Settings by marketplace id. No special access level is required to use this endpoint.
- [Get Marketplace Email Template](https://docs.tokeny.com/reference/getmarketplaceemailtemplate.md): Get an existing marketplace mailjet template ids by its unique domain. No further permissions are required to access this endpoint.
- [Get Email Template](https://docs.tokeny.com/reference/getemailtemplate-2.md): Get an existing mailjet template ids by its unique domain. No further permissions are required to access this endpoint.
- [Create a message to a list of recipient](https://docs.tokeny.com/reference/postmessage-1.md): Create a message to a list of recipient
π Note that the authentication must provide management rights over account. The required permission is ACCOUNT_MANAGEMENT.
- [List messages](https://docs.tokeny.com/reference/listmessages-1.md): List and explore existing messages
π Filter parameters are the same from IMAPAPI accepted.
π No special access privileges are mandatory to use this endpoint.
- [List messages](https://docs.tokeny.com/reference/listmessage.md): List and explore existing messages
π Filter parameters are the same from IMAPAPI accepted.
π No special access privileges are mandatory to use this endpoint.
- [get attachment by id](https://docs.tokeny.com/reference/getattachment.md): Get one attachment by id.
π No special access privileges are mandatory to use this endpoint.
- [Get Tokens from a portal of a logged user.](https://docs.tokeny.com/reference/getmeportaltokens-1.md): Get all tokens from a portal that the investor logged user has authorization for.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get public tokens from a portal](https://docs.tokeny.com/reference/getpublicportaltokens.md): Get all public tokens from a portal
- [List Token Position Reports](https://docs.tokeny.com/reference/listtokenpositionreports-1.md): List the Position Reports already generated for a registered Token. Please note that the user must be authorized to manage the token.
- [Generate Token Position Reports](https://docs.tokeny.com/reference/generatetokenpositionreports-1.md): Generate a Position Report for a given Token. Please note that the user must be authorized to manage the token.
- [Get a token position report previously generated](https://docs.tokeny.com/reference/gettokenpositionreport-1.md): Get token position report. Please note that the user must be authorized to manage the token.
- [Get token position report CSV](https://docs.tokeny.com/reference/gettokenpositionreportcsv-1.md): Get token position reports in a CSV file. Please note that the requester must provide administrative privileges over the token.
- [Create a new KYC check for a given token and identity ID. Requires APIKEY with permission CREATE_KYC_STATUS for the token](https://docs.tokeny.com/reference/postcreatekycrequest-1.md): Create a new KYC check for the given token
- [Get the requests flow operations for a given token](https://docs.tokeny.com/reference/getrequestsflowoperations-1.md): Get all the requests flow operations for a given token
π Note that the authentication must provide sufficient privileges to manage the given token.
- [Get my sent or received requests flow operations for a given token](https://docs.tokeny.com/reference/getmysentrequestsflowoperations-1.md): Get all the sent or received requests flow operations for a given token triggered by the caller
π The caller must be qualified for this token.
- [Create a new conditional transfer for a given token](https://docs.tokeny.com/reference/postcreateconditionaltransferrequest-1.md): Create a new conditional transfer for the given token
- [Validate a previously-created conditional transfer](https://docs.tokeny.com/reference/postvalidateconditionaltransferrequest-1.md): Validate a conditional transfer that was created previously
π Note that the authentication must provide sufficient privileges to manage the given token: the requester must be token owner or agent.
- [Cancel a previously-created conditional transfer](https://docs.tokeny.com/reference/postcancelconditionaltransferrequest-1.md): Cancel a conditional transfer that was created previously
π It can be called by a TOKEN_ADMIN or the requester of the Conditional Transfer.
- [Approve or reject an existing DvD transfer](https://docs.tokeny.com/reference/approveorrejectdvdtransfer-1.md): DEPRECATED: Approve or reject an existing DvD transfer
π It can be called by a QUALIFIED token holder.
- [Cancel an existing DvD transfer](https://docs.tokeny.com/reference/canceldvdtransfer-1.md): DEPRECATED: Cancel an existing DvD transfer
π It can be called by a QUALIFIED token holder.
- [Get balances of accounts in the provided token](https://docs.tokeny.com/reference/listmanyentitiesheaders.md): Get `balances` of accounts in the provided token that the investor logged user has authorization
π Please, note that the user's must be linked to the token as owner. Otherwise the request will result in a 404 exception.
- [Get Token balances list for my own holder.](https://docs.tokeny.com/reference/getsharedbalanceslist.md): Get Token balances list for my own holder. Please note that the account must have administrative privileges over the token.
- [Get Token Documents](https://docs.tokeny.com/reference/gettokendocuments.md): Get the document info of an existing token by its unique ID.
π Note that the authentication must provide sufficient privileges to access the information of the token. User must be owner or agent of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Get TokenHolder](https://docs.tokeny.com/reference/gettokenholderme.md): Get an TokenHolder profile with its information and status.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get TokenHolders from a token](https://docs.tokeny.com/reference/gettokenholders-1.md): Get details of all Token Holder profiles which are related to the specified token from different data sources. This will include Holders having tokens, those registered in the Identity Registry, and those the Issuer of the Token can access information of.
π Note that the authentication must provide management rights over the Issuer. The required permission is ISSUER_MANAGEMENT.
- [Get TokenHolders from a token csv](https://docs.tokeny.com/reference/gettokenholderscsv-1.md): Get details of all Token Holder profiles which are related to the specified token from different data sources. This will include Holders having tokens, those registered in the Identity Registry, and those the Issuer of the Token can access information of.
π Note that the authentication must provide management rights over the Issuer. The required permission is ISSUER_MANAGEMENT.
- [Get TokenHolder](https://docs.tokeny.com/reference/gettokenholder-1.md): Get a TokenHolder profile with its information and status.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Revoke TokenHolder](https://docs.tokeny.com/reference/revoketokenholder-1.md): Revoke a TokenHolder.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data.
- [Get Holder document download link](https://docs.tokeny.com/reference/getholderdocumentdownloadlink-1.md): Get a Holder's document download link.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data.
- [Get Candidates](https://docs.tokeny.com/reference/getcandidates-1.md): Get a paginated list of candidates with different filtering options.
π Note that the authentication must provide sufficient privileges to access the information of the holder list. The HOLDER_MANAGEMENT permissions grant full access to the data.
- [Get candidates csv](https://docs.tokeny.com/reference/fetchcandidatescsv-1.md): Get a list of candidates csv
π Note that the authentication must provide sufficient privileges to access the information of the holder list. The HOLDER_MANAGEMENT permissions grant full access to the data.
- [Get Holder main data](https://docs.tokeny.com/reference/getholdermaindata-1.md): Get a Holder's main data.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data.
- [Update candidate KYC status](https://docs.tokeny.com/reference/tokencandidatekyc.md): Update the candidate KYC status for a specific token
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Trigger a candidate's KYC status check](https://docs.tokeny.com/reference/tokencandidateonfido.md): Trigger a candidate's KYC status check for a specific token
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Retrieve detailed information about a specific token holder.](https://docs.tokeny.com/reference/gettokenholderv2.md): This endpoint enables you to access a comprehensive profile for an individual token holder, providing visibility into their current status and associated information within your token ecosystem.
Use this endpoint to:
- Verify a specific holder's status before executing transactions
- Access holder profile details for KYC/AML compliance purposes
- Retrieve identity information for reporting or customer service
Access level: Requires authentication with an agent or an owner account.
- [Retrieve a paginated list of all token holders associated with a specific token.](https://docs.tokeny.com/reference/gettokenholdersv2.md): This endpoint delivers a unified view of your token's holder and qualified investors by aggregating data across multiple sources, giving you complete visibility into your token's distribution and adoption.
Use this endpoint to:
- Monitor the composition of your investor base across the entire token ecosystem
- Analyze holder distributions for compliance and reporting requirements
- Maintain visibility of all entities with relationships to your token, not just current holders
Access level: Requires authentication with an agent or an owner account.
- [Get Token](https://docs.tokeny.com/reference/gettokeninfo-1.md): Get an existing token by its unique ID.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners and agents are able to manage the token information.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Retrieve owner](https://docs.tokeny.com/reference/gettokenowner.md): Retrieve the token owner of an existing token by its unique ID.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners and agents are able to retrieve the token owner.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token owner.
- [Get Token links](https://docs.tokeny.com/reference/gettokenlinks-1.md): Get the associated links with a token by its unique ID.
π This endpoint does not require special administration privileges to be called.
- [Create Upload Request for a Logo Token](https://docs.tokeny.com/reference/createtokenlogouploadrequest-1.md): Create a request upload for a token logo.
- [Mint token](https://docs.tokeny.com/reference/minttoken.md): Mint a specified amount of token to a given wallet. Please note that the user must be able to admin the token.
- [Burn tokens](https://docs.tokeny.com/reference/burntokens-1.md): Burn a specified amount of token from a given wallet. Please note that the user must be able to admin the token.
- [Freeze a wallet](https://docs.tokeny.com/reference/freezeawallet-1.md): Freeze a specified amount of token from a given wallet. Please note that the user must be able to admin the token.
- [Unfreeze a wallet](https://docs.tokeny.com/reference/unfreezeawallet-1.md): Unfreeze a specified amount of token from a given wallet. Please note that the user must be able to admin the token.
- [Partial freeze tokens](https://docs.tokeny.com/reference/partialfreezetokens-1.md): Partial freeze a specified amount of token from a given wallet. Please note that the user must be able to admin the token.
- [Partial unfreeze tokens](https://docs.tokeny.com/reference/partialunfreezetokens-1.md): Partial unfreeze a specified amount of token from a given wallet. Please note that the user must be able to admin the token.
- [Forced tokens transfer](https://docs.tokeny.com/reference/forcedtransfertokens-1.md): Forces the transfer of a specified amount of token from a given wallet to a given wallet. Please note that the user must be able to admin the token.
- [Pause token](https://docs.tokeny.com/reference/pausetoken-1.md): Pause the given token. Please note that the user must be able to admin the token.
- [Unpause token](https://docs.tokeny.com/reference/unpausetoken-1.md): Unpause the given token. Please note that the user must be able to admin the token.
- [Recovery tokens of a wallet](https://docs.tokeny.com/reference/tokenrecovery-1.md): Recovery tokens from the given old wallet to a new wallet
- [Get list of accessible tokens](https://docs.tokeny.com/reference/getmanytokensheaders.md): Get list of tokens accessible by the logged user
π Note that the authentication must provide sufficient privileges to access the information of the token.The ACCOUNT_MANAGEMENT permission required to access the Token data.
- [Get list of stable Tokens](https://docs.tokeny.com/reference/getstabletokens-1.md): Get list of stable tokens supported
π Note that the authentication must provide sufficient privileges to access the information of the token.The ACCOUNT_MANAGEMENT permission required to access the Token data.
- [Get Token data with valuation by only qualified holders](https://docs.tokeny.com/reference/gettokenme.md): Get an existing token by its unique ID.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Get Token](https://docs.tokeny.com/reference/gettoken-1.md): Get an existing token by its unique ID. Investors and issuers can access this endpoint.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Deletes a non-deployed token](https://docs.tokeny.com/reference/deletenondeployedtoken.md): Deletes a non-deployed token by id.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners are allowed to perform this operation.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [Get list of tokens linked to a given qualification](https://docs.tokeny.com/reference/gettokenbyqualificationid.md): Get list of tokens linked to a given qualification.
π Note that the authentication must provide sufficient privileges to access the information of the token.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [List the Token transactions for the curent user](https://docs.tokeny.com/reference/listtokentransactionsme-1.md): List the transactions as holder of the current user that is calling this method.
π The authentication is used to determine whose user transactions to retrieveThe required permission is TOKEN_MANAGEMENT.
- [List Token Transactions](https://docs.tokeny.com/reference/listtokentransactions-1.md): List transactions of a registered token. Transactions are accessible to any issuer for tokens they have published or for admins only.
Filter on recipient and sender addresses with `recipient` and `sender` query parameters. Both can be provided.
Use query parameter `includeHolder=true` to include holders information if they agreed to share their information with the issuer.
π Note that the authentication must provide permission over the token to see holder information. The required permission is TOKEN_MANAGEMENT.
- [Get token transactions csv](https://docs.tokeny.com/reference/listtokentransactionscsv-1.md): Generate a `CSV file` with a list of token transactions. Transactions are accessible to any issuer for tokens they have published or for admins only.
- [Retrieve list of token transactions.](https://docs.tokeny.com/reference/listtokentransactionsv2.md): This endpoint provides a comprehensive view of transactions for a specified token with advanced filtering capabilities. Filter transactions by sender address, recipient address, date range, transaction type, and status.
Optional parameter include Holder=true enriches the response with holder information (when available) for transactions, providing additional context about the parties involved in each transaction. Holder information is only included for holders who have opted to share their information with the issuer.
The response is paginated and includes transaction details such as amount, timestamp, transaction hash, blockchain status, and optionally holder information.
Access level: Requires authentication with an agent account.
- [Validate Direct Transfer](https://docs.tokeny.com/reference/validatedirecttransfer.md): DEPRECATED: This endpoint will be deprecated in next versions.
Validate a direct transfer between two wallets.
π Access level: Only qualified investors.
- [Transaction Increase Allowance](https://docs.tokeny.com/reference/broadcastincreaseallowancetransfer.md): DEPRECATED: This endpoint will be deprecated in next versions.
Broadcast an increase allowance transaction.
π Access level: Any user.
- [Broadcast DFNS Transfer](https://docs.tokeny.com/reference/broadcastdfnstransfer.md): DEPRECATED: This endpoint will be deprecated in next versions.
Broadcast signed challenge for a DFNS transfer.
π Access level: Any user.
- [Validate DvD Transfer](https://docs.tokeny.com/reference/validatedvdtransfer.md): DEPRECATED: This endpoint will be deprecated in next versions.
Validate a DvD transaction.
π Access level: Any user.
- [Create DvD Transfer](https://docs.tokeny.com/reference/createdvdtransfer.md): DEPRECATED: This endpoint will be deprecated in next versions.
Create a DvD transaction.
π Access level: Any user.
- [Broadcast Increase Allowance](https://docs.tokeny.com/reference/broadcastincreaseallowance.md): DEPRECATED: This endpoint will be deprecated in next versions.
Broadcast an increase allowance transaction.
π Access level: Any user.
- [Validate mint token](https://docs.tokeny.com/reference/validateminttokentowallets-1.md): Validate minting a specified amount of tokens to a given wallets. Please note that the account must be able to admin the token.
- [Validate burning tokens from wallets](https://docs.tokeny.com/reference/validateburntokensfromwallets-1.md): Validate burning a specified amount of tokens from the given wallets. Please note that the account must be able to admin the token.
- [Validate freezing tokens from wallets](https://docs.tokeny.com/reference/validatefreezetokensfromwallets-1.md): Validate freezing a specified amount of token from the given wallets. Please note that the account must be able to admin the token.
- [Validate unfreezing tokens from wallets](https://docs.tokeny.com/reference/validateunfreezetokensfromwallets-1.md): Validate unfreeze a specified amount of tokens from the given wallets. Please note that the account must be able to admin the token.
- [Validate forced tokens transfer](https://docs.tokeny.com/reference/validateforcedtransfertokens-1.md): Validate forced transfer of a specified amount of token from a given wallet to a given wallet. Please note that the account must be able to admin the token.
- [Validate pause of token](https://docs.tokeny.com/reference/validatepausetoken-1.md): Validate pausing the given token. Please note that the account must be able to admin the token.
- [Validate unpause of token](https://docs.tokeny.com/reference/validateunpausetoken-1.md): Validate unpausing the given token. Please note that the account must be able to admin the token.
- [Get list of token's operations](https://docs.tokeny.com/reference/gettrexoperations.md): Get list of operations over the token. Please note that the account must be token admin for this operation.
- [Update Token Valuation](https://docs.tokeny.com/reference/tokenvaluation-1.md): Update token valuation.
π Note that the authentication must provide sufficient privileges to access the information of the token.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Get price history for a token.](https://docs.tokeny.com/reference/gettokenpricehistory.md): Gets the price history for the provided Token.
π Note that the authentication must provide management rights over the Issuer. Issuer must be agent or owner of the token.The required permission is TOKEN_MANAGEMENT.
- [Get price history for a token for an investor.](https://docs.tokeny.com/reference/gettokenpricehistoryme.md): Gets the price history for the provided Token.
π Note that the authentication must provide management rights over the Issuer. Investors must be qualified for the token.The required permission is TOKEN_MANAGEMENT.
- [Update the Information of a Token.](https://docs.tokeny.com/reference/updatetokeninfo.md): Update the Information of a Token.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners are able to update the token information.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Update the Information of a Token Owner.](https://docs.tokeny.com/reference/updatetokenowner.md): Update the Information of a Token Owner before Token is deployed.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners are able to update the token information.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.
- [Log TransactionHash of the provided token owner action.](https://docs.tokeny.com/reference/logtransactiontokenowneraction.md): Log TransactionHash of the provided token owner action.
π Access level: Only owners of the token.
- [Download a token document](https://docs.tokeny.com/reference/downloadtokendocument.md): Streams the contents of a token document. The caller must be owner or agent of the token, hold administration privileges, or be a qualified investor of the token. Requests bypass the public S3 URL and stream through the backend so leaked links cannot be opened from an unauthenticated machine.
- [Retrieve all tokens my account can manage.](https://docs.tokeny.com/reference/tokenretrievalbyissuer.md): Returns all the tokens the requester account has permissions for in a paginated list.
Access level: The account must be agent, owner, or creator of the tokens.
- [Retrieve all tokens I can manage as holder.](https://docs.tokeny.com/reference/tokenretrievalbyinvestor.md): Returns all the tokens the requester holder is qualified for in a paginated list.
Access level: The user must have a qualified or revoked status for the tokens.
- [Get list of payment tokens](https://docs.tokeny.com/reference/getpaymenttokensv2.md): Get a list of payment tokens filterable by an array of chainIds.
- [Retrieve issuer's subscriptions for a token.](https://docs.tokeny.com/reference/subscriptionissuermanyretrieval-1.md): Fetch all issuer's subscription configurations related to the token.
- [Create a token subscription with an interval](https://docs.tokeny.com/reference/subscriptioncreation-1.md): Create a new token subscription with an interval
π Note that the authentication must provide administrative privileges. The required permission is AGENT or OWNER.
- [Retrieve issuer's subscription by ID](https://docs.tokeny.com/reference/subscriptionissuerretrieval-1.md): Fetch one issuer's subscription by ID from a specific token
- [Update a subscription](https://docs.tokeny.com/reference/subscriptionupdate-1.md): Update an existing subscription
π Note that the authentication must provide administrative privileges. The required permission is AGENT or OWNER.
- [Creates a btc address pool](https://docs.tokeny.com/reference/createbtcaddresspool.md): Creates a new btc address pool. The issuer must provide enough permissions to manage the token.
- [Create batch btc address pool](https://docs.tokeny.com/reference/batchcreatebtcaddresspool.md): Create batch btc address pool
- [Add an interval to a subscription](https://docs.tokeny.com/reference/subscriptionintervalcreation-1.md): Create a new interval and append it to an existing subscription.
π Access level: Token Owner or Token Agent.
- [Update a subscription interval](https://docs.tokeny.com/reference/subscriptionintervalupdate-1.md): Update an interval of an existing subscription.
π Access level: Token Owner or Token Agent.
- [Retrieve investor orders by subscription and token](https://docs.tokeny.com/reference/investorordersretrieval-1.md): Retrieve investor orders by subscription and token. Endpoint only accessible to admins and token issuers.
- [Create an order on behalf of an investor](https://docs.tokeny.com/reference/investorordercreationbyissuer.md): Create a new investor order for the given subscription on behalf of an investor. Please note that the requester account must be token agent or owner.
- [Retrieve investor order by order ID](https://docs.tokeny.com/reference/investororderretrievalbyid-1.md): Retrieve one order for the given token by order ID. Endpoint only accessible to admins and token issuers.
- [Cancel investor orders by ID](https://docs.tokeny.com/reference/cancelinvestororderbyissuer-1.md): Cancelled investor order for the given subscription and ID
- [Set price for many investor orders](https://docs.tokeny.com/reference/setpriceformanyinvestorordersbyissuer.md): Set a price for many investor orders for the given subscription
- [Confirm investor orders by ID](https://docs.tokeny.com/reference/confirminvestororderbyissuer-1.md): Confirm investor order for the given subscription and ID
- [Batch confirm investor orders by IDs](https://docs.tokeny.com/reference/batchconfirminvestororderbyissuer.md): Batch confirm investor orders for the given subscription and IDs
- [Automatic investor order reconciliation by ID](https://docs.tokeny.com/reference/reconciliateinvestororder.md): Update and confirm investor order for the given subscription and ID
- [Cancel many investor orders by Issuer](https://docs.tokeny.com/reference/cancelmanyinvestororders-1.md): Cancel many investor order status to for the given subscription
- [Retrieve investor's docusign url by ID](https://docs.tokeny.com/reference/retrieveinvestordocusignbyorderid-1.md): Retrieve the docusign url for the given subscription
- [Retrieve exchange rate by issuer](https://docs.tokeny.com/reference/exchangerateretrievalissuer-1.md): Issuer endpoint to retrieve the exchange rates for the given subscription, from baseCurrency to all allowed currencies (FIAT and cryptocurrencies)
- [Retrieve all currency pairs](https://docs.tokeny.com/reference/currencypairsretrieval-1.md): Retrieve a list of currency pairs allowed in any existing subscription. This pairs can include FIAT or cryptocurrencies
- [Update exchange rates for all currency pairs](https://docs.tokeny.com/reference/exchangerateupdate-1.md): Receive a list of currency paris with current exchange rates and update their value locally.
- [Refund many investor orders by Issuer](https://docs.tokeny.com/reference/refundmanyinvestororders-1.md): Refund many confirmed investor order to for the given subscription
- [Mint many investor orders by Issuer](https://docs.tokeny.com/reference/mintmanyinvestororders-1.md): Mint many confirmed investor orders for the given subscription
- [Mint orders](https://docs.tokeny.com/reference/mintmanyorders.md): Mint many confirmed orders to for the given subscription
- [Export token investor orders in CSV file format](https://docs.tokeny.com/reference/subscriptionordersexport.md): Export token investor orders in a CSV file
- [Log Task Transaction for Subscription](https://docs.tokeny.com/reference/logworkflowtasktransaction.md): Log TransactionHash for the set allowance workflow task related to a subscription configuration, signed and emitted externally.
π Access level: Only qualified investors of the token. User must as well be the initiator of the transaction.
- [Fetch investor order actions.](https://docs.tokeny.com/reference/getsubscriptionorderactions.md): Get a list of `investor order actions` by status. Please note that the requester account must be agent of the token.
- [Retrieve investor's token subscriptions](https://docs.tokeny.com/reference/subscriptioninvestormanyretrieval-1.md): Fetch all investor's subscriptions from a specific token.
π Note that the authentication must provide sufficient privileges to access the information of the token. The investor must be qualified for the token.
- [Retrieve investor's subscription by ID](https://docs.tokeny.com/reference/subscriptioninvestorretrieval-1.md): Fetch one investor's subscription by ID from a specific token
π Note that the authentication must provide sufficient privileges to access the information of the token. The investor must be qualified for the token.
- [Retrieve your own investor orders](https://docs.tokeny.com/reference/investorordersmanyretrieval-1.md): Retrieve your own investor orders by subscription ID
- [Create an investor order](https://docs.tokeny.com/reference/investorordercreation.md): Create a new investor order for the given subscription
- [Retrieve exchange rate by investor](https://docs.tokeny.com/reference/exchangerateretrievalinvestor-1.md): Investor endpoint to retrieve the exchange rates for the given subscription, from baseCurrency to all allowed currencies (FIAT and cryptocurrencies)
- [Cancel an investor order by ID](https://docs.tokeny.com/reference/cancelinvestororder-1.md): Cancel an investor created order for the given subscription
- [Confirm by ID that an investor order by ID](https://docs.tokeny.com/reference/confirminvestororder-1.md): Confirm an investor created order for the given subscription
- [Confirm an order to PENDING PAYMENT in behalf of an investor](https://docs.tokeny.com/reference/confirmorderinbehalfofinvestor.md): An issuer confirms that an investor created order for the given subscription can go to the next step PENDING PAYMENT
- [Retrieve token documents for investor by token ID](https://docs.tokeny.com/reference/tokendocumentsinvestorallretrieval.md): Fetch token documents by token ID from a specific token. Please note that the investor must be qualified for this token.
- [Delete token document by token ID and url](https://docs.tokeny.com/reference/tokendocumentdeletion.md): Delete token document by token ID and url. Please note that the requester must be able to administrate the token.
- [Update token document by token ID and url](https://docs.tokeny.com/reference/tokendocumentupdate.md): Update token document by token ID and url. Please note that the requester must be able to administrate the token.
- [Upload document for a token](https://docs.tokeny.com/reference/tokendocumentupload.md): Upload document for a token. Please note that the requester must be able to administrate the token.
This endpoint requires a form-data request with the following fields:
- files: The PDF file to upload (max 2MB)
- label: The document label
- language: ISO 639-1 language code (e.g., "en", "fr", "es")
- [Get holder by token and wallet](https://docs.tokeny.com/reference/gettokenholderbywallet-1.md): Get the initials of the TokenHolder with this wallet. Please note that the holder of the wallet must have one of the next statuses: Qualified, TokenHolder, or Revoked. Any other will receive a 404 response.
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [List of accounts with permissions to the token](https://docs.tokeny.com/reference/listtokenaccountaccess-1.md): List of accounts with permissions to the token. Please note that the account must have permissions to administrate the token.
- [Create account permissions to the token](https://docs.tokeny.com/reference/addtokenaccountaccess-1.md): Allow a `token owner` to create account permissions.
- [Update account agent wallet to the token](https://docs.tokeny.com/reference/updatetokenaccountpermission.md): Allow a `token owner` to update an account agent wallet.
- [Delete an accounts permissions to the token](https://docs.tokeny.com/reference/deletetokenaccountaccess-1.md): It allows a `token owner` to delete another account's account permissions over a token.
- [Add agent validation](https://docs.tokeny.com/reference/validateaddtokenagent-1.md): Validate adding agent to token, compliance and identity registry. Please note that the account must have permissions to administrate the token.
- [Remove agent validation](https://docs.tokeny.com/reference/validateremovetokenagent-1.md): Validate removing agent from token, compliance and identity registry. Please note that the account must have permissions to administrate the token.
- [Create cex account](https://docs.tokeny.com/reference/postcexaccount.md): create cex account by superadmin
π Note that the authentication must provide management rights over account. The required permission is PLATFORM_ADMIN.
- [List All Centralized Exchanges](https://docs.tokeny.com/reference/listallcexs.md): List all centralized exchanges.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [Create Upload Request for a CEX logo](https://docs.tokeny.com/reference/createcexlogouploadrequest.md): Creates an upload request for a CEX logo.
No special access level is required for this operation.
- [Retry failed cex creation](https://docs.tokeny.com/reference/retrycexcreation.md): Retry failed cex creation.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [Partial update of cex entity.](https://docs.tokeny.com/reference/cexpartialupdate.md): Partial update of cex entity.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [Retrieve all tokens allowed by CEX id](https://docs.tokeny.com/reference/cexwithtokensretrieval.md): Retrieve list of tokens entities allowed by a cex. The required permission is PLATFORM_ADMIN.
- [Retrieve all deployed CEX by token id](https://docs.tokeny.com/reference/cextokenretrieval.md): Retrieve all deployed CEX data with entities by token id
- [Allow deployed CEX to a token](https://docs.tokeny.com/reference/cextokencreation.md): Allow a deployed CEX to be attached to a token. Please note that only owners and agents of the token are eligible for this operation.
- [Disallow deployed CEX to a token](https://docs.tokeny.com/reference/cextokendeletion.md): Disallow deployed CEX to a token
- [Reject an array of deposit wallets](https://docs.tokeny.com/reference/rejectmanydepositwallets.md): Reject an array of deposit wallets for a CEX and a token.
- [Revoke a deposit wallet](https://docs.tokeny.com/reference/revokeonedepositwallet.md): Revoke a deposit wallet for a CEX and a token.
- [Delete a deposit wallet request](https://docs.tokeny.com/reference/deletedepositwallet.md): Delete a deposit wallet request for a CEX and a token.
- [List All Deposit Wallets for a CEX and a Token](https://docs.tokeny.com/reference/retrieve-deposit-wallets.md): List all deposit wallets for a CEX and a token.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [List All Deposit Wallets for a CEX and a Token](https://docs.tokeny.com/reference/approve-deposit-wallets.md): Approve deposit wallets for a CEX and a token.
π Note that the authentication must provide administrative privileges. The required permission is PLATFORM_ADMIN.
- [Create a deposit wallet](https://docs.tokeny.com/reference/createcexdepositwallet.md): Create a deposit wallet for a CEX Token.
- [Retrieve allowed centralized exchanges for investor](https://docs.tokeny.com/reference/retrieveallowedexchanges.md): Retrieve allowed centralized exchanges for investor
- [Delete a deposit wallet request](https://docs.tokeny.com/reference/deletedepositwalletme.md): Delete a deposit wallet request for a CEX and a token.
- [Fetch a redemption by id](https://docs.tokeny.com/reference/getredemption.md): Allow an agent or an issuer to fetch a redemption configuration by id. Please note that the account must be token admin.
- [Delete a redemption by id.](https://docs.tokeny.com/reference/deleteredemption.md): Allow an agent or an issuer to delete a redemption configuration by id. Note that the account must be token admin.
- [Update a redemption by id](https://docs.tokeny.com/reference/updateredemption.md): Allow an agent or an issuer to update a redemption configuration by id. Note that the account must be token admin.
- [Create a redemption](https://docs.tokeny.com/reference/createredemption.md): Allow an agent or an issuer to create a redemption configuration by id. Note that the account must be token admin.
- [Fetch exchange rates for a redemption for the investor by redemption id](https://docs.tokeny.com/reference/getredemptionexchangeratesforinvestor.md): Allow an agent or account linked to tokenId to fetch a redemption exchange rates by redemption id.
- [Fetch exchange rates for a redemption by redemption id](https://docs.tokeny.com/reference/getredemptionexchangerates.md): Allow an agent or account linked to tokenId to fetch a redemption exchange rates by redemption id.
- [Export redemption orders in CSV file format](https://docs.tokeny.com/reference/redemptionordersexport.md): Export redemption orders in a CSV file. Please note that this operation is only available for token agents and token owners
- [Fetch all redemptions for a token](https://docs.tokeny.com/reference/getredemptionsforatoken.md): Allow an agent or account linked to tokenId to fetch all redemption configurations for a token.
- [Get redemption config for the given token](https://docs.tokeny.com/reference/gettokenredemption.md): Gets the redemption config for the provided Token.
π Access level: the Redemption Owner.The user must be the owner of the redemption.
- [Retrieve issuer redemption orders](https://docs.tokeny.com/reference/retrieveissuerredemptionorders.md): Allow an issuer to fetch his/her redemption orders.
- [Retrieve investor redemption orders](https://docs.tokeny.com/reference/retrieveinvestorredemptionorders.md): Allow an investor to fetch his/her redemption orders.
- [Create a redemption order](https://docs.tokeny.com/reference/createredemptionorder.md): Allow an agent or token holder to create a redemption order.
- [Retrieve investor redemption orders](https://docs.tokeny.com/reference/retrievemanyinvestorredemptionorders.md): Allow an investor to fetch his/her redemption orders.
- [Confirm the payment for many redemption orders](https://docs.tokeny.com/reference/redemptionordersconfirmpayment.md): Allow an agent or account linked to tokenId to confirm a payment for many redemption orders.
- [Accept many redemption orders](https://docs.tokeny.com/reference/redemptionordersblocktokens.md): Allow a token agent or token holder to accept many redemption orders.
- [Get redemption orders from a redemption configuration.](https://docs.tokeny.com/reference/redemptionordersretrieval.md): Allow an token agent or token holder to retrieve redemption orders.
- [Create a redemption order on behalf of an investor](https://docs.tokeny.com/reference/redemptionordersnestjscontroller_createredemptionorderonbehalfofaninvestor.md): Create a new redemption order for the given redemption ID on behalf of an investor. The request account must be agent of the token.
- [Get redemption order actions](https://docs.tokeny.com/reference/getredemptionorderactions.md): Retrieve paginated list of redemption order actions
- [Get redemption order details from a redemption configuration.](https://docs.tokeny.com/reference/redemptionorderdetailsretrievalissuer.md): Allow a token agent to retrieve redemption order details.
- [Get redemption order details from a redemption configuration.](https://docs.tokeny.com/reference/redemptionorderdetailsretrievalinvestor.md): Allow a qualified token holder to retrieve the details of a redemption order.
- [Set redemption order prices](https://docs.tokeny.com/reference/manyredemptionorderssetprice.md): Allow a token agent or token owner to set price of many redemption orders.
- [Burn a batch of Redemption Orders](https://docs.tokeny.com/reference/batchburnredemptionorder.md): Burn a batch of Redemption Orders. The requester must be token holder or agent.
- [Cancel a batch of redemption Orders](https://docs.tokeny.com/reference/batchcancelredemptionorder.md): Cancel a batch of redemption Orders. The requester must be token holder or agent.
- [Cancels a redemption order for the investor by the order id](https://docs.tokeny.com/reference/cancelredemption.md): Allow an investor to cancel an investor order.
π Note that caller must be qualified for the token and be owner of the redemption order.
- [Retrieve investor's docusign url by ID](https://docs.tokeny.com/reference/retrieveinvestordocusignbyredemptionorderid.md): Retrieve the docusign url for the given redemption
- [Confirm a redemption order to PENDING TO ACCEPT by ID](https://docs.tokeny.com/reference/confirmredemptionorder.md): Confirm redemption order to PENDING TO ACCEPT for the given redemption and ID. The requester must be a qualified investor of the token.
- [Log TransactionHash for the redemption order action workflow task](https://docs.tokeny.com/reference/logredemptionorderworkflowtasktransaction.md): Log TransactionHash for the redemption order action workflow task, signed and emitted externally.
π Access level: Only qualified investors of the token. User must as well be the initiator of the transaction.
- [Broadcast Transaction for the redemption order action workflow task](https://docs.tokeny.com/reference/broadcastredemptionorderworkflowtaskpayload.md): Broadcast Transaction for the redemption order action workflow task, signed and emitted externally.
π Access level: Only qualified investors of the token. User must as well be the initiator of the transaction.
- [Cancel Many Redemption Orders](https://docs.tokeny.com/reference/cancelredemptionordersaction.md): Start the action to `cancel many redemption orders` with the same status. Please note that the requester must be `agent` of the token.
All the orders must share the same status.
If the status of the orders is INITIATED or PENDING_TO_ACCEPT, then the orders are cancelled without any further step and an email notification is sent. The response status will be 204.
If the agent does not have a registered wallet of their own, a Tokeny wallet will be provided for them. In that case, the orders will be cancelled, the response will include the workflow id of the operation, and the response status will be 200.
If the agent has a registered wallet of their own, the response will include the transaction payloads to sign the operation, and the response status will be 202.
One or more orders cannot be cancelled because they have already CANCELLED status.
- [Accept many redemption orders](https://docs.tokeny.com/reference/redemptionordersaccept.md): Start the action to accept many redemption orders. Please note that the requester must be `agent` of the token.
If the agent does not have a registered wallet of their own, a Tokeny wallet will be provided for them. In that case, the orders will be accepted, the response will include the workflow id of the operation, and the response status will be 200.
If the agent has a registered wallet of their own, the response will include the transaction payloads to sign the operation, and the response status will be 202.
- [Burn redemption orders](https://docs.tokeny.com/reference/redemptionordersburn.md): Start the action to burn many redemption orders. Please note that the requester must be `agent` of the token.
If the agent does not have a registered wallet of their own, a Tokeny wallet will be provided for them. In that case, the orders will be burned, the response will include the workflow id of the operation, and the response status will be 200.
If the agent has a registered wallet of their own, the response will include the transaction payloads to sign the operation, and the response status will be 202.
- [Retrieve Available Blockchain Networks.](https://docs.tokeny.com/reference/allnetworksretrieval.md): Retrieves all configured blockchain networks, including identifiers, names, chain IDs, and connection details. Enables clients to dynamically adapt to system configuration without hardcoding network information.
Access level: Authenticated users.
- [Initiate DvA Transfer](https://docs.tokeny.com/reference/initiatedvatransfer.md): Initiates a new DvA transfer request and returns the transaction payload to be signed.
The advanced conditional transfers feature must be enabled for the token.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor.
- [Approve DvA Transfer](https://docs.tokeny.com/reference/approvedvatransfer.md): Approves the DvA transfer request with the given transferId and returns the transaction payload to be signed. The caller must be the next approver of the transfer.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Cancel DvA Transfer](https://docs.tokeny.com/reference/canceldvatransfer.md): Cancels the DvA transfer request with the given transferId and returns the transaction payload to be signed. Only the sender can cancel the transfer.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor.
- [Reject DvA Transfer](https://docs.tokeny.com/reference/rejectdvatransfer.md): Rejects the DvA transfer request with the given transferId and returns the transaction payload to be signed. The caller must be the next approver of the transfer.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Broadcast DvA Transfer Request](https://docs.tokeny.com/reference/broadcastdvatransferrequest.md): Broadcasts the signed DvA transfer initiate request.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor.
- [Broadcast Cancel DvA Transfer Request](https://docs.tokeny.com/reference/broadcastcanceldvatransfer.md): Broadcasts the signed DvA transfer cancellation request. Only the sender can cancel the transfer.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor.
- [Broadcast Approve DvA Transfer Request](https://docs.tokeny.com/reference/broadcastapprovedvatransferrequest.md): Broadcasts the signed DvA transfer approval request.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Log DvA transfer cancel transaction](https://docs.tokeny.com/reference/logdvatransfercancelrequest.md): Logs the transaction hash of an already broadcast DvA transfer cancellation. This endpoint is used when the transaction was signed and broadcasted to the blockchain.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Log DvA Transfer Approve Transaction](https://docs.tokeny.com/reference/logdvatransferapproverequest.md): Logs the transaction hash of an already broadcast DvA transfer approval. This endpoint is used when the transaction was signed and broadcast through an integrated wallet or external means.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Broadcast Reject DvA Transfer Request](https://docs.tokeny.com/reference/broadcastrejectdvatransferrequest.md): Broadcasts the signed DvA transfer rejection request.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Log DvA Transfer Reject Transaction](https://docs.tokeny.com/reference/logdvatransferrejectrequest.md): Logs the transaction hash of an already broadcast DvA transfer rejection. This endpoint is used when the transaction was signed and broadcasted to the blockchain.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Log DvA Transfer Creation Transaction](https://docs.tokeny.com/reference/logdvatransfercreationtransaction.md): Logs the transaction hash of an already broadcast DvA transfer creation. This endpoint is used when the transaction was signed and broadcasted to the blockchain.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor or a token agent.
- [Increase Allowance](https://docs.tokeny.com/reference/dvaincreaseallowance.md): Increases the allowance for the DvA contract.
π Note that the authentication must provide sufficient privileges to access the information of the token. The user must be a qualified investor.
- [Get all DvA transfers sent by qualified investor for token](https://docs.tokeny.com/reference/fetchdvatransfersmesent.md): Gets all DvA transfers sent by qualified investor (ssoId) for token (tokenId). Filters out DRAFT status transfers.
π Note that the authentication must provide sufficient privileges to access the information of the token.
- [Get all DvA transfers received by qualified investor for token](https://docs.tokeny.com/reference/dvaretrievalnestjscontroller_fetchdvatransfersmereceived.md): Gets all DvA transfers received by qualified investor (ssoId) for token (tokenId). Filters out DRAFT status transfers.
π Note that the authentication must provide sufficient privileges to access the information of the token.
- [Gets all DvA transfers of a token (as an issuer)](https://docs.tokeny.com/reference/dvaretrievalnestjscontroller_fetchdvatransfers.md): Gets all DvA transfers of a token for which the user is an agent or owner
π Note that the authentication must provide management rights over the Issuer. Issuer must be agent or owner of the token.The required permission is TOKEN_MANAGEMENT.
- [Get all DvA transfers the user is an approver](https://docs.tokeny.com/reference/dvaretrievalnestjscontroller_fetchdvatransfersapproverme.md): Gets all DvA transfers for which the user is approver (user should be qualified for the token)
- [Execute an action over an existing claim to a token](https://docs.tokeny.com/reference/executetokenclaimoperation.md): Execute operation to an existing claim.
π Access level: Only owners of the token.
- [Retrieve the token required claims](https://docs.tokeny.com/reference/retrievetokenrequiredclaims.md): Retrieve the token required claims.
π Access level: Only owners of the token.
- [Execute an action on default claims.](https://docs.tokeny.com/reference/executetokendefaultclaimsoperation.md): Execute an action on default claims. Only add operation is accepted.
π Access level: Only owners of the token.
- [Execute an action on a specific default claim.](https://docs.tokeny.com/reference/executetokendefaultoneclaimoperation.md): Execute an action on a specific default claim. Only remove action is accepted.
π Access level: Only owners of the token.
- [Log TransactionHash of the provided required claim action.](https://docs.tokeny.com/reference/logtransactiontokenclaimoperation.md): Log TransactionHash of the provided required claim action.
π Access level: Only owners of the token.
- [Retrieve Token Compliance Rules](https://docs.tokeny.com/reference/retrievetokencompliancerules.md): Retrieves an array of compliance rules for a token.
π Access level: Only agents or owners of the token.
- [Create Token Compliance Rules](https://docs.tokeny.com/reference/createtokencompliancerules.md): Create an object of compliance rules for a token.
π Access level: Only owners of the token.
- [Create Token Compliance Rule Action](https://docs.tokeny.com/reference/createtokencomplianceruleaction.md): Update or delete a token compliance rule.
π Access level: Only owners of the token.
- [Token Compliance Rule Action Operations](https://docs.tokeny.com/reference/tokencomplianceruleactionoperations.md): Cancel a token compliance rule action.
π Access level: Only owners of the token.
- [Log TransactionHash of the Compliance Rule Action Step](https://docs.tokeny.com/reference/logtransactiontokencomplianceruleactionstep.md): Log TransactionHash of the Compliance Rule Action Step.
π Access level: Only owners of the token.
- [Get all workflows created the account](https://docs.tokeny.com/reference/workflowsnestjscontroller_fetchworkflows.md): Gets all workflows created the account (ssoId).
π Note that the authentication must provide sufficient privileges to access the information of the token.
- [(Get payload to) Create a direct transfer.](https://docs.tokeny.com/reference/tokendirecttransfer.md): Creates a new direct transfer workflow and retrieves the transaction payloads that need to be signed to execute the transfer. This is the first step in the direct transfer process.
This endpoint initializes the transfer workflow and generates the necessary transaction payloads based on the provided transfer details. The response includes all data required for the signing process, including the transaction payload that must be cryptographically signed before the transfer can be executed.
The workflow created by this endpoint will need to be completed using subsequent API calls to either submit signed payloads or a transaction hash.
Access level: Qualified token investors only.
- [Log Blockchain Transaction Hash for Direct Transfer](https://docs.tokeny.com/reference/logtransactiontokendirecttransfer.md): Records the blockchain transaction hash for a direct transfer that has already been signed and broadcast to the blockchain. This endpoint logs the transaction hash in the system to track the on-chain confirmation status.
Use this endpoint when the transaction has been broadcast externally and you need to register the transaction hash in the system.
Access level: Qualified investors (transfer initiator only).
- [Submit Signed Transaction Payloads for Direct Transfer](https://docs.tokeny.com/reference/postpayloadstokendirecttransfer.md): Submits signed transaction payloads to be broadcast to the blockchain on behalf of the user. This endpoint accepts cryptographically signed transaction data and broadcasts it to the blockchain network to execute the transfer.
Use this endpoint when you have signed transaction data that needs to be broadcast through the API.
Access level: Qualified investors (transfer initiator only).
- [(Get payload to) Set or update a token allowance for a specific wallet.](https://docs.tokeny.com/reference/tokensetallowance.md): This endpoint allows qualified investors to increase or decrease the allowance for a token to the requested amount.
The endpoint supports different transfer types (default if not specified) and requires the sender address and allowance amount to be provided in the request body. Upon successful execution, it returns a transaction payload that must be signed by the wallet owner.
Access level: Only authenticated qualified investors of the token can set allowances.
- [Retrieve allowances for a specific wallet and token.](https://docs.tokeny.com/reference/gettokenwalletallowances.md): Retrieves current allowances set for a specific wallet address on a token. These allowances authorize other contracts to transfer tokens on behalf of the wallet owner.
Required parameter `senderAddress` specifies the wallet to check. Optional parameters `type` where "DVA" corresponds to Conditional transfers and "DVD" corresponds to Swaps, and `contractAddress` can filter the results. If type is not provided, contractAddress must be specified.
Access level: Authentication required. Available to any authenticated user (agent, owner or qualified investor account).
- [Log a transaction hash for a completed allowance operation.](https://docs.tokeny.com/reference/logallowanceworkflowtasktransactionoperation.md): This endpoint allows users to log a transaction hash for an allowance operation that was signed and submitted externally. It associates the blockchain transaction with the corresponding allowance workflow task in the system.
The request requires the task ID and transaction hash in the request body. This endpoint is typically called after a user has signed and broadcast a transaction to set an allowance.
This endpoint is primarily used with browser wallet such as MetaMask, where the user signs and submits the transaction manually. Logging the transaction is required to reconciliate onchain and offchain flows.
Successful logging of the transaction hash enables the system to track and verify the status of the allowance transaction on the blockchain.
Access level: Only qualified investors of the token who initiated the original allowance transaction can broadcast the transaction payload.
- [Broadcast a signed transaction payload for an allowance operation.](https://docs.tokeny.com/reference/broadcastworkflowtasktransactionpayloadoperation.md): This endpoint broadcasts a signed transaction payload to the blockchain for an allowance operation. It's used when the client wants the server to submit the transaction to the blockchain on their behalf.
The request requires the signed transaction payload in the request body. This endpoint is typically called after a user has signed the transaction payload but wants the server to handle the actual broadcasting to the blockchain network.
This endpoint is primarily used with wallet as API solutions such as our Integrated wallet, where integrators using this endpoint must implement a custom signature system on their side to handle cryptographic signing of the payloads prior to submission.
Successful execution of this endpoint will submit the transaction to the blockchain and track its status, with no additional action required from the client.
Access level: Only qualified investors of the token who initiated the original allowance transaction can broadcast the transaction payload.
- [Retrieve Token Swap Transactions.](https://docs.tokeny.com/reference/retrievetokenswaps.md): Returns all swap transactions (sent or received) associated with a qualified investor for a specific token. The response includes swap status, transaction details, and counterparty information. Filtering options are available for transaction status and date ranges. Draft status swaps are automatically excluded from results.
Access level: Only qualified investors.
- [(Get payload to) Initiate Token Swap Transaction.](https://docs.tokeny.com/reference/initiateswaptransfer.md): Creates a new swap transaction between qualified investors. This endpoint allows users to specify the token pairs, quantities, and counterparty information for the swap. Upon successful creation, returns a complete transaction payload with signing information and workflow tasks.
Swaps can involve any combination of ERC-3643 and ERC-20 tokens. However, for ERC-3643 tokens, both sender and recipient must be qualified and compliant for the specific token. ERC-20 tokens are permissionless and do not require qualification.
Access level: Only qualified investors.
- [(Get payload to) Cancel Pending Swap Transaction.](https://docs.tokeny.com/reference/cancelswaptransfer.md): Cancels an existing swap transaction that has not yet been executed. Only the initiator of the swap can perform the cancellation. Returns the transaction payload that must be signed to confirm the cancellation.
The swap must be in an appropriate state to be cancelled (typically pending or awaiting approval). Authentication requires token access privileges, and the caller must be the original creator of the swap transaction.
Access level: Qualified investors who are the original creators of the swap transaction.
- [(Get payload to) Approve Counterparty Swap Request.](https://docs.tokeny.com/reference/approveswaptransfer.md): Approves a pending swap transaction initiated by another qualified investor. This endpoint allows the counterparty to confirm and execute their side of the swap. Returns the transaction payload that must be signed to complete the approval process.
The swap must be in a pending approval state, and the caller must be the intended counterparty of the swap. Both wallets must maintain compliant status with their respective tokens for successful execution.
Access level: Qualified investors who are the intended counterparty of the swap transaction.
- [(Get payload to) Reject Counterparty Swap Request.](https://docs.tokeny.com/reference/rejectswaptransfer.md): Rejects a pending swap transaction initiated by another qualified investor. This action terminates the swap workflow without execution. Returns the transaction payload that must be signed to confirm the rejection.
Only the intended counterparty of the swap can perform the rejection. The swap must be in a pending approval state. Authentication requires token access privileges, and proper qualified investor status.
Access level: Qualified investors who are the intended counterparty of the swap transaction.
- [Log Blockchain Transaction Hash for Swap](https://docs.tokeny.com/reference/logswapworkflowtasktransactionoperation.md): Records the blockchain transaction hash for a swap that has already been signed and broadcast to the blockchain. This endpoint logs the transaction hash in the system to track the on-chain confirmation status.
Use this endpoint when the transaction has been broadcast externally and you need to register the transaction hash in the system.
Access level: Token agents who are the initiators of the transaction.
- [Submit Signed Transaction Payloads for Swap](https://docs.tokeny.com/reference/broadcastswapworkflowtasktransactionpayloadoperation.md): Submits signed transaction payloads to be broadcast to the blockchain on behalf of the user. This endpoint accepts cryptographically signed transaction data and broadcasts it to the blockchain network to execute the swap.
Use this endpoint when you have signed transaction data that needs to be broadcast through the API.
Access level: Qualified investors who are the initiators of the transaction.
- [Retrieve User By Email](https://docs.tokeny.com/reference/retrieveuserbyemail.md): Retrieve an existing user account details..π Note that the authentication must provide sufficient privileges to access the information of the account.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [Retrieve User ApiKey](https://docs.tokeny.com/reference/retrieveuserapikey.md): Retrieve an existing user account apiKey..
- [Grant distributors access to token data.](https://docs.tokeny.com/reference/enabletokendatafordistributors.md): Enable access to token data for distributors by setting the token to publishable. This endpoint allows token owners to make their token data available to authorized distributors, enabling them to access and use the token's information for distribution purposes.
When a token is marked as publishable, it becomes visible to distributors in the system, allowing them to access the token's metadata, properties, and other relevant information needed for distribution workflows.
Access level: Token owner only.
- [Remove distributors' access to token data.](https://docs.tokeny.com/reference/disabletokendatafordistributors.md): Disable access to token data for distributors by setting the token flag publishable to false. This endpoint allows token owners to revoke previously granted access to their token data from distributors.
When a token's publishable flag is set to false, it will no longer be visible or accessible to distributors in the system, effectively removing their ability to view or use the token's information for distribution purposes.
Access level: Token owner only.
- [Product Fruits HMAC hash retrieval.](https://docs.tokeny.com/reference/productfruitshmachash.md): Get product fruits HMAC hash
- [Initiate a token deployment.](https://docs.tokeny.com/reference/initiatetokendeployment.md): Initiates a token deployment process for the specified token. This is the first step in deploying a token to the blockchain network. The endpoint creates a new deployment workflow and returns necessary information to proceed with the deployment process.
When successfully called, this endpoint generates a deployment workflow with a unique identifier that can be used in subsequent API calls to complete the deployment process. The response includes all necessary information for the next steps in the deployment workflow.
Access level: Only the token issuer can initiate a token deployment.
- [Initiate a token deployment.](https://docs.tokeny.com/reference/initiatetokendeploymentv2.md): Initiates a token deployment process for the specified token. This is the first step in deploying a token to the blockchain network. The endpoint creates a new deployment workflow and returns necessary information to proceed with the deployment process.
When successfully called, this endpoint generates a deployment workflow with a unique identifier that can be used in subsequent API calls to complete the deployment process. The response includes all necessary information for the next steps in the deployment workflow.
Access level: Only the token issuer can initiate a token deployment.
- [Create blockchain subscription](https://docs.tokeny.com/reference/createblockchainsubscription.md): Create subscription for a wallet to manually sign blockchain transactions.
π Note that the requester must be either qualified or agent/owner for the wallet address.
- [Test subscription message](https://docs.tokeny.com/reference/testsubscriptionmessage.md): Test subscription message for a wallet
- [Broadcast signed blockchain transactions](https://docs.tokeny.com/reference/broadcastblockchaintransaction.md): Post signed transactions to be emitted through BES π Note that the authentication must provide sufficient privileges to access the information of the account. The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [Unsubscribe from blockchain subscriptions](https://docs.tokeny.com/reference/removeblockchainsubscription.md): Remove all blockchain subscriptions for a wallet address to stop it from manually signing blockchain transactions.
Access level: the requester must be token agent or owner.
- [Mint Tokens to Wallets](https://docs.tokeny.com/reference/minttokenstowalletsv2.md): `Mint` a specified amount of token to the given wallets.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Burn Tokens from Wallets](https://docs.tokeny.com/reference/burntokensfromwalletsv2.md): `Burn` a specified amount of token from the given wallets.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Force Transfer Tokens to Wallets](https://docs.tokeny.com/reference/forcetransfertokenstowalletsv2.md): Initiate a group of `force transfers` of a token between wallets. A force transfer is a movement of tokens from one wallet to another without any compliance restraint.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Pause a token](https://docs.tokeny.com/reference/pauseatokenv2.md): `Pause` a given token to temporarily disable all token operations.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Unpause Token](https://docs.tokeny.com/reference/unpausetokenv2.md): `Unpause` the token to resume all token operations.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Block Tokens from Wallets](https://docs.tokeny.com/reference/blocktokensfromwalletsv2.md): `Block` a specified amount of token from the given wallets.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Unblock Tokens from Wallets](https://docs.tokeny.com/reference/unblocktokensfromwalletsv2.md): `Unblock` a specified amount of token from the given wallets.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Block a set of wallets](https://docs.tokeny.com/reference/blockwalletsv2.md): `Block` a set of wallets to prevent them from performing token operations.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN or INTEGRATED wallets: Executes the operation directly and returns only the token action ID
- [Unblock a set of wallets](https://docs.tokeny.com/reference/unblockwalletsv2.md): `Unblock` a set of wallets to allow them to resume token operations.
π Access level: Please note that the user must be agent of the token.
The response format depends on the wallet provider type:
- For non-custodian USER_MANAGED or INTEGRATED wallets: Returns transaction data that must be signed and broadcasted by the client
- For EXTERNAL_CUSTODIAN wallets: Executes the operation directly and returns only the token action ID
- [Log Blockchain Transaction Hash for Token Action](https://docs.tokeny.com/reference/tokenactionslogworkflowtasktransaction.md): Records the blockchain transaction hash for a token action that has already been signed and broadcast to the blockchain. This endpoint logs the transaction hash in the system to track the on-chain confirmation status.
Use this endpoint when the transaction has been broadcast externally and you need to register the transaction hash in the system.
π Access level: Only agents of the token. User must be the initiator of the transaction.
- [Submit Signed Transaction Payloads for Token Action](https://docs.tokeny.com/reference/broadcasttokenactionspayloadoperation.md): Submits signed transaction payloads to be broadcast to the blockchain on behalf of the user. This endpoint accepts cryptographically signed transaction data and broadcasts it to the blockchain network.
Use this endpoint when you have signed transaction data that needs to be broadcast through the API.
π Access level: Only agents of the token. User must be the initiator of the transaction.
- [Get Private Swagger v2](https://docs.tokeny.com/reference/getprivateswaggerv2.md): Fetch the complete list of Swagger endpoints in JSON format.
π Note that the authentication must provide sufficient privileges to access the information of the account.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [Get Public Swagger v2](https://docs.tokeny.com/reference/getpublicswaggerv2.md): Fetch the complete list of `public` Swagger endpoints in JSON format.
π Note that the authentication must provide sufficient privileges to access the information of the account.The READ_OPERATIONS permission is currently the only permission the API_KEY should be granted.
- [Create a token subscription with an interval](https://docs.tokeny.com/reference/subscriptioncreationv2.md): Create a new token subscription with an interval
π Note that the authentication must provide administrative privileges. The required permission is OWNER.
- [Retrieve subscriptions for a token.](https://docs.tokeny.com/reference/subscriptionretrievalv2.md): Fetch all subscription configurations related to the token.
- [Delete a subscription](https://docs.tokeny.com/reference/subscriptiondeletionv2.md): Delete an existing token subscription by its ID.
π Note that the authentication must provide administrative privileges. The required permission is OWNER.
- [Update a subscription](https://docs.tokeny.com/reference/subscriptionupdatev2.md): Update an existing subscription
π Note that the authentication must provide administrative privileges. The required permission is OWNER.
- [Create projects for a marketplace](https://docs.tokeny.com/reference/createtokenproject.md): Create projects for a marketplace that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Delete a project for a Token](https://docs.tokeny.com/reference/deletetokenproject.md): Delete a project for a Token that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Update project for a token](https://docs.tokeny.com/reference/updatetokenproject.md): Update projects for a Token that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
π Due the interaction with an external product, the request DTO is very different. We will prepare a specific Document for the different fields and structures to use.
- [Retrieve a project for a marketplace](https://docs.tokeny.com/reference/retrievetokenproject.md): Retrieve the project linked to a token that the logged user has authorization
π Note that the authentication must provide sufficient privileges to access the information of the holder. The HOLDER_MANAGEMENT permissions grant full access to the data. Otherwise information returned are limited to the ones defined in the access grant.
- [Get projects for a investor portal the investor is authorized to manage.](https://docs.tokeny.com/reference/getmarketplaceprojectsinvestorportalretrieval.md): Get projects for a investor portal the investor is authorized to manage.
- [Fetch all redemptions for a token](https://docs.tokeny.com/reference/getredemptionsforatokenv2.md): Allow an agent or account linked to tokenId to fetch all redemption configurations for a token.
- [Create a redemption](https://docs.tokeny.com/reference/createredemptionv2.md): Allow an agent or an issuer to create a redemption configuration by id. Note that the account must be token admin.
- [Delete a redemption](https://docs.tokeny.com/reference/deleteredemptionv2.md): Allows an issuer or account linked to the token to delete a redemption by its ID. The account must be the OWNER of the token.
- [Update a redemption configuration](https://docs.tokeny.com/reference/updateredemptionv2.md): Update a redemption configuration with PATCH semantics (partial updates). Account must be token OWNER of the tokenId linked to that redemptionId.
Calendar handling:
- Send UUID to replace/add current calendar with that calendar
- Send parameters to create/update calendar with those parameters
- Send empty object {} to unlink calendar
For arrays like paymentCurrency, the full array is replaced. For objects like orderFormSettings and calendar, the full object is replaced.
- [Create a token.](https://docs.tokeny.com/reference/createatoken.md): Create a new token.
π Note that the authentication must provide sufficient privileges to access the information of the token. Only token owners are able to update the token information.The ISSUER_MANAGEMENT permission over the owner issuer is currently the only permission (aside administration privileges) required to access the Token data.