{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Zodia Documentation","colors":{"primary":"#027777","light":"#0cadad","dark":"#061f22"},"logo":{"light":"https://mintcdn.com/zodiacustody/yWL07C0ZgscZDVlQ/logo/logo-for-lightmode.svg?fit=max\u0026auto=format\u0026n=yWL07C0ZgscZDVlQ\u0026q=85\u0026s=adf7b953539478e882c9727494fd8f22","dark":"https://mintcdn.com/zodiacustody/yWL07C0ZgscZDVlQ/logo/logo-for-darkmode.svg?fit=max\u0026auto=format\u0026n=yWL07C0ZgscZDVlQ\u0026q=85\u0026s=c2ac5ce8f998e763671dbbbb71f9f9ef"},"favicon":"https://mintcdn.com/zodiacustody/RKAOyMi_osGFK65R/favicon.png?fit=max\u0026auto=format\u0026n=RKAOyMi_osGFK65R\u0026q=85\u0026s=4c5b3c1f1a4e696ac89744c3cf94d865","api":{},"appearance":{"default":"dark"},"background":{"color":{"dark":"#061f22"}},"navbar":{"links":[],"primary":{"type":"button","label":"Download Now","href":"https://zodia-custody.com/hidden-gems-digital-assets-and-the-future-of-corporate-treasury/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/zodiacustody?originalSubdomain=uk","website":"https://zodia-custody.com"}},"fonts":{"heading":{"family":"TT Hoves","source":"https://zodia-custody.com/wp-content/themes/zodia/fonts/TTHoves-Light.woff2","format":"woff2"},"body":{"family":"Suisse Intl","source":"https://zodia-custody.com/wp-content/themes/zodia/fonts/SuisseIntl-Light.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zodiacustody","hasAudioNarration":false,"actualSubdomain":"zodiacustody","customDomains":["docs.zodia-custody.com"],"gitSource":{"type":"github","owner":"scv-lydia","repo":"zodia-api-docs-mintlify-implementation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae12f8a8b59ecf314c2e52f","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":106},{"language":"default","tag":"Custody (V3)","count":35},{"language":"default","tag":"Interchange (V3)","count":16},{"language":"default","tag":"Custody-V3","count":11},{"language":"default","tag":"API - WALLETS - V2","count":10},{"language":"default","tag":"API - TRANSACTIONS - V2","count":8},{"language":"default","tag":"Working with APIs","count":8},{"language":"default","tag":"Network Management (V3)","count":7},{"language":"default","tag":"Service Desk (V3)","count":7},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69e919208d6e9e4ee83383bc","deploymentId":"69b01cee59ecdc0f8f7cbdb3","questionText":"Help me troubleshoot this problem.","status":"active","generatedBy":"manual","createdAt":"2026-04-22T18:53:20.669Z","updatedAt":"2026-04-22T18:53:20.669Z","__v":0},{"_id":"69e918c88d6e9e4ee833808c","deploymentId":"69b01cee59ecdc0f8f7cbdb3","questionText":"How do I connect for the very first time?","status":"active","generatedBy":"manual","createdAt":"2026-04-22T18:51:52.992Z","updatedAt":"2026-04-22T18:51:52.992Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custody-v3/retrieve-wallets","slug":"/api-reference/custody-v3/retrieve-wallets","pageMetadata":{"openapi":"post /v3/api/custody/wallets","title":"Retrieve wallets","description":"Gets the custody wallets based on the filter criteria.","href":"/api-reference/custody-v3/retrieve-wallets"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Gets the custody wallets based on the filter criteria.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v3/api/custody/wallets","title":"Retrieve wallets","description":"Gets the custody wallets based on the filter criteria.","href":"/api-reference/custody-v3/retrieve-wallets"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Custody-V3"],"operationId":"getv3apicustodywallets","summary":"Retrieve wallets","description":"Gets the custody wallets based on the filter criteria.","parameters":["1302c89e-023d-4fc9-a9cf-39f5eb140ecf"],"requestBody":"3d870287-cc05-4a8c-bed9-5499f0957764","responses":{"200":"4cf14df6-c15d-4679-b537-bf3cdee4e7eb","400":"fe937615-a10c-489f-a2f3-d16babc05822","401":"4686288a-19f9-4f2b-8741-6ab9e3656837","429":"b1c09643-cc6b-40f2-8cd2-611a3fda9b88","500":"3a5d5067-0ce7-4fd9-809b-cdfcd91096ca"},"method":"post","type":"path","servers":["3008a2b5-8f4f-4841-b6cd-93ae307ef2fa","6dd4d114-d1bb-4c7e-a465-aa6617baad43"],"security":[],"path":"/v3/api/custody/wallets","baseUrlOptions":["https://api.custody.api-zodia.io","https://gateway-preprod.uat.api-zodia.io"],"title":"Retrieve wallets","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1302c89e-023d-4fc9-a9cf-39f5eb140ecf":{"name":"submitter-id","in":"header","description":"Email of API user submitting the request","required":true,"allowEmptyValue":false,"schema":{"type":"string","example":"api-maker@zodia.io","isRequired":true,"description":"Email of API user submitting the request","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Payload for specifying filters","properties":{"ids":{"description":"Search by wallet IDs","type":"array","items":{"type":"string","example":"ZTEST-NOBENF-XSC2OKBERS","uniqueKey":"ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"ids","typeLabel":"string[]"},"names":{"description":"Search by wallet names","type":"array","items":{"type":"string","example":"MY_Wallet","uniqueKey":"names.items.[INDEX]","typeLabel":"string"},"uniqueKey":"names","typeLabel":"string[]"},"walletOwnerIds":{"description":"Search by wallet owner IDs","type":"array","items":{"type":"string","example":"testOwner","uniqueKey":"walletOwnerIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"walletOwnerIds","typeLabel":"string[]"},"statuses":{"description":"Search by wallet status i.e. ACTIVE or DEACTIVATED","type":"array","items":{"type":"string","example":"ACTIVE","uniqueKey":"statuses.items.[INDEX]","typeLabel":"string"},"uniqueKey":"statuses","typeLabel":"string[]"},"companyIds":{"type":"array","items":{"type":"string","example":"ZTEST","uniqueKey":"companyIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"companyIds","typeLabel":"string[]"},"currencies":{"type":"array","items":{"type":"string","example":"ETH","uniqueKey":"currencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"currencies","typeLabel":"string[]"},"currenciesIds":{"type":"array","items":{"type":"string","example":"eth-eth","uniqueKey":"currenciesIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"currenciesIds","typeLabel":"string[]"},"createdBy":{"type":"array","items":{"type":"string","example":"api-maker@zodia.io","uniqueKey":"createdBy.items.[INDEX]","typeLabel":"string"},"uniqueKey":"createdBy","typeLabel":"string[]"},"paginationLimit":{"type":"number","description":"Number of items in response (default is 10)","example":10,"uniqueKey":"paginationLimit","typeLabel":"number"},"paginationOffset":{"type":"number","uniqueKey":"paginationOffset","typeLabel":"number"},"sort":{"type":"object","properties":{"by":{"type":"string","description":"field name","example":"id","uniqueKey":"sort.by","typeLabel":"string"},"order":{"type":"string","enum":["ASC","DESC"],"uniqueKey":"sort.order","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sort","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ids":["ZTEST-NOBENF-XSC2OKBERS"],"names":["MY_Wallet"],"walletOwnerIds":["testOwner"],"statuses":["ACTIVE"],"companyIds":["ZTEST"],"currencies":["ETH"],"currenciesIds":["eth-eth"],"createdBy":["api-maker@zodia.io"],"paginationLimit":10,"paginationOffset":123,"sort":{"by":"id"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4cf14df6-c15d-4679-b537-bf3cdee4e7eb":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["items","total"],"properties":{"items":{"type":"array","description":"Custody wallets owned by the company","items":{"type":"object","required":["id","name","status","companyId","currency","currencyId","balances","createdBy","createdAt","updatedAt"],"properties":{"id":{"maxLength":40,"minLength":1,"pattern":"\u003ccompanyId>-[NOBENF|\u003cbeneficiaryId>]-API-*","type":"string","description":"ID of the wallet","example":"ZTEST-NOBENF-849P8XKKAO","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Display name of the wallet","example":"Demo wallet","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","description":"Current status of the wallet","enum":["ACTIVE","DEACTIVATED"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"companyId":{"maxLength":12,"minLength":1,"type":"string","description":"ID of the company","example":"ZTEST","isRequired":true,"uniqueKey":"\\items.items.[INDEX].companyId","typeLabel":"string"},"currency":{"maxLength":6,"type":"string","description":"Currency of the wallet (ETH, BTC, ...)","example":"ETH","isRequired":true,"uniqueKey":"\\items.items.[INDEX].currency","typeLabel":"string"},"currencyId":{"maxLength":128,"type":"string","description":"Currency ID of the wallet (eth-Seth, btc-btc, ...)","example":"eth-Seth","isRequired":true,"uniqueKey":"\\items.items.[INDEX].currencyId","typeLabel":"string"},"balances":{"type":"array","items":{"type":"object","required":["currency","availableBalance","ledgerBalance","pendingOutBalance","pendingInBalance"],"properties":{"currency":{"maxLength":6,"type":"string","example":"BTC","description":"Currency of the balance","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].currency","typeLabel":"string"},"availableBalance":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance.usdValue","typeLabel":"string"}},"description":"Balance","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].availableBalance","typeLabel":"object"},"ledgerBalance":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance.usdValue","typeLabel":"string"}},"description":"Balance","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].ledgerBalance","typeLabel":"object"},"pendingOutBalance":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance.usdValue","typeLabel":"string"}},"description":"Balance","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingOutBalance","typeLabel":"object"},"pendingInBalance":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance.usdValue","typeLabel":"string"}},"description":"Balance","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].pendingInBalance","typeLabel":"object"},"feeBufferBalance":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance.usdValue","typeLabel":"string"}},"description":"Balance","uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].feeBufferBalance","typeLabel":"object"},"subClientBalances":{"description":"Any client balances by clientAccountReference","type":"object","additionalProperties":{"type":"object","required":["amount","amountUnit","fiatValue","fiatCurrency"],"properties":{"amount":{"maxLength":30,"type":"string","description":"Currency amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties.amount","typeLabel":"string"},"amountUnit":{"maxLength":72,"type":"string","description":"ledger unit amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties.amountUnit","typeLabel":"string"},"fiatValue":{"maxLength":20,"type":"string","description":"Fiat amount","example":"0.006414","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties.fiatValue","typeLabel":"string"},"fiatCurrency":{"maxLength":20,"type":"string","description":"USD|AUD","example":"USD","isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties.fiatCurrency","typeLabel":"string"},"usdValue":{"maxLength":20,"type":"string","description":"USD amount","example":"0.006414","deprecated":true,"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties.usdValue","typeLabel":"string"}},"description":"Balance","uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances.additionalProperties","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX].subClientBalances","typeLabel":"object"}},"description":"Balance of the wallet","uniqueKey":"\\items.items.[INDEX].balances.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].balances","typeLabel":"object[]"},"createdBy":{"maxLength":128,"type":"string","description":"ID of the user who created the wallet","example":"api-maker@zodia.io","isRequired":true,"uniqueKey":"\\items.items.[INDEX].createdBy","typeLabel":"string"},"createdAt":{"type":"string","description":"Date/time (in UTC) of creation of the wallet","example":"2021-05-11T04:43:43Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date/time (in UTC) of the wallet last update","example":"2021-05-11T04:43:43Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].updatedAt","typeLabel":"string"},"walletOwner":{"type":"object","properties":{"id":{"maxLength":32,"type":"string","uniqueKey":"\\items.items.[INDEX].walletOwner.id","typeLabel":"string"},"name":{"maxLength":128,"type":"string","uniqueKey":"\\items.items.[INDEX].walletOwner.name","typeLabel":"string"},"address":{"type":"object","required":["address1","city","country"],"properties":{"address1":{"maxLength":64,"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].walletOwner.address.address1","typeLabel":"string"},"city":{"maxLength":32,"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].walletOwner.address.city","typeLabel":"string"},"country":{"maxLength":32,"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].walletOwner.address.country","typeLabel":"string"},"address2":{"maxLength":64,"type":"string","uniqueKey":"\\items.items.[INDEX].walletOwner.address.address2","typeLabel":"string"},"zipCode":{"maxLength":8,"type":"string","uniqueKey":"\\items.items.[INDEX].walletOwner.address.zipCode","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].walletOwner.address","typeLabel":"object"}},"description":"Null if the wallet is owned by the company itself","uniqueKey":"\\items.items.[INDEX].walletOwner","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"total":{"type":"integer","isRequired":true,"uniqueKey":"total","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":"ZTEST-NOBENF-849P8XKKAO","name":"Demo wallet","status":"ACTIVE","companyId":"ZTEST","currency":"ETH","currencyId":"eth-Seth","balances":[{"currency":"BTC","availableBalance":{"amount":"\u003cstring>","amountUnit":"0.006414","fiatValue":"0.006414","fiatCurrency":"USD","usdValue":"0.006414"},"ledgerBalance":{"amount":"\u003cstring>","amountUnit":"0.006414","fiatValue":"0.006414","fiatCurrency":"USD","usdValue":"0.006414"},"pendingOutBalance":{"amount":"\u003cstring>","amountUnit":"0.006414","fiatValue":"0.006414","fiatCurrency":"USD","usdValue":"0.006414"},"pendingInBalance":{"amount":"\u003cstring>","amountUnit":"0.006414","fiatValue":"0.006414","fiatCurrency":"USD","usdValue":"0.006414"},"feeBufferBalance":{"amount":"\u003cstring>","amountUnit":"0.006414","fiatValue":"0.006414","fiatCurrency":"USD","usdValue":"0.006414"},"subClientBalances":{}}],"createdBy":"api-maker@zodia.io","createdAt":"2021-05-11T04:43:43Z","updatedAt":"2021-05-11T04:43:43Z","walletOwner":{"id":"\u003cstring>","name":"\u003cstring>","address":{"address1":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","address2":"\u003cstring>","zipCode":"\u003cstring>"}}}],"total":123}}},"exampleType":"generated"}},"exampleType":"generated"},"fe937615-a10c-489f-a2f3-d16babc05822":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Date/time (in UTC) of the error response","example":"2021-10-27T14:30:13.912Z","uniqueKey":"timestamp","typeLabel":"string"},"title":{"type":"string","description":"Short textual description of the status code","example":"Method Not Allowed","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","format":"int32","example":415,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"details":{"type":"array","description":"One or more details about the error","items":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable message providing more details about the error","example":"Available methods : GET,POST","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"An error code that should be shared with Zodia for troubleshooting","example":"ER-204","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"description":"One or more details about the error","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timestamp":"2021-10-27T14:30:13.912Z","title":"Method Not Allowed","status":415,"details":[{"message":"Available methods : GET,POST","code":"ER-204"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4686288a-19f9-4f2b-8741-6ab9e3656837":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Date/time (in UTC) of the error response","example":"2021-10-27T14:30:13.912Z","uniqueKey":"timestamp","typeLabel":"string"},"title":{"type":"string","description":"Short textual description of the status code","example":"Method Not Allowed","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","format":"int32","example":415,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"details":{"type":"array","description":"One or more details about the error","items":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable message providing more details about the error","example":"Available methods : GET,POST","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"An error code that should be shared with Zodia for troubleshooting","example":"ER-204","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"description":"One or more details about the error","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timestamp":"2021-10-27T14:30:13.912Z","title":"Method Not Allowed","status":415,"details":[{"message":"Available methods : GET,POST","code":"ER-204"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"b1c09643-cc6b-40f2-8cd2-611a3fda9b88":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Date/time (in UTC) of the error response","example":"2021-10-27T14:30:13.912Z","uniqueKey":"timestamp","typeLabel":"string"},"title":{"type":"string","description":"Short textual description of the status code","example":"Method Not Allowed","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","format":"int32","example":415,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"details":{"type":"array","description":"One or more details about the error","items":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable message providing more details about the error","example":"Available methods : GET,POST","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"An error code that should be shared with Zodia for troubleshooting","example":"ER-204","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"description":"One or more details about the error","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timestamp":"2021-10-27T14:30:13.912Z","title":"Method Not Allowed","status":415,"details":[{"message":"Available methods : GET,POST","code":"ER-204"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3a5d5067-0ce7-4fd9-809b-cdfcd91096ca":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Date/time (in UTC) of the error response","example":"2021-10-27T14:30:13.912Z","uniqueKey":"timestamp","typeLabel":"string"},"title":{"type":"string","description":"Short textual description of the status code","example":"Method Not Allowed","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","format":"int32","example":415,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"details":{"type":"array","description":"One or more details about the error","items":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable message providing more details about the error","example":"Available methods : GET,POST","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"An error code that should be shared with Zodia for troubleshooting","example":"ER-204","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"description":"One or more details about the error","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"timestamp":"2021-10-27T14:30:13.912Z","title":"Method Not Allowed","status":415,"details":[{"message":"Available methods : GET,POST","code":"ER-204"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"3008a2b5-8f4f-4841-b6cd-93ae307ef2fa":{"url":"https://api.custody.api-zodia.io","description":"Production server"},"6dd4d114-d1bb-4c7e-a465-aa6617baad43":{"url":"https://gateway-preprod.uat.api-zodia.io","description":"Sandbox server"}}},"originalFileLocation":"api-reference/api_specification.yaml"},"subdomain":"zodiacustody","siteName":"Zodia Documentation","title":"Retrieve wallets - Zodia Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T13:35:41.978Z","originalFileLocation":"api-reference/custody-v3/retrieve-wallets.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Gets the custody wallets based on the filter criteria.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zodia Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve wallets - Zodia Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets the custody wallets based on the filter criteria.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zodia Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zodiacustody.mintlify.site/_mintlify/api/og/v2?division=Custody-V3\u0026amp;title=Retrieve+wallets\u0026amp;description=Gets+the+custody+wallets+based+on+the+filter+criteria.\u0026amp;theme=471d1b53f71374faca37a1e0\u0026amp;signature=439c7c9034ff1e76c812e9db85c55181bd5d385f634b84597fa5273c7f2306af\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve wallets - Zodia Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets the custody wallets based on the filter criteria.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zodiacustody.mintlify.site/_mintlify/api/og/v2?division=Custody-V3\u0026amp;title=Retrieve+wallets\u0026amp;description=Gets+the+custody+wallets+based+on+the+filter+criteria.\u0026amp;theme=471d1b53f71374faca37a1e0\u0026amp;signature=439c7c9034ff1e76c812e9db85c55181bd5d385f634b84597fa5273c7f2306af\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zodiacustody/AEO8Jrg35M1il-8J/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zodia Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#027777\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custody-v3/retrieve-wallets.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zodia-custody.com/#organization\",\"name\":\"Zodia Documentation\",\"url\":\"https://docs.zodia-custody.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zodiacustody/yWL07C0ZgscZDVlQ/logo/logo-for-lightmode.svg?fit=max\u0026auto=format\u0026n=yWL07C0ZgscZDVlQ\u0026q=85\u0026s=adf7b953539478e882c9727494fd8f22\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zodia-custody.com#website\",\"name\":\"Zodia Documentation\",\"url\":\"https://docs.zodia-custody.com\",\"publisher\":{\"@id\":\"https://docs.zodia-custody.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets#webpage\",\"url\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets\",\"name\":\"Retrieve wallets\",\"description\":\"Gets the custody wallets based on the filter criteria.\",\"dateModified\":\"2026-10-16T13:35:41.978Z\",\"isPartOf\":{\"@id\":\"https://docs.zodia-custody.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Custody (V3)\",\"item\":\"https://docs.zodia-custody.com/api-reference/servicedesk-v3/retrieve-products-and-services\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve wallets\",\"item\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets#apireference\",\"headline\":\"Retrieve wallets\",\"name\":\"Retrieve wallets\",\"description\":\"Gets the custody wallets based on the filter criteria.\",\"url\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zodia-custody.com/api-reference/custody-v3/retrieve-wallets#webpage\"},\"dateModified\":\"2026-10-16T13:35:41.978Z\",\"publisher\":{\"@id\":\"https://docs.zodia-custody.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zodia-custody.com#website\"}}]}\u003c/script>","siteName":"Zodia Documentation","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"API Reference","pages":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","href":"/authentication"},{"title":"Signing Requests","href":"/authentication/signing-requests"},{"title":"Signing the Payload","href":"/authentication/signing-payload"},{"title":"Extracting Your Public Key","href":"/authentication/extract-public-key"},{"title":"Rate Limiting \u0026 Pagination","href":"/rate-limiting"}]},{"group":"Working with APIs","pages":[{"title":"Working with APIs","href":"/working-with-apis"},{"title":"Pre-requisites","href":"/working-with-apis/pre-requisites"},{"title":"Company Onboarding","href":"/working-with-apis/company-onboarding"},{"title":"Onboarding API Users","href":"/working-with-apis/onboarding-api-users"},{"title":"Pagination","href":"/working-with-apis/pagination"},{"title":"Error Codes","href":"/working-with-apis/error-codes"},{"title":"Interchange Error Codes","href":"/working-with-apis/interchange-error-codes"},{"title":"Staking Error Codes","href":"/working-with-apis/staking-error-codes"}]},{"group":"Custody (V3)","pages":[{"group":"ServiceDesk-V3","pages":[{"openapi":"post /v3/api/servicedesk/products","title":"Retrieve products and services","href":"/api-reference/servicedesk-v3/retrieve-products-and-services"},{"openapi":"post /v3/api/servicedesk/create","title":"Create service request","href":"/api-reference/servicedesk-v3/create-service-request"},{"openapi":"post /v3/api/servicedesk/submit","title":"Submit service request","href":"/api-reference/servicedesk-v3/submit-service-request"},{"openapi":"post /v3/api/servicedesk/pending","title":"Retrieve the instruction to sign","href":"/api-reference/servicedesk-v3/retrieve-the-instruction-to-sign"},{"openapi":"post /v3/api/servicedesk/approve","title":"Approve or reject an instruction","href":"/api-reference/servicedesk-v3/approve-or-reject-an-instruction"},{"openapi":"post /v3/api/servicedesk/requests","title":"List service requests","href":"/api-reference/servicedesk-v3/list-service-requests"},{"openapi":"post /v3/api/servicedesk/audit-trail","title":"Retrieve audit trail","description":"This will return the audit-trail of given service request with details such as status, pending approvals and approved history.","href":"/api-reference/servicedesk-v3/retrieve-audit-trail"}]},{"group":"Custody-V3","pages":[{"openapi":"post /v3/api/custody/wallets","title":"Retrieve wallets","href":"/api-reference/custody-v3/retrieve-wallets"},{"title":"Retrieve trustline for a wallet and a currency","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/api_specification.yaml post /v3/api/custody/wallets/{walletId}/trustline/{currencyId}","href":"/api-reference/custody-v3/retrieve-trustline-for-a-wallet-and-a-currency"},{"openapi":"post /v3/api/custody/gastank/wallets","title":"Retrieve gas tank wallets link to your vault","href":"/api-reference/custody-v3/retrieve-gas-tank-wallets-link-to-your-vault"},{"openapi":"post /v3/api/custody/wallets/addresses/generate","title":"Retrieve an address for a wallet","href":"/api-reference/custody-v3/retrieve-an-address-for-a-wallet"},{"openapi":"post /v3/api/custody/wallets/addresses","title":"Returns list of generated addresses of wallets","href":"/api-reference/custody-v3/returns-list-of-generated-addresses-of-wallets"},{"openapi":"post /v3/api/custody/transactions","title":"Retrieve transactions","href":"/api-reference/custody-v3/retrieve-transactions"},{"openapi":"post /v3/api/custody/currencies","title":"Retrieve supported currencies","href":"/api-reference/custody-v3/retrieve-supported-currencies"},{"openapi":"post /v3/api/custody/currencies/fees","title":"Retrieve ledger fees per currency","href":"/api-reference/custody-v3/retrieve-ledger-fees-per-currency"},{"openapi":"post /v3/api/custody/ledgers/{ledger}/bounds","title":"Retrieve fee details of a ledger","href":"/api-reference/custody-v3/retrieve-fee-details-of-a-ledger"},{"openapi":"post /v3/api/custody/wallets/balance","title":"Retrieve wallet balances","href":"/api-reference/custody-v3/retrieve-wallet-balances"},{"openapi":"post /v3/api/custody/wallets/{wallet_id}/activate/{currency_id}","title":"Create a trustline for an XLM (Stellar) asset","href":"/api-reference/custody-v3/create-a-trustline-for-an-xlm-stellar-asset"}]},{"group":"Network-V3","pages":[{"openapi":"post /v3/api/netwmgmt/vasps","title":"Retrieve onboarded VASPs","href":"/api-reference/network-v3/retrieve-onboarded-vasps"},{"openapi":"post /v3/api/netwmgmt/beneficiaries","title":"Retrieve beneficiaries","href":"/api-reference/network-v3/retrieve-beneficiaries"},{"openapi":"post /v3/api/netwmgmt/addresses","title":"Retrieve addresses","href":"/api-reference/network-v3/retrieve-addresses"},{"openapi":"post /v3/api/transfer-rule/wallets","title":"Retrieve transfer rules","href":"/api-reference/network-v3/retrieve-transfer-rules"},{"openapi":"post /v3/api/compliance/vasps","title":"Create VASP","href":"/api-reference/network-v3/create-vasp"},{"openapi":"post /v3/api/compliance/vasps/{vasp-id}","title":"Update VASP","href":"/api-reference/network-v3/update-vasp"},{"openapi":"post /v3/api/compliance/vasps/{vasp-id}/activate/{valid}","title":"Activate or Deactivate VASP","href":"/api-reference/network-v3/activate-or-deactivate-vasp"}]},{"group":"Interchange-V3","pages":[{"openapi":"post /v3/api/trading/wallets","title":"Retrieve all wallets","href":"/api-reference/interchange-v3/retrieve-all-wallets"},{"openapi":"post /v3/api/trading/vaults","title":"Retrieve all vaults","href":"/api-reference/interchange-v3/retrieve-all-vaults"},{"openapi":"post /v3/api/trading/wallets/addresses/generate","title":"Retrieve an address for a wallet","href":"/api-reference/interchange-v3/retrieve-an-address-for-a-wallet"},{"openapi":"post /v3/api/trading/wallets/addresses","title":"Return list of generated addresses","href":"/api-reference/interchange-v3/return-list-of-generated-addresses"},{"openapi":"post /v3/api/trading/vaults/addresses/generate","title":"Retrieve an address for a vault","href":"/api-reference/interchange-v3/retrieve-an-address-for-a-vault"},{"openapi":"post /v3/api/trading/vaults/addresses","title":"Return list of generated addresses for vaults","href":"/api-reference/interchange-v3/return-list-of-generated-addresses-for-vaults"},{"openapi":"post /v3/api/interchange/settlement/wallet/addresses","title":"Return list of generated addresses for settlement wallet","href":"/api-reference/interchange-v3/return-list-of-generated-addresses-for-settlement-wallet"},{"openapi":"post /v3/api/trading/transactions","title":"Retrieve transactions","href":"/api-reference/interchange-v3/retrieve-transactions"},{"openapi":"post /v3/api/trading/wallets/balance","title":"Retrieve wallet balances","href":"/api-reference/interchange-v3/retrieve-wallet-balances"},{"openapi":"post /v3/api/interchange/settlement/transactions","title":"Whitelist senders for settlement transactions","href":"/api-reference/interchange-v3/whitelist-senders-for-settlement-transactions"},{"openapi":"post /v3/api/interchange/settlement/wallet/whitelisted/address","title":"List interchange whitelisted addresses","href":"/api-reference/interchange-v3/list-interchange-whitelisted-addresses"},{"openapi":"post /v3/api/interchange/settlement/create","title":"Create a settlement instruction","href":"/api-reference/interchange-v3/create-a-settlement-instruction"},{"openapi":"post /v3/api/interchange/settlement/status","title":"Check the status of the settlement instructions","href":"/api-reference/interchange-v3/check-the-status-of-the-settlement-instructions"},{"openapi":"post /v3/api/interchange/settlements","title":"Retrieve settlements","href":"/api-reference/interchange-v3/retrieve-settlements"},{"openapi":"post /v3/api/interchange/settlement/wallet","title":"Retrieve settlement wallet for Venue","href":"/api-reference/interchange-v3/retrieve-settlement-wallet-for-venue"},{"openapi":"post /v3/api/interchange/withdrawal/confirm","title":"Confirm or reject a withdrawal from a trading vault","href":"/api-reference/interchange-v3/confirm-or-reject-a-withdrawal-from-a-trading-vault"}]},{"group":"Reporting-V3","pages":[{"openapi":"post /v3/api/ase/staking/report/data","title":"Get Staking Report Data","href":"/api-reference/reporting-v3/get-staking-report-data"}]},{"group":"Staking-V3","pages":[{"title":"Get ETH Staking Dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api_specification.yaml post /v3/api/ase/staking/eth/dashboard","href":"/api-reference/staking-v3/get-eth-staking-dashboard"},{"title":"List ETH Validators","deprecated":null,"version":null,"openapi":"/api-reference/api_specification.yaml post /v3/api/ase/staking/eth/validators","href":"/api-reference/staking-v3/list-eth-validators"},{"title":"Get SOL Staking Dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api_specification.yaml post /v3/api/ase/staking/sol/dashboard","href":"/api-reference/staking-v3/get-sol-staking-dashboard"}]},{"group":"API - MISC - V2","pages":[{"openapi":"get /v2/api/core/ping","title":"Ping GET","href":"/api-reference/api--misc--v2/ping-get"}]},{"group":"API - BLOCKCHAIN FEES - V2","pages":[{"openapi":"get /v2/api/core/fees/{currency}","title":"Get the estimated fee rate by currency","href":"/api-reference/api--blockchain-fees--v2/get-the-estimated-fee-rate-by-currency"},{"openapi":"post /v2/api/custody/ledgers/{ledger}/bounds","title":"Retrieve fee details of a ledger","href":"/api-reference/api--blockchain-fees--v2/retrieve-fee-details-of-a-ledger"}]},{"group":"API - WALLETS - V2","pages":[{"openapi":"get /v2/api/core/wallets","title":"Return all wallets","href":"/api-reference/api--wallets--v2/return-all-wallets"},{"openapi":"post /v2/api/core/wallets","title":"Create new wallet","href":"/api-reference/api--wallets--v2/create-new-wallet"},{"openapi":"get /v2/api/core/wallets/{walletId}","title":"Return a single wallet by ID","href":"/api-reference/api--wallets--v2/return-a-single-wallet-by-id"},{"openapi":"get /v2/api/core/wallets/{walletId}/address","title":"Return a wallet address for a given currency","href":"/api-reference/api--wallets--v2/return-a-wallet-address-for-a-given-currency"},{"openapi":"get /v2/api/core/wallets/{walletId}/intent","title":"Get the payload to create new wallet","href":"/api-reference/api--wallets--v2/get-the-payload-to-create-new-wallet"},{"openapi":"post /v2/api/core/wallets/{walletId}/intent","title":"Submit the payload to create new wallet","href":"/api-reference/api--wallets--v2/submit-the-payload-to-create-new-wallet"},{"openapi":"get /v2/api/core/wallets/{walletId}/approver/{approverId}","title":"Get the payload to approve/reject new wallet","href":"/api-reference/api--wallets--v2/get-the-payload-to-approvereject-new-wallet"},{"openapi":"post /v2/api/core/wallets/{walletId}/action","title":"Submit the payload to approve/reject new wallet","href":"/api-reference/api--wallets--v2/submit-the-payload-to-approvereject-new-wallet"},{"openapi":"get /v2/api/core/wallets/{walletId}/transactions/in","title":"Get incoming transactions by wallet ID","href":"/api-reference/api--wallets--v2/get-incoming-transactions-by-wallet-id"},{"openapi":"get /v2/api/core/wallets/{walletId}/transactions/out","title":"Get outgoing transactions by wallet ID","href":"/api-reference/api--wallets--v2/get-outgoing-transactions-by-wallet-id"}]},{"group":"API - TRANSACTIONS - V2","pages":[{"openapi":"post /v2/api/core/transactions","title":"Create new outgoing transaction","href":"/api-reference/api--transactions--v2/create-new-outgoing-transaction"},{"openapi":"get /v2/api/core/transactions/{transactionId}/intent","title":"Get the payload to create new outgoing transaction","href":"/api-reference/api--transactions--v2/get-the-payload-to-create-new-outgoing-transaction"},{"openapi":"post /v2/api/core/transactions/intent","title":"Submit the payload to create new outgoing transaction","href":"/api-reference/api--transactions--v2/submit-the-payload-to-create-new-outgoing-transaction"},{"openapi":"get /v2/api/core/transactions/{transactionId}/approver/{approverId}","title":"Get the payload to approve/reject new outgoing transaction","href":"/api-reference/api--transactions--v2/get-the-payload-to-approvereject-new-outgoing-transaction"},{"openapi":"post /v2/api/core/transactions/action","title":"Submit the payload to approve/reject new outgoing transaction","href":"/api-reference/api--transactions--v2/submit-the-payload-to-approvereject-new-outgoing-transaction"},{"openapi":"get /v2/api/core/transactions/{transactionId}/out","title":"Get an outgoing transaction by ID","href":"/api-reference/api--transactions--v2/get-an-outgoing-transaction-by-id"},{"openapi":"get /v2/api/core/transactions/stats","title":"Return transactions statistics","href":"/api-reference/api--transactions--v2/return-transactions-statistics"},{"openapi":"get /v2/api/core/transactions/{transactionId}/in","title":"Get an incoming transaction by ID","href":"/api-reference/api--transactions--v2/get-an-incoming-transaction-by-id"}]}]},{"group":"Interchange (V3)","pages":[{"openapi":"post /v3/api/interchange/settlement/status","title":"Check the status of the settlement instructions","href":"/api-reference/interchange-v3/check-the-status-of-the-settlement-instructions"},{"openapi":"post /v3/api/interchange/withdrawal/confirm","title":"Confirm or reject a withdrawal from a trading vault","href":"/api-reference/interchange-v3/confirm-or-reject-a-withdrawal-from-a-trading-vault"},{"openapi":"post /v3/api/interchange/settlement/create","title":"Create a settlement instruction","href":"/api-reference/interchange-v3/create-a-settlement-instruction"},{"openapi":"post /v3/api/interchange/settlement/wallet/whitelisted/address","title":"List interchange whitelisted addresses","href":"/api-reference/interchange-v3/list-interchange-whitelisted-addresses"},{"openapi":"post /v3/api/trading/vaults","title":"Retrieve all vaults","href":"/api-reference/interchange-v3/retrieve-all-vaults"},{"openapi":"post /v3/api/trading/wallets","title":"Retrieve all wallets","href":"/api-reference/interchange-v3/retrieve-all-wallets"},{"openapi":"post /v3/api/trading/vaults/addresses/generate","title":"Retrieve an address for a vault","href":"/api-reference/interchange-v3/retrieve-an-address-for-a-vault"},{"openapi":"post /v3/api/trading/wallets/addresses/generate","title":"Retrieve an address for a wallet","href":"/api-reference/interchange-v3/retrieve-an-address-for-a-wallet"},{"openapi":"post /v3/api/interchange/settlement/wallet","title":"Retrieve settlement wallet for Venue","href":"/api-reference/interchange-v3/retrieve-settlement-wallet-for-venue"},{"openapi":"post /v3/api/interchange/settlements","title":"Retrieve settlements","href":"/api-reference/interchange-v3/retrieve-settlements"},{"openapi":"post /v3/api/trading/transactions","title":"Retrieve transactions","href":"/api-reference/interchange-v3/retrieve-transactions"},{"openapi":"post /v3/api/trading/wallets/balance","title":"Retrieve wallet balances","href":"/api-reference/interchange-v3/retrieve-wallet-balances"},{"openapi":"post /v3/api/trading/wallets/addresses","title":"Return list of generated addresses","href":"/api-reference/interchange-v3/return-list-of-generated-addresses"},{"openapi":"post /v3/api/interchange/settlement/wallet/addresses","title":"Return list of generated addresses for settlement wallet","href":"/api-reference/interchange-v3/return-list-of-generated-addresses-for-settlement-wallet"},{"openapi":"post /v3/api/trading/vaults/addresses","title":"Return list of generated addresses for vaults","href":"/api-reference/interchange-v3/return-list-of-generated-addresses-for-vaults"},{"openapi":"post /v3/api/interchange/settlement/transactions","title":"Whitelist senders for settlement transactions","href":"/api-reference/interchange-v3/whitelist-senders-for-settlement-transactions"}]},{"group":"Network Management (V3)","pages":[{"openapi":"post /v3/api/compliance/vasps/{vasp-id}/activate/{valid}","title":"Activate or Deactivate VASP","href":"/api-reference/network-v3/activate-or-deactivate-vasp"},{"openapi":"post /v3/api/compliance/vasps","title":"Create VASP","href":"/api-reference/network-v3/create-vasp"},{"openapi":"post /v3/api/netwmgmt/addresses","title":"Retrieve addresses","href":"/api-reference/network-v3/retrieve-addresses"},{"openapi":"post /v3/api/netwmgmt/beneficiaries","title":"Retrieve beneficiaries","href":"/api-reference/network-v3/retrieve-beneficiaries"},{"openapi":"post /v3/api/netwmgmt/vasps","title":"Retrieve onboarded VASPs","href":"/api-reference/network-v3/retrieve-onboarded-vasps"},{"openapi":"post /v3/api/transfer-rule/wallets","title":"Retrieve transfer rules","href":"/api-reference/network-v3/retrieve-transfer-rules"},{"openapi":"post /v3/api/compliance/vasps/{vasp-id}","title":"Update VASP","href":"/api-reference/network-v3/update-vasp"}]},{"group":"Service Desk (V3)","pages":[{"openapi":"post /v3/api/servicedesk/approve","title":"Approve or reject an instruction","href":"/api-reference/servicedesk-v3/approve-or-reject-an-instruction"},{"openapi":"post /v3/api/servicedesk/create","title":"Create service request","href":"/api-reference/servicedesk-v3/create-service-request"},{"openapi":"post /v3/api/servicedesk/requests","title":"List service requests","href":"/api-reference/servicedesk-v3/list-service-requests"},{"openapi":"post /v3/api/servicedesk/audit-trail","title":"Retrieve audit trail","href":"/api-reference/servicedesk-v3/retrieve-audit-trail"},{"openapi":"post /v3/api/servicedesk/products","title":"Retrieve products and services","href":"/api-reference/servicedesk-v3/retrieve-products-and-services"},{"openapi":"post /v3/api/servicedesk/pending","title":"Retrieve the instruction to sign","href":"/api-reference/servicedesk-v3/retrieve-the-instruction-to-sign"},{"openapi":"post /v3/api/servicedesk/submit","title":"Submit service request","href":"/api-reference/servicedesk-v3/submit-service-request"}]},{"group":"Reporting (V3)","pages":[{"openapi":"post /v3/api/ase/staking/report/data","title":"Get Staking Report Data","href":"/api-reference/reporting-v3/get-staking-report-data"}]},{"group":"Service Desk Guide","pages":[{"title":"Service Desk Guide","href":"/service-desk-guide"},{"title":"Products \u0026 Services","href":"/service-desk-guide/products-and-services"},{"title":"Wallet Creation","href":"/service-desk-guide/wallet-creation"},{"title":"Beneficiary Creation","href":"/service-desk-guide/beneficiary-creation"},{"title":"Whitelist an Address","href":"/service-desk-guide/whitelist-address"},{"title":"Instruct a Transfer","href":"/service-desk-guide/instruct-transfer"}]},{"group":"Status Reference","pages":[{"title":"Status Reference","href":"/status-reference"},{"title":"Service Desk Statuses","href":"/status-reference/service-desk"},{"title":"Wallet Statuses","href":"/status-reference/wallet"},{"title":"Transfer Statuses","href":"/status-reference/transfer"},{"title":"Interchange Statuses","href":"/status-reference/interchange"},{"title":"ETH Validator Statuses","href":"/status-reference/eth-validator"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks"},{"title":"Using REST API","href":"/webhooks/rest-api"},{"title":"Using JMS","href":"/webhooks/jms"}]},{"group":"FAQs","pages":[{"title":"FAQs","href":"/faqs"}]},{"group":"What's New","pages":[{"title":"What's New","href":"/whats-new"}]},{"group":"Interchange Guide","pages":[{"title":"Interchange Guide","href":"/interchange-guide"},{"title":"Approval Modes","href":"/interchange-guide/approval-modes"},{"title":"Getting Started (Client)","href":"/interchange-guide/client"},{"title":"Getting Started (Trading Venue)","href":"/interchange-guide/trading-venue"}]},{"group":"AI Tools","pages":[{"title":"Onboarding with Claude Code","href":"/ai-guides/claude-code-onboarding"}]},{"group":"Staking","pages":[{"title":"ETH Staking","href":"/staking-guide"},{"title":"SOL Staking","href":"/staking-guide/solana"},{"title":"ADA Staking","href":"/staking-guide/cardano"},{"title":"DOT Staking","href":"/staking-guide/polkadot"}]}]}]},"basePath":"","title":"Retrieve wallets - Zodia Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}