> ## Documentation Index > Fetch the complete documentation index at: https://docs.dfns.co/llms.txt > Use this file to discover all available pages before exploring further. # List Vault History > Lists a vault's history, most recent first: one item per incoming or outgoing transfer, carrying its current status, and one per lock creation or deletion. #### Authentication ✅ Organization User (`CustomerEmployee`)\ ❌ Delegated User (`EndUser`)\ ✅ Service Account #### Required Permissions `Vaults:Read`: Always required. ## OpenAPI ````yaml /openapi.yaml get /vaults/{vaultId}/history openapi: 3.1.0 info: version: 2.0.211 title: Dfns servers: - url: https://api.dfns.io description: Default - Europe - url: https://api.uae.dfns.io description: UAE - url: https://api.dfns.ninja description: Staging security: [] paths: /vaults/{vaultId}/history: get: tags: - Vaults summary: List Vault History description: >- Lists a vault's history, most recent first: one item per incoming or outgoing transfer, carrying its current status, and one per lock creation or deletion. operationId: listVaultHistory parameters: - schema: type: string minLength: 1 maxLength: 64 pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault id. required: true description: Vault id. name: vaultId in: path - schema: type: integer minimum: 1 maximum: 500 default: 50 description: Maximum number of items to return. required: false description: Maximum number of items to return. name: limit in: query - schema: type: string minLength: 1 description: >- Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. required: false description: >- Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. name: paginationToken in: query - schema: anyOf: - type: string enum: - ArbitrumOne - ArbitrumSepolia - Arc - ArcTestnet - Areum - AvalancheC - AvalancheCFuji - Base - BaseSepolia - Berachain - BerachainBepolia - Bitcoin - BitcoinSignet - BitcoinTestnet4 - Bob - BobSepolia - Bsc - BscTestnet - Celo - CeloSepolia - Codex - CodexSepolia - Ethereum - EthereumClassic - EthereumClassicMordor - EthereumSepolia - EthereumHoodi - FlareC - FlareCCoston2 - FlowEvm - FlowEvmTestnet - Ink - InkSepolia - Monad - MonadTestnet - Optimism - OptimismSepolia - Plasma - PlasmaTestnet - Plume - PlumeSepolia - Polygon - PolygonAmoy - Rayls - RaylsTestnet - Robinhood - RobinhoodSepolia - SeiAtlantic2 - SeiPacific1 - Solana - SolanaDevnet - Sonic - SonicTestnet - Tempo - TempoModerato - Tsc - TscTestnet1 - Xdc - XdcApothem - XLayer - XLayerSepolia - type: array items: type: string enum: - ArbitrumOne - ArbitrumSepolia - Arc - ArcTestnet - Areum - AvalancheC - AvalancheCFuji - Base - BaseSepolia - Berachain - BerachainBepolia - Bitcoin - BitcoinSignet - BitcoinTestnet4 - Bob - BobSepolia - Bsc - BscTestnet - Celo - CeloSepolia - Codex - CodexSepolia - Ethereum - EthereumClassic - EthereumClassicMordor - EthereumSepolia - EthereumHoodi - FlareC - FlareCCoston2 - FlowEvm - FlowEvmTestnet - Ink - InkSepolia - Monad - MonadTestnet - Optimism - OptimismSepolia - Plasma - PlasmaTestnet - Plume - PlumeSepolia - Polygon - PolygonAmoy - Rayls - RaylsTestnet - Robinhood - RobinhoodSepolia - SeiAtlantic2 - SeiPacific1 - Solana - SolanaDevnet - Sonic - SonicTestnet - Tempo - TempoModerato - Tsc - TscTestnet1 - Xdc - XdcApothem - XLayer - XLayerSepolia description: >- Only items on these networks. Repeat the parameter to pass several. required: false description: Only items on these networks. Repeat the parameter to pass several. name: network in: query - schema: anyOf: - type: string - type: array items: type: string description: >- Only items moving these assets, by token identifier. Repeat the parameter to pass several. Combine with `network`, as a token identifier can exist on several networks. required: false description: >- Only items moving these assets, by token identifier. Repeat the parameter to pass several. Combine with `network`, as a token identifier can exist on several networks. name: tid in: query - schema: anyOf: - type: string enum: - IncomingTransfer - OutgoingTransfer - LockCreated - LockDeleted description: Vault history item kind. - type: array items: type: string enum: - IncomingTransfer - OutgoingTransfer - LockCreated - LockDeleted description: Vault history item kind. description: Only items of these kinds. Repeat the parameter to pass several. required: false description: Only items of these kinds. Repeat the parameter to pass several. name: kind in: query responses: '200': description: Success content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/VaultHistoryEvent' description: Current page items. nextPageToken: type: string description: >- token to use as `paginationToken` to request the next page. required: - items security: - authenticationToken: [] components: schemas: VaultHistoryEvent: oneOf: - type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^vlt-evt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The ledger event that opened this item. example: vlt-evt-3u8g0-s3s4u-a9ic2otj312313kn vaultId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault id. example: vlt-5vbsp-u62g1-ostmunqgds5o9tc2 walletId: type: string minLength: 1 maxLength: 64 pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The vault wallet the item is on. example: wa-5pfuu-9euek-h0odgb6snva8ph3k timestamp: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the item was opened: the deposit, the transfer request or the lock event. example: '2023-04-14T20:41:28.715Z' network: $ref: '#/components/schemas/Network' tid: type: string description: >- The token identifier of the asset moved (e.g. `native:eth`, `erc20:0x...`). amount: type: string pattern: ^\d+$ description: >- The amount moved, in minimum denomination: deposited for incoming transfers, sent for outgoing transfers, locked or unlocked for lock kinds. kind: type: string enum: - IncomingTransfer status: type: string enum: - Quarantined - PendingPolicyApproval - Released description: >- `Quarantined` until a release is requested, `PendingPolicyApproval` while the release awaits policy approval, `Released` once the funds are available. quarantine: $ref: '#/components/schemas/VaultQuarantine' incomingTransfer: $ref: '#/components/schemas/VaultHistoryIncomingTransfer' required: - id - vaultId - walletId - timestamp - network - tid - amount - kind - status - quarantine - incomingTransfer additionalProperties: false title: Incoming Transfer - type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^vlt-evt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The ledger event that opened this item. example: vlt-evt-3u8g0-s3s4u-a9ic2otj312313kn vaultId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault id. example: vlt-5vbsp-u62g1-ostmunqgds5o9tc2 walletId: type: string minLength: 1 maxLength: 64 pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The vault wallet the item is on. example: wa-5pfuu-9euek-h0odgb6snva8ph3k timestamp: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the item was opened: the deposit, the transfer request or the lock event. example: '2023-04-14T20:41:28.715Z' network: $ref: '#/components/schemas/Network' tid: type: string description: >- The token identifier of the asset moved (e.g. `native:eth`, `erc20:0x...`). amount: type: string pattern: ^\d+$ description: >- The amount moved, in minimum denomination: deposited for incoming transfers, sent for outgoing transfers, locked or unlocked for lock kinds. kind: type: string enum: - OutgoingTransfer status: type: string enum: - PendingPolicyApproval - InProgress - Confirmed - Failed - Rejected description: >- `PendingPolicyApproval` while the transfer awaits policy approval, `InProgress` while it is being executed or awaits on-chain confirmation, then the settled outcome of the transfer. transferRequest: $ref: '#/components/schemas/TransferRequest' lock: allOf: - $ref: '#/components/schemas/VaultLock' - description: >- Set when the transfer sends locked funds: the lock they come from. required: - id - vaultId - walletId - timestamp - network - tid - amount - kind - status - transferRequest additionalProperties: false title: Outgoing Transfer - type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^vlt-evt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The ledger event that opened this item. example: vlt-evt-3u8g0-s3s4u-a9ic2otj312313kn vaultId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault id. example: vlt-5vbsp-u62g1-ostmunqgds5o9tc2 walletId: type: string minLength: 1 maxLength: 64 pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The vault wallet the item is on. example: wa-5pfuu-9euek-h0odgb6snva8ph3k timestamp: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the item was opened: the deposit, the transfer request or the lock event. example: '2023-04-14T20:41:28.715Z' network: $ref: '#/components/schemas/Network' tid: type: string description: >- The token identifier of the asset moved (e.g. `native:eth`, `erc20:0x...`). amount: type: string pattern: ^\d+$ description: >- The amount moved, in minimum denomination: deposited for incoming transfers, sent for outgoing transfers, locked or unlocked for lock kinds. kind: type: string enum: - LockCreated - LockDeleted lock: $ref: '#/components/schemas/VaultLock' required: - id - vaultId - walletId - timestamp - network - tid - amount - kind - lock additionalProperties: false title: Lock description: >- Vault history item: an incoming or outgoing transfer with its current status, or a lock event, with the related quarantine, transfer request or lock embedded. Network: type: string title: Network enum: - Algorand - AlgorandTestnet - Aptos - AptosTestnet - ArbitrumOne - ArbitrumSepolia - Arc - ArcTestnet - Areum - AvalancheC - AvalancheCFuji - Base - BaseSepolia - Berachain - BerachainBepolia - Bitcoin - BitcoinSignet - BitcoinTestnet4 - BitcoinCash - Bob - BobSepolia - Bsc - BscTestnet - Canton - CantonTestnet - Cardano - CardanoPreprod - Concordium - ConcordiumTestnet - Celo - CeloSepolia - Codex - CodexSepolia - CosmosHub4 - CosmosIcsTestnet - Dogecoin - DogecoinTestnet - Ethereum - EthereumClassic - EthereumClassicMordor - EthereumSepolia - EthereumHoodi - FlareC - FlareCCoston2 - FlowEvm - FlowEvmTestnet - Hedera - HederaTestnet - Ink - InkSepolia - InternetComputer - Ion - IonTestnet - Iota - IotaTestnet - Kusama - KusamaAssetHub - Litecoin - LitecoinTestnet - Monad - MonadTestnet - Movement - MovementTestnet - Near - NearTestnet - Optimism - OptimismSepolia - Origyn - Plasma - PlasmaTestnet - Plume - PlumeSepolia - Paseo - PaseoAssetHub - Polkadot - PolkadotAssetHub - Polygon - PolygonAmoy - Polymesh - PolymeshTestnet - Rayls - RaylsTestnet - Robinhood - RobinhoodSepolia - SeiAtlantic2 - SeiPacific1 - Solana - SolanaDevnet - Sonic - SonicTestnet - Starknet - StarknetSepolia - Stellar - StellarTestnet - Sui - SuiTestnet - Tezos - TezosShadownet - Tempo - TempoModerato - Tsc - TscTestnet1 - Ton - TonTestnet - Tron - TronNile - Westend - WestendAssetHub - Xdc - XdcApothem - XLayer - XLayerSepolia - XrpLedger - XrpLedgerTestnet VaultQuarantine: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^vlt-qua-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault quarantine id. example: vlt-qua-7ein9-uptvv-uuegt9p5n69ocs4q vaultId: type: string network: type: string transactionHash: type: string description: The transaction that deposited the quarantined funds. kytResult: oneOf: - type: object properties: provider: type: string enum: - Chainalysis transferReference: type: string providerUserId: type: string description: >- Grouping key registered with the provider ("userId" in Chainalysis terms). externalId: type: string description: Provider-side id of the registered transfer. alerts: type: array items: type: object properties: level: type: string enum: - Low - Medium - High - Severe categoryId: type: - number - 'null' required: - level - categoryId exposure: type: object properties: direct: type: object properties: categoryId: type: - number - 'null' name: type: - string - 'null' required: - categoryId - name required: - direct maxAlertLevel: type: - string - 'null' enum: - Low - Medium - High - Severe required: - provider - transferReference - providerUserId - externalId - alerts - exposure - maxAlertLevel title: Chainalysis KYT Result - type: object properties: provider: type: string enum: - Elliptic transferReference: type: string providerUserId: type: string description: >- Grouping key registered with the provider ("userId" in Chainalysis terms). externalId: type: string description: Provider-side id of the registered transfer. alerts: type: array items: type: object properties: categoryId: type: - string - 'null' required: - categoryId riskScore: type: - number - 'null' required: - provider - transferReference - providerUserId - externalId - alerts - riskScore title: Elliptic KYT Result description: >- KYT screening result recorded for the quarantined deposit, when available. Policies of rule kind `ChainalysisQuarantineScreening` evaluate this stored result when the release is requested. dateReleased: type: string format: date-time description: >- Set when the quarantined funds have been released into the available balance. dateCreated: type: string format: date-time required: - id - vaultId - network - transactionHash - dateCreated additionalProperties: false description: >- Vault quarantine object: an incoming deposit held out of the available balance until released. VaultHistoryIncomingTransfer: type: object properties: txHash: type: string index: type: string senders: type: array items: type: string description: >- The addresses the funds came from. Empty when the on-chain transfer could not be resolved. asset: type: object properties: symbol: type: string decimals: type: integer description: >- Number of decimals used by the asset, see [this guide](https://docs.dfns.co/guides/developers/displaying-balances) for more details. verified: type: boolean description: Whether the asset is verified by DFNS as legitimate. quotes: type: object properties: EUR: type: number USD: type: number description: Corresponding asset price in USD at the time of transfer. required: - txHash - senders additionalProperties: false TransferRequest: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^xfr-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Transfer id. example: xfr-20g4k-nsdpo-mg6arrifgvid4orn walletId: type: string minLength: 1 maxLength: 64 pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The source wallet for this tranfer. example: wa-5pfuu-9euek-h0odgb6snva8ph3k network: allOf: - $ref: '#/components/schemas/Network' - description: The blockchain network this transfer is on. requester: $ref: '#/components/schemas/Requester' requestBody: oneOf: - type: object properties: kind: type: string enum: - Native to: type: string description: The destination address. amount: type: string pattern: ^\d+$ description: >- The amount of native tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag (supported networks only). priority: type: string enum: - Slow - Standard - Fast description: >- The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. createDestinationAccount: type: boolean description: >- Whether to create the destination account on chains that require account creation (e.g., Stellar). Only valid for chains that require the receiver account to exist before transfer. offer: type: boolean description: >- Optional field for Canton, if true it will create a transfer offer. expiresAt: type: string format: date-time description: >- Optional field for Canton, especially useful in the context of offers useDurableNonce: type: boolean description: >- Optional Solana-only flag. When `true` the SOL transfer is built as a durable-nonce transaction using one of the wallet's nonce accounts (picked server-side). Use this for offline-signing flows where the construct → broadcast gap may exceed 90 seconds. The wallet's nonce account pool must be pre-populated via `POST /wallets/{id}/transactions` with `kind: CreateSolanaNonceAccounts`. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j structured: type: object additionalProperties: {} required: - kind - to - amount additionalProperties: false title: Native Asset - type: object properties: kind: type: string enum: - Erc20 contract: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The ERC-20 contract address. to: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. priority: type: string enum: - Slow - Standard - Fast description: The priority that determines the fees paid for the transfer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j structured: type: object additionalProperties: {} required: - kind - contract - to - amount additionalProperties: false title: EVM Fungible Token (ERC-20) - type: object properties: kind: type: string enum: - Aip21 metadata: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: 'The asset metadata address. ' to: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - metadata - to - amount additionalProperties: false description: >- Transfer Aptos fungible asset that implement the [AIP-21 specification](https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-21.md). title: Aptos Fungible Asset (AIP-21) - type: object properties: kind: type: string enum: - Asa assetId: type: string pattern: ^\d+$ description: 'The token asset id. ' to: type: string pattern: ^[A-Z0-9]{58}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - assetId - to - amount additionalProperties: false description: >- Transfer Algorand standard assets, or [ASAs](https://developer.algorand.org/docs/get-details/asa/). title: Algorand Standard Asset - type: object properties: kind: type: string enum: - Asset assetId: type: string description: 'The token asset id. ' to: type: string description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - assetId - to - amount additionalProperties: false description: >- Transfer Cardano assets following [Mary update](https://docs.cardano.org/about-cardano/evolution/upgrades/mary) title: Cardano Asset - type: object properties: kind: type: string enum: - Cip56 instrumentAdmin: type: string pattern: ^[a-zA-Z0-9-_]*::1220[a-f0-9]{64}$ description: The instrument admin address. instrumentId: type: string description: The instrument id. to: type: string pattern: ^[a-zA-Z0-9-_]*::1220[a-f0-9]{64}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo, recorded as the transfer reason on the ledger. offer: type: boolean description: If true it will create a transfer offer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - instrumentAdmin - instrumentId - to - amount additionalProperties: false description: >- Transfer standard tokens that implement the [CIP-56 specification](https://github.com/global-synchronizer-foundation/cips/blob/main/cip-0056/cip-0056.md). title: Canton Standard Token (CIP-56) - type: object properties: kind: type: string enum: - Cis2 to: type: string pattern: ^[1-9A-HJ-NP-Za-km-z]{50}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. tokenAddress: type: string description: >- The token address following (https://proposals.concordium.com/CIS/cis-2.html#token-address). externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - to - amount - tokenAddress additionalProperties: false description: >- Transfer tokens that implement the [CIS-2 specification](https://proposals.concordium.software/CIS/cis-2.html). title: CIS-2 Standard - type: object properties: kind: type: string enum: - Cis7 to: type: string pattern: ^[1-9A-HJ-NP-Za-km-z]{50}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. tokenId: type: string description: The Cis7 token identifier. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - to - amount - tokenId additionalProperties: false description: >- Transfer Concordium protocol level tokens. (https://proposals.concordium.com/CIS/cis-7.html#cis-7-protocol-level-tokens-plts) title: Concordium Protocol Level Token (CIS-7) - type: object properties: kind: type: string enum: - Coin coin: type: string description: The coin identifier. to: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - coin - to - amount additionalProperties: false description: >- Transfer Sui fungible assets that implement [coin standard](https://docs.sui.io/standards/coin). title: Sui Coin - type: object properties: kind: type: string enum: - Erc721 contract: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The ERC-721 contract address. to: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The destination address. tokenId: type: string pattern: ^\d+$ description: The token to transfer. priority: type: string enum: - Slow - Standard - Fast description: The priority that determines the fees paid for the transfer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - tokenId additionalProperties: false description: >- Transfer non-fungible tokens that implement the [ERC-721 specification](https://eips.ethereum.org/EIPS/eip-721) title: EVM Non Fungible Token (ERC-721) - type: object properties: kind: type: string enum: - Erc7984 contract: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The ERC-7984 confidential token contract address. to: type: string pattern: ^0x[0-9a-fA-F]{40}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. priority: type: string enum: - Slow - Standard - Fast description: The priority that determines the fees paid for the transfer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - amount additionalProperties: false description: >- Transfer confidential tokens that implement the [ERC-7984 specification](https://eips.ethereum.org/EIPS/eip-7984). The transfer amount is encrypted on-chain using Fully Homomorphic Encryption (FHE). title: EVM Confidential Token (ERC-7984) - type: object properties: kind: type: string enum: - Hip17 tokenId: type: string description: The token to transfer. serialNumber: type: string pattern: ^\d+$ to: type: string pattern: >- ^(0x[0-9a-fA-F]{40}|0\.0\.(\d+|[0-9a-fA-F]{40}|[0-9a-fA-F]{64,}))$ description: The destination address. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - tokenId - serialNumber - to additionalProperties: false description: '' title: Hedera Non-Fungible Token (HIP-17) - type: object properties: kind: type: string enum: - Hts tokenId: type: string description: The token to transfer. to: type: string pattern: >- ^(0x[0-9a-fA-F]{40}|0\.0\.(\d+|[0-9a-fA-F]{40}|[0-9a-fA-F]{64,}))$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - tokenId - to - amount additionalProperties: false description: '' title: Hedera Tokens (HTS) - type: object properties: kind: type: string enum: - Iou currency: type: string description: The IOU currency code. issuer: type: string pattern: ^r[1-9A-HJ-NP-Za-km-z]{24,34}$ description: The IOU issuer address. to: type: string pattern: ^r[1-9A-HJ-NP-Za-km-z]{24,34}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - currency - issuer - to - amount additionalProperties: false description: >- Transfer XRPL IOU tokens with specified currency and issuer. (https://xrpl.org/docs/concepts/tokens/fungible-tokens/trust-line-tokens) title: XRPL IOU Token - type: object properties: kind: type: string enum: - Sep41 issuer: type: string pattern: ^(G[A-Z0-9]{55}|M[A-Z0-9]{68})$ description: The asset issuer address. assetCode: type: string description: The asset code. to: type: string pattern: ^(G[A-Z0-9]{55}|M[A-Z0-9]{68})$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - issuer - assetCode - to - amount additionalProperties: false description: >- Transfer classic [Stellar Assets](https://developers.stellar.org/docs/issuing-assets/anatomy-of-an-asset). They all implement the [SEP-41 token interface](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0041.md). title: Stellar Classic Assets (SEP-41) - type: object properties: kind: type: string enum: - Snip2 contract: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The SNIP-2 (ERC-20-like) contract address. to: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - amount additionalProperties: false description: >- Transfer fungible tokens that implement the [SNIP-2 (ERC-20-like) specification](https://github.com/starknet-io/SNIPs/blob/ea46a8777d8c8d53a43f45b7beb1abcc301a1a69/SNIPS/snip-2.md). title: Starknet SNIP-2 (ERC-20 like) - type: object properties: kind: type: string enum: - Snip3 contract: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The SNIP-3 (ERC-721) contract address. to: type: string pattern: ^0x[0-9a-fA-F]{64}$ description: The destination address. tokenId: type: string pattern: ^\d+$ description: The token to transfer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - tokenId additionalProperties: false description: >- Transfer non-fungible tokens that implement the [SNIP-3 (ERC-721-like) specification](https://github.com/starknet-io/SNIPs/blob/ea46a8777d8c8d53a43f45b7beb1abcc301a1a69/SNIPS/snip-3.md) title: Starknet SNIP-3 (ERC-721-like) - type: object properties: kind: type: string enum: - Spl - Spl2022 to: type: string pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. mint: type: string pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$ description: The mint account address. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. createDestinationAccount: type: boolean description: >- If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. useDurableNonce: type: boolean description: >- Optional. When `true` the SPL transfer is built as a durable-nonce transaction using one of the wallet's nonce accounts (picked server-side). The wallet's nonce account pool must be pre-populated via `POST /wallets/{id}/transactions` with `kind: CreateSolanaNonceAccounts`. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j structured: type: object additionalProperties: {} required: - kind - to - amount - mint additionalProperties: false title: Solana Program Library Token (SPL and SPL 2022) - type: object properties: kind: type: string enum: - Tep74 to: type: string pattern: ^(?:[A-Za-z0-9\-_]{48}|\d+:[a-fA-F0-9]{64})$ description: The destination address. master: type: string pattern: ^(?:[A-Za-z0-9\-_]{48}|\d+:[a-fA-F0-9]{64})$ description: The Jetton master contract address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - to - master - amount additionalProperties: false description: >- Transfer [Jetton](https://github.com/ton-blockchain/TEPs/blob/master/text/0074-jettons-standard.md) tokens. title: TON Jetton (TEP-74) - type: object properties: kind: type: string enum: - Trc10 tokenId: type: string pattern: ^\d+$ description: The token ID. to: type: string pattern: ^T[1-9A-HJ-NP-Za-km-z]{33}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - tokenId - to - amount additionalProperties: false description: Transfer TRON's TRC-10 fungible tokens title: TRON Native Fungible Token (TRC-10) - type: object properties: kind: type: string enum: - Trc20 contract: type: string pattern: ^T[1-9A-HJ-NP-Za-km-z]{33}$ description: The smart contract address. to: type: string pattern: ^T[1-9A-HJ-NP-Za-km-z]{33}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - amount additionalProperties: false description: >- Transfer fungible tokens that implement the TRC-20 smart contract specification. title: TRON Smart Contract Fungible Token (TRC-20) - type: object properties: kind: type: string enum: - Trc721 contract: type: string pattern: ^T[1-9A-HJ-NP-Za-km-z]{33}$ description: The smart contract address. to: type: string pattern: ^T[1-9A-HJ-NP-Za-km-z]{33}$ description: The destination address. tokenId: type: string pattern: ^\d+$ description: The token to transfer. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - contract - to - tokenId additionalProperties: false description: >- Transfer non-fungible tokens that implement the TRC-721 smart contract specification. title: TRON Non Fungible Token (TRC-721) - type: object properties: kind: type: string enum: - Xls33 issuanceId: type: string description: The XLS-33 issuance identifier. to: type: string pattern: ^r[1-9A-HJ-NP-Za-km-z]{24,34}$ description: The destination address. amount: type: string pattern: ^\d+$ description: The amount of tokens to transfer in minimum denomination. memo: anyOf: - type: string maxLength: 64 pattern: ^[a-zA-Z0-9]+$ - type: string enum: - '' description: The memo or destination tag. externalId: type: string minLength: 1 maxLength: 50 description: >- A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) travelRule: oneOf: - type: object properties: kind: type: string enum: - Notabene beneficiaryVASPdid: type: string beneficiaryProof: type: object additionalProperties: {} originator: type: object additionalProperties: {} beneficiary: type: object additionalProperties: {} required: - kind - originator - beneficiary additionalProperties: false title: Notabene Travel Rule - type: object properties: kind: type: string enum: - Sumsub required: - kind additionalProperties: false title: Sumsub Travel Rule description: >- A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) example: fs-5vqdl-gliqk-b4rfukqauov1sp7j required: - kind - issuanceId - to - amount additionalProperties: false description: >- Transfer XRPL XLS-33 Token with specified issuance ID. (https://xrpl.org/docs/concepts/tokens/fungible-tokens/multi-purpose-tokens title: XRPL XLS-33 Token metadata: type: object properties: asset: type: object properties: symbol: type: string decimals: type: integer description: >- Number of decimals used by the asset, see [this guide](https://docs.dfns.co/guides/developers/displaying-balances) for more details. verified: type: boolean description: Whether the asset is verified by DFNS as legitimate. quotes: type: object properties: EUR: type: number USD: type: number description: Corresponding asset price in USD at the time of transfer. required: - asset description: Additional metadata about the transfered asset. status: type: string enum: - Pending - Executing - Broadcasted - Confirmed - Failed - Rejected description: >- Transfer status. | Status | Definition | | --- | --- | | `Pending` | The request is pending approval due to a policy applied to the wallet. | | `Executing` | The request is approved and is in the process of being executed. note this status is only set for a short time between pending and broadcasted. | | `Broadcasted` | The transaction has been successfully written to the mempool. | | `Confirmed` | The transaction has been confirmed on-chain by our indexing pipeline. | | `Failed` | Indicates either system failure to complete the request or the transaction failed on chain. | | `Rejected` | The request has been rejected by a policy approval action. | reason: type: string description: The reason for a failed transfer. txHash: type: string description: The blockchain transaction hash for this transfer. fee: type: string description: The fee paid for this transfer in minimum denomination. dateRequested: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the transfer was requested. example: '2023-04-14T20:41:28.715Z' datePolicyResolved: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the transfer was approved by policy reviewers. example: '2023-04-14T20:41:28.715Z' dateBroadcasted: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the transfer was broadcasted to the blockchain. example: '2023-04-14T20:41:28.715Z' dateConfirmed: type: string format: date-time description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date (must be UTC). When the transfer was confirmed on chain. example: '2023-04-14T20:41:28.715Z' approvalId: type: string minLength: 1 maxLength: 64 pattern: ^ap-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The id of the approval request if this transfer triggered a policy. example: ap-2a9in-tt2a1-983lho480p35ejd0 externalId: type: string description: The external id provided at transfer creation time. feeSponsorId: type: string minLength: 1 maxLength: 64 pattern: ^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The fee sponsor id used to pay for the transfer fees. example: fs-5vqdl-gliqk-b4rfukqauov1sp7j replacementId: type: string description: >- The id of the replacement transaction (cancel or speed-up) issued for this transfer. details: type: object additionalProperties: {} description: >- Structured representation of the data used to construct the signature (e.g. nonce, gas parameters). Shape is blockchain specific. required: - id - walletId - network - requester - requestBody - metadata - status - dateRequested VaultLock: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Vault lock id. example: vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j vaultId: type: string network: type: string tid: type: string amount: type: string owner: type: string description: >- The user that created the lock. Only this user can update or delete it. externalId: type: string reason: type: string description: The reason or note the lock was created with. beneficiary: type: string description: >- The address the locked funds are sent to on transfer. Set at creation and inherited on update. transferId: type: string description: >- Set when the owner transferred the lock: the outgoing transfer sending `transferAmount` of the locked funds to the beneficiary. The funds stay locked until that transfer is confirmed, which deletes the lock. Cleared if the transfer fails, so the lock can be transferred again. transferAmount: type: string description: >- Set with `transferId`: the amount being sent to the beneficiary, in minimum denomination. The remainder of the locked amount returns to the available balance when the lock is deleted. replacesLockId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: 'Set when this lock was created by an update: the lock it replaces.' example: vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j replacedByLockId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Set when this lock was released by an update: the lock that replaced it. example: vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j dateCreated: type: string format: date-time dateDeleted: type: string format: date-time required: - id - vaultId - network - tid - amount - owner - dateCreated additionalProperties: false description: >- Vault lock object: funds manually locked for off-chain settlement or escrow. The owner can release them back to the vault or transfer them to the beneficiary. Requester: type: object properties: userId: type: string minLength: 1 maxLength: 64 pattern: ^us-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: User id. example: us-6b58p-r53sr-rlrd3l5cj3uc4ome tokenId: type: string minLength: 1 maxLength: 64 pattern: ^to-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Token id. example: to-202a0-cdo33-o65mbt6q758lvvnt required: - userId description: The user who initiated the request. securitySchemes: authenticationToken: type: http scheme: bearer bearerFormat: JWT description: >- **Bearer Token:** Used to authenticate API requests. More details how to generate the token: [Authentication flows](https://docs.dfns.co/api-reference/auth/login-flows) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.