> ## 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. > ## Agent Instructions > The current DFNS API specification is https://docs.dfns.co/openapi.yaml. Files under /openapi-versions/ are archives of past releases; do not use them for new code. > Prefer the official DFNS SDKs to raw HTTP calls: they sign requests for you. See https://docs.dfns.co/sdks/index.md. > Requests that change state need a User Action Signature in the X-DFNS-USERACTION header, in addition to the Authorization bearer token. See https://docs.dfns.co/guides/developers/signing-requests.md. > Do not use appId or the X-DFNS-APPID header: applications are deprecated. > For a summary of how to build on DFNS, read https://docs.dfns.co/skill.md. # Search Wallets > Searches the wallets of your organization: find a wallet from an identifier you already have, from a word in its name, or from a token it holds, and narrow the results with filters. **How `q` matches** `q` is compared with five kinds of identifier, then with wallet names. Unless `sort` is set, results come in the order below. *Identifiers*, matched exactly: | If `q` is | Example | You get | | --- | --- | --- | | a wallet id | `wa-1f04s-lqc9q-xxxxxxxxxxxxxxxx` | that wallet | | an external id | `cust-00412` | that wallet, followed by the exact and prefix name matches | | a vault id | `vlt-2b9kq-7m4rt-xxxxxxxxxxxxxxxx` | the wallets of that vault | | an address, in any case | `0x00e3495cf6af59008f22ffaf32d4c92ac33dac47` | the wallets at that address | | the hash of a transfer or transaction made from one of your wallets | `0x8e88793607610a83798eb5ec6dde861f3e459c7e4a22e78b0d2e675b86d0d1e7` | the wallet that made it | A wallet id, vault id, address or hash match returns only those wallets, with no name matches. *Names*, ignoring case and accents. For a wallet named `Trading Hot Wallet`: 1. **Exact:** the name is the text, as with `trading hot wallet`. 2. **Prefix:** the name starts with the text, as with `trad`. 3. **Loose:** the name contains the text, or matches it with a small typo, as with `wallet` or `tradng`. Loose matches are left out when an identifier matches, when a wallet has the exact name, and when `matching` is `precise`. Without `q`, every wallet that passes the filters is returned. **Filters** all apply together. `filters.asset` returns the wallets holding a positive balance of a token. Archived wallets are left out unless `filters.statuses` includes `Archived`. **Order.** By default, results are ranked by relevance when `q` is set, by the filtered token's balance (largest first) with an asset filter, and newest first otherwise. `sort` orders by `name` or `dateCreated` instead. With an asset filter, the only accepted sort is `assetBalance`. **Pages.** A page holds up to `limit` wallets (50 by default, at most 500). For the next page, send the same body again with `paginationToken` set to the `nextPageToken` of the previous response, and keep the rest of the body unchanged: a token only continues the order it was issued for. See [Pagination](https://docs.dfns.co/api-reference/pagination). **Incomplete results.** A very broad search on a large organization can reach an internal cap. The response then carries `partial: 'capped'`: the results are a subset of the matches and paging ends early. Narrow the search with a longer term or another filter to get a complete answer. **Errors** (see [Error codes](https://docs.dfns.co/api-reference/error-codes)): * `400` with `details.kind` `SearchTimeout`: the search could not finish in time. The message says what to change: a longer search term, fewer filters, or ordering by date instead of name. * `400` with `details.kind` `UnsupportedAssetSelector`: `filters.asset.token` is not supported yet. Use `filters.asset.symbol`. * `503` with `details.kind` `DependencyUnavailable`: search is briefly unavailable. Retry the request. Requires the `Wallets:Read` permission. Not available to end users of delegated wallets, because a search spans the whole organization. #### Authentication ✅ Tenant User (`TenantUser`)\ ✅ Organization User (`CustomerEmployee`)\ ❌ End User (`EndUser`)\ ✅ Service Account #### Required Permissions `Wallets:Read`: Always required. ## OpenAPI ````yaml /openapi.yaml post /wallets/search openapi: 3.1.0 info: version: 2.0.529 title: Dfns servers: - url: https://api.dfns.io description: Default - Europe - url: https://api.uae.dfns.io description: UAE - url: https://api.dfns-sandbox.io description: Sandbox - url: https://api.dfns.ninja description: Staging security: [] paths: /wallets/search: post: tags: - Wallets summary: Search Wallets description: >- Searches the wallets of your organization: find a wallet from an identifier you already have, from a word in its name, or from a token it holds, and narrow the results with filters. **How `q` matches** `q` is compared with five kinds of identifier, then with wallet names. Unless `sort` is set, results come in the order below. *Identifiers*, matched exactly: | If `q` is | Example | You get | | --- | --- | --- | | a wallet id | `wa-1f04s-lqc9q-xxxxxxxxxxxxxxxx` | that wallet | | an external id | `cust-00412` | that wallet, followed by the exact and prefix name matches | | a vault id | `vlt-2b9kq-7m4rt-xxxxxxxxxxxxxxxx` | the wallets of that vault | | an address, in any case | `0x00e3495cf6af59008f22ffaf32d4c92ac33dac47` | the wallets at that address | | the hash of a transfer or transaction made from one of your wallets | `0x8e88793607610a83798eb5ec6dde861f3e459c7e4a22e78b0d2e675b86d0d1e7` | the wallet that made it | A wallet id, vault id, address or hash match returns only those wallets, with no name matches. *Names*, ignoring case and accents. For a wallet named `Trading Hot Wallet`: 1. **Exact:** the name is the text, as with `trading hot wallet`. 2. **Prefix:** the name starts with the text, as with `trad`. 3. **Loose:** the name contains the text, or matches it with a small typo, as with `wallet` or `tradng`. Loose matches are left out when an identifier matches, when a wallet has the exact name, and when `matching` is `precise`. Without `q`, every wallet that passes the filters is returned. **Filters** all apply together. `filters.asset` returns the wallets holding a positive balance of a token. Archived wallets are left out unless `filters.statuses` includes `Archived`. **Order.** By default, results are ranked by relevance when `q` is set, by the filtered token's balance (largest first) with an asset filter, and newest first otherwise. `sort` orders by `name` or `dateCreated` instead. With an asset filter, the only accepted sort is `assetBalance`. **Pages.** A page holds up to `limit` wallets (50 by default, at most 500). For the next page, send the same body again with `paginationToken` set to the `nextPageToken` of the previous response, and keep the rest of the body unchanged: a token only continues the order it was issued for. See [Pagination](https://docs.dfns.co/api-reference/pagination). **Incomplete results.** A very broad search on a large organization can reach an internal cap. The response then carries `partial: 'capped'`: the results are a subset of the matches and paging ends early. Narrow the search with a longer term or another filter to get a complete answer. **Errors** (see [Error codes](https://docs.dfns.co/api-reference/error-codes)): * `400` with `details.kind` `SearchTimeout`: the search could not finish in time. The message says what to change: a longer search term, fewer filters, or ordering by date instead of name. * `400` with `details.kind` `UnsupportedAssetSelector`: `filters.asset.token` is not supported yet. Use `filters.asset.symbol`. * `503` with `details.kind` `DependencyUnavailable`: search is briefly unavailable. Retry the request. Requires the `Wallets:Read` permission. Not available to end users of delegated wallets, because a search spans the whole organization. operationId: searchWallets requestBody: required: true content: application/json: schema: type: object properties: q: type: string maxLength: 200 description: >- Text to search for. A wallet id, address, external id, transaction hash or vault id resolves to its wallets. Any other text matches wallet names: an exact name first, then names starting with the text, then looser matches such as a word inside a name or a typo. sort: type: object properties: field: type: string enum: - name - dateCreated - assetBalance description: >- What to order by: 'name' (the wallet name), 'dateCreated' (when the wallet was created), or 'assetBalance' (the balance of the token in filters.asset, which requires that filter). direction: type: string enum: - asc - desc description: '''asc'' for ascending, ''desc'' for descending.' required: - field - direction description: >- Result order. Omitted, results are ranked by relevance when q is set, by the filtered token balance with an asset filter, and newest first otherwise. assetBalance requires an asset filter, and an asset filter accepts no other sort. limit: type: integer minimum: 1 maximum: 500 description: >- Maximum number of wallets to return, up to 500. Defaults to 50. paginationToken: type: string minLength: 1 description: >- Opaque token used to retrieve the next page. Returned as `nextPageToken` from the previous request. includeAssets: type: string enum: - native - verified description: >- Inline each wallet's assets: 'native' returns its native asset only, 'verified' adds its verified tokens. Omit to return none. matching: type: string enum: - precise - broad description: >- How widely to match. 'broad' (the default when omitted) matches identifiers and names, and also looks inside names and tolerates typos. 'precise' matches identifiers and names only: an exact id, an exact name, or the start of a name. It skips the fuzzy work, so it is markedly faster on a large org, but it is not a guarantee against the time limit: a search that also carries several filters can still exceed it. filters: type: object properties: networks: type: array items: $ref: '#/components/schemas/Network' maxItems: 153 description: Matches wallets on any of these networks. statuses: type: array items: type: string enum: - Active - Inactive - Archived description: Wallet status. maxItems: 3 description: >- Matches wallets in any of these statuses. Archived wallets are left out unless this list includes Archived. custodial: type: boolean description: >- Matches custodial wallets when true, and wallets that are not custodial when false. storeIds: type: array items: type: string minLength: 1 maxLength: 64 pattern: ^store-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Key store id. example: store-425nf-ebf0a-qq22t6qra51tj8j0 maxItems: 3 description: Scope results to wallets controlled by these key stores. vaultWallets: type: string enum: - exclude - include description: >- 'include' (default) keeps vault-controlled wallets. 'exclude' drops them from browse and text-search results, but an exact identifier still resolves: pasting a wallet id, address, transaction hash or vault id returns the wallet even when it belongs to a vault. tags: type: object properties: hasAny: type: array items: type: string pattern: ^[a-zA-Z0-9_.:/+-]{1,100}$ description: Wallet Tag. minItems: 1 maxItems: 10 description: Matches wallets carrying at least one of these tags. hasAll: type: array items: type: string pattern: ^[a-zA-Z0-9_.:/+-]{1,100}$ description: Wallet Tag. minItems: 1 maxItems: 10 description: Matches wallets carrying every one of these tags. additionalProperties: false description: >- Tag filter: set exactly one of hasAny or hasAll. Tags match exactly and are case sensitive. asset: type: object properties: symbol: type: string minLength: 1 maxLength: 64 description: >- Token symbol to filter by across networks, case insensitive, e.g. "USDC". Set either symbol or token. Resolves to verified tokens unless scope is "all". token: type: object properties: network: $ref: '#/components/schemas/Network' tid: type: string minLength: 1 maxLength: 512 description: >- Canonical token identifier including its kind prefix, e.g. erc20:, spl:, hts:, or native:eth. required: - network - tid additionalProperties: false description: >- An exact token identified by its network and tid. Set either token or symbol. If filters.networks is also set, it must include this network. Reserved for future use: token selectors currently return HTTP 400 with details.kind UnsupportedAssetSelector. balance: type: object properties: min: type: string maxLength: 128 pattern: ^\d+(\.\d+)?$ description: >- Inclusive lower bound, in whole token units: "100" is 100 USDC, not its smallest unit. Fractional allowed. max: type: string maxLength: 128 pattern: ^\d+(\.\d+)?$ description: >- Inclusive upper bound, in whole token units. Fractional allowed. additionalProperties: false description: Optional balance bounds. Set min, max, or both. scope: type: string enum: - verified - all description: >- "verified" (default) matches staff-verified tokens only. "all" widens to every token with the symbol — unverified balances are self-reported and may be spam. additionalProperties: false description: >- Matches wallets holding a positive balance of the token. Results are ranked by that balance, or by relevance when q is set. additionalProperties: false description: >- Narrows the results. A wallet is returned only if it matches every filter set here. additionalProperties: false examples: byName: summary: Wallets whose name matches a word value: q: treasury limit: 50 byTags: summary: Wallets carrying every listed tag value: filters: tags: hasAll: - treasury - payments byAsset: summary: Holders of a token, largest balance first value: filters: asset: symbol: USDC balance: min: '1000' sort: field: assetBalance direction: desc includeAssets: native byAddress: summary: The wallet behind an address description: >- Precise matching resolves the address without searching names, and the network filter picks one wallet. value: q: '0x7e9c1c2e4d1f6b0b8a3c5d2e1f0a9b8c7d6e5f40' matching: precise filters: networks: - Ethereum limit: 1 byNetworkAndStatus: summary: Active wallets on some networks, by name value: filters: networks: - Polygon - Base statuses: - Active sort: field: name direction: asc withoutVaultWallets: summary: Custodial wallets outside vaults value: filters: custodial: true vaultWallets: exclude nextPage: summary: The next page of a search description: >- Send the same body with the nextPageToken of the previous response. value: q: treasury limit: 50 paginationToken: responses: '200': description: Success content: application/json: schema: type: object properties: items: type: array items: type: object properties: wallet: $ref: '#/components/schemas/Wallet' matchedAsset: allOf: - oneOf: - type: object properties: kind: type: string enum: - Native required: - kind title: Native assets - type: object properties: kind: type: string enum: - Aip21 metadata: type: string required: - kind - metadata title: Aptos Fungible Assets (AIP-21) - type: object properties: kind: type: string enum: - Asa assetId: type: string required: - kind - assetId title: Algorand Standard Assets (ASAs) - type: object properties: kind: type: string enum: - Cis2 tokenAddress: type: string required: - kind - tokenAddress title: Concordium CIS-2 tokens - type: object properties: kind: type: string enum: - Erc20 - Snip2 - Trc20 contract: type: string required: - kind - contract title: >- EVM ERC-20/Starknet SNIP-2/TRON TRC-20 tokens - type: object properties: kind: type: string enum: - Erc7984 contract: type: string required: - kind - contract title: EVM ERC-7984 confidential tokens - type: object properties: kind: type: string enum: - Hts tokenId: type: string required: - kind - tokenId title: Hedera tokens (HTS) - type: object properties: kind: type: string enum: - Iou currency: type: string issuer: type: string required: - kind - currency - issuer title: XRP Ledger IOU tokens - type: object properties: kind: type: string enum: - Cip56 instrumentId: type: string instrumentAdmin: type: string required: - kind - instrumentId - instrumentAdmin title: Canton CIP-56 tokens - type: object properties: kind: type: string enum: - Coin - LockedCoin coin: type: string required: - kind - coin title: Sui/IOTA Coin assets - type: object properties: kind: type: string enum: - Xls33 issuanceId: type: string required: - kind - issuanceId title: XRP Ledger MPL (XLS-33) tokens - type: object properties: kind: type: string enum: - Asset assetId: type: string required: - kind - assetId title: Polymesh/Cardano assets - type: object properties: kind: type: string enum: - Cis7 tokenId: type: string required: - kind - tokenId title: Concordium PLTs ( CIS-7 tokens) - type: object properties: kind: type: string enum: - Sep41 issuer: type: string assetCode: type: string required: - kind - issuer - assetCode title: Stellar SEP-41 tokens - type: object properties: kind: type: string enum: - Trc10 tokenId: type: string required: - kind - tokenId title: TRON TRC-10 tokens - type: object properties: kind: type: string enum: - Spl - Spl2022 mint: type: string required: - kind - mint title: Solana SPL/SPL2022 tokens - type: object properties: kind: type: string enum: - Tep74 master: type: string required: - kind - master title: TON TEP-74 Jetton - type: object properties: symbol: type: string description: >- Ticker symbol of the asset, such as ETH or USDC, when it has one. decimals: type: number description: >- Number of decimals of the asset: balance divided by 10^decimals is the amount in whole units. verified: type: boolean description: >- Whether DFNS verified this token. Unverified tokens can be spam. See [Token verification](https://docs.dfns.co/guides/verify-tokens). balance: type: string description: >- Balance in the asset's smallest unit, as a string. required: - decimals - balance description: >- The asset that matched/ranked this wallet when filters.asset is set. This is always the filtered token, even if it is unverified (and not included in assets). assets: type: array items: allOf: - oneOf: - type: object properties: kind: type: string enum: - Native required: - kind title: Native assets - type: object properties: kind: type: string enum: - Aip21 metadata: type: string required: - kind - metadata title: Aptos Fungible Assets (AIP-21) - type: object properties: kind: type: string enum: - Asa assetId: type: string required: - kind - assetId title: Algorand Standard Assets (ASAs) - type: object properties: kind: type: string enum: - Cis2 tokenAddress: type: string required: - kind - tokenAddress title: Concordium CIS-2 tokens - type: object properties: kind: type: string enum: - Erc20 - Snip2 - Trc20 contract: type: string required: - kind - contract title: >- EVM ERC-20/Starknet SNIP-2/TRON TRC-20 tokens - type: object properties: kind: type: string enum: - Erc7984 contract: type: string required: - kind - contract title: EVM ERC-7984 confidential tokens - type: object properties: kind: type: string enum: - Hts tokenId: type: string required: - kind - tokenId title: Hedera tokens (HTS) - type: object properties: kind: type: string enum: - Iou currency: type: string issuer: type: string required: - kind - currency - issuer title: XRP Ledger IOU tokens - type: object properties: kind: type: string enum: - Cip56 instrumentId: type: string instrumentAdmin: type: string required: - kind - instrumentId - instrumentAdmin title: Canton CIP-56 tokens - type: object properties: kind: type: string enum: - Coin - LockedCoin coin: type: string required: - kind - coin title: Sui/IOTA Coin assets - type: object properties: kind: type: string enum: - Xls33 issuanceId: type: string required: - kind - issuanceId title: XRP Ledger MPL (XLS-33) tokens - type: object properties: kind: type: string enum: - Asset assetId: type: string required: - kind - assetId title: Polymesh/Cardano assets - type: object properties: kind: type: string enum: - Cis7 tokenId: type: string required: - kind - tokenId title: Concordium PLTs ( CIS-7 tokens) - type: object properties: kind: type: string enum: - Sep41 issuer: type: string assetCode: type: string required: - kind - issuer - assetCode title: Stellar SEP-41 tokens - type: object properties: kind: type: string enum: - Trc10 tokenId: type: string required: - kind - tokenId title: TRON TRC-10 tokens - type: object properties: kind: type: string enum: - Spl - Spl2022 mint: type: string required: - kind - mint title: Solana SPL/SPL2022 tokens - type: object properties: kind: type: string enum: - Tep74 master: type: string required: - kind - master title: TON TEP-74 Jetton - type: object properties: symbol: type: string description: >- Ticker symbol of the asset, such as ETH or USDC, when it has one. decimals: type: number description: >- Number of decimals of the asset: balance divided by 10^decimals is the amount in whole units. verified: type: boolean description: >- Whether DFNS verified this token. Unverified tokens can be spam. See [Token verification](https://docs.dfns.co/guides/verify-tokens). balance: type: string description: >- Balance in the asset's smallest unit, as a string. required: - decimals - balance description: >- Inline assets for the wallet, populated by setting 'includeAssets' to 'native' or 'verified'. The native asset is always included (even at a zero balance); among tokens, only verified ones with a positive balance appear — unverified tokens are never listed. Please contact us to get your token verified if you want it to appear in this list. required: - wallet description: The matches on this page, in result order. nextPageToken: type: string description: >- Present when more results exist. Send it as paginationToken, with the rest of the request unchanged, to get the next page. partial: type: string enum: - capped description: >- Present only as 'capped', and only when an internal cap decided what this search could reach. The results are a subset of the matches and paging will end before the real end of the match set. Do not read them as the closest matches: depending on which branch answered, the cap keeps either the alphabetically first matches or an arbitrary sample of them. Absent means the page is complete. Narrow the search with a longer term or one more filter to get an exact answer. required: - items security: - authenticationToken: [] components: schemas: 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 - HyperEvm - HyperEvmTestnet - 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 Wallet: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: ID of the wallet. example: wa-5pfuu-9euek-h0odgb6snva8ph3k network: type: string description: Network this wallet is bound to. 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 - HyperEvm - HyperEvmTestnet - 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 address: type: string description: Wallet address on its corresponding network. signingKey: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^key-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: Key id. example: key-01snl-t56gb-j8tsok0vn802p80i scheme: $ref: '#/components/schemas/KeyScheme' curve: $ref: '#/components/schemas/KeyCurve' publicKey: type: string description: Hex-encoded value of the public key. example: >- e2375c8c9e87bfcd0be8f29d76c818cabacd51584f72cb2222d49a13b036d84d3d delegatedTo: type: string minLength: 1 maxLength: 64 pattern: ^us-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: The end user ID the key (and wallet) is delegated to. example: us-6b58p-r53sr-rlrd3l5cj3uc4ome storeId: type: string minLength: 1 maxLength: 64 pattern: ^store-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- ID of the key store the signing key lives in (see [List Key Stores](https://docs.dfns.co/api-reference/key-stores/list-key-stores)). Use it to tell wallets apart by custody setup, for instance to scope a policy to one store with the `keyStoreId` policy filter. example: store-425nf-ebf0a-qq22t6qra51tj8j0 required: - id - scheme - curve - publicKey description: Details about the key underlying the wallet. status: type: string enum: - Active - Inactive - Archived description: Wallet status. dateCreated: type: string description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. example: '2023-04-14T20:41:28.715Z' dateDeleted: type: string description: >- [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was deleted. example: '2023-04-14T20:41:28.715Z' name: type: string maxLength: 100 description: Wallet nickname. custodial: type: boolean description: >- Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). externalId: type: string maxLength: 100 description: >- User-defined value that can be used to correlate the entity with an external system. tags: type: array items: type: string pattern: ^[a-zA-Z0-9_.:/+-]{1,100}$ description: Wallet Tag. maxItems: 10 description: List of tags. validatorId: type: string minLength: 1 maxLength: 64 pattern: ^cv-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: '@deprecated use `networkInfo.validatorId` instead.' deprecated: true networkInfo: type: object properties: nonceAccounts: type: array items: type: string description: Confirmed Solana durable-nonce accounts owned by this wallet. validatorId: type: string minLength: 1 maxLength: 64 pattern: ^cv-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- Id of the validator on which the wallet is created for Canton networks. example: cv-7jeof-m584r-p35ucm37ko3cqgts description: >- Additional chain-dependent information about the wallet. Only returned by Get Wallet. vaultId: type: string minLength: 1 maxLength: 64 pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$ description: >- The vault controlling this wallet, absent for ordinary wallets. A vault wallet is read-only, its funds move through the vault endpoints, and it carries its vault name and tags as its own. example: vlt-5vbsp-u62g1-ostmunqgds5o9tc2 required: - id - network - signingKey - status - dateCreated - custodial - tags example: id: wa-1f04s-lqc9q-xxxxxxxxxxxxxxxx network: Ethereum address: '0x00e3495cf6af59008f22ffaf32d4c92ac33dac47' name: trading hot wallet signingKey: id: key-6ece3-9l565-xxxxxxxxxxxxxxxx scheme: ECDSA curve: secp256k1 publicKey: e2375c8c9e87bfcd0be8f29d76c818cabacd51584f72cb2222d49a13b036d84d3d storeId: store-2ab1c-4d5e6-xxxxxxxxxxxxxxxx status: Active dateCreated: '2023-04-14T20:41:28.715Z' custodial: true tags: [] KeyScheme: type: string description: The cryptographic scheme for the key. enum: - ECDSA - EdDSA - Schnorr KeyCurve: type: string enum: - ed25519 - secp256k1 - stark description: The elliptic curve for the key. 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.