A signed message proving ownership of the wallet: a base64 signature by the wallet itself, or, for a Squads Smart Account vault on Solana, signatures by its members.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Crossmint Docs","colors":{"primary":"#36b37e","light":"#87ff8f","dark":"#001d01"},"logo":{"light":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928","dark":"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-dark.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=272ecc17664d17b9ff24471758ff80b2"},"favicon":"https://mintcdn.com/crossmint/xq66q9GV6z6jjj95/favicon.png?fit=max\u0026auto=format\u0026n=xq66q9GV6z6jjj95\u0026q=85\u0026s=00fb89ddf6ba5b1022b9307039c08006","api":{"openapi":["api-reference/_open-api/MintingAPIs.json","api-reference/_open-api/AdminAPIs.json","api-reference/_open-api/VerifiableCredentialsAPIs.json","api-reference/_open-api/Wallets.json"],"examples":{"prefill":true}},"background":{"color":{"dark":"#090b0c"}},"navbar":{"links":[{"href":"https://www.crossmint.com/contact","label":"Support"},{"href":"https://staging.crossmint.com/console","label":"Staging Console"}],"primary":{"type":"button","label":"Console","href":"https://www.crossmint.com/console"}},"footer":{"socials":{"website":"https://www.crossmint.com","twitter":"https://twitter.com/crossmint","github":"https://github.com/crossmint"}},"integrations":{"ga4":{"measurementId":"G-CP5EDD6GVT"},"posthog":{"apiKey":"phc_tfgodwfjuO9v3Nw0tIWJNzACoi2opL7X2Ly0Mg2UCTz","apiHost":"https://eu.i.posthog.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"crossmint","hasAudioNarration":false,"actualSubdomain":"crossmint","customDomains":["docs.crossmint.com"],"gitSource":{"type":"github","owner":"paella-labs","repo":"crossbit-main","deployBranch":"main","contentDirectory":"apps/crossmint-mintlify-docs/src","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"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":"6af3b7330e79df79aeeb2e6e","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1094},{"language":"default","tag":"Wallets","count":870},{"language":"default","tag":"Kotlin SDK","count":427},{"language":"default","tag":"Swift SDK","count":237},{"language":"default","tag":"Checkout","count":196},{"language":"default","tag":"Classes","count":182},{"language":"default","tag":"Data Classes","count":182},{"language":"default","tag":"Typescript SDK","count":156},{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Structs","count":127}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":false,"deflection":{"enabled":true,"type":"link","url":"https://www.crossmint.com/contact/sales"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".tab-container [data-component-part=\"tabs-list\"]{flex-wrap:wrap;overflow:visible;row-gap:0.25rem}.tab-container [data-component-part=\"tabs-list\"]>li{white-space:nowrap}.nav-dropdown-item,.nav-dropdown-item *{font-weight:500!important;color:rgb(75, 85, 99)!important}.nav-dropdown-item:hover,.nav-dropdown-item:hover *{color:rgb(31, 41, 55)!important}.dark .nav-dropdown-item,.dark .nav-dropdown-item *{color:rgb(156, 163, 175)!important}.dark .nav-dropdown-item:hover,.dark .nav-dropdown-item:hover *{color:rgb(209, 213, 219)!important}"}],"page":{"pagePath":"api-reference/users/link-wallet","slug":"/api-reference/users/link-wallet","pageMetadata":{"openapi":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}/linked-wallets/{address}","title":"Link External Wallet to User","description":"Link an external wallet address to a user. Optionally provide a proof to verify ownership.\n\n**API scope required**: `users.create`","href":"/api-reference/users/link-wallet"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Link an external wallet address to a user. Optionally provide a proof to verify ownership.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"API scope required\"\n }), \": \", _jsx(_components.code, {\n children: \"users.create\"\n })]\n })]\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":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}/linked-wallets/{address}","title":"Link External Wallet to User","description":"Link an external wallet address to a user. Optionally provide a proof to verify ownership.\n\n**API scope required**: `users.create`","href":"/api-reference/users/link-wallet"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/crossmint/d1c432d03c0c4224/scripts/dd.js","/_mintlify/custom/crossmint/7fc8d54052d3edb0/scripts/hubspot.js"],"openApiReferenceData":{"operation":{"description":"Link an external wallet address to a user. Optionally provide a proof to verify ownership.\n\n**API scope required**: `users.create`","operationId":"users.linkedWallets.link","parameters":["28eb95a3-5cc2-479d-a7a0-5ddbd96209d7","9da38677-fef9-44ee-a182-e2a2919a731e"],"requestBody":"32369e2c-2c9b-4670-8a79-5921c91a4a22","responses":{"200":"2ed17d62-d50c-4ee2-a083-58055e216545"},"security":["49434e82-f2ac-46fc-84f2-56be777e3a8e"],"summary":"Link External Wallet to User","tags":["Users - Linked Wallets"],"method":"put","type":"path","servers":["e0901d56-1e08-4bd4-9ae9-0d2261fea77b","c323b152-217b-4abe-8e41-971facf9f6db"],"path":"/2025-06-09/users/{userLocator}/linked-wallets/{address}","baseUrlOptions":["https://staging.crossmint.com/api","https://www.crossmint.com/api"],"title":"Link External Wallet to User","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.chain":"base"},{"body.chain":"solana"}]},"dependencies":{"parameters":{"28eb95a3-5cc2-479d-a7a0-5ddbd96209d7":{"description":"A user locator can be of the format:\n- `email:\u003cemail>`\n- `userId:\u003cuserId>`\n- `phoneNumber:\u003cphoneNumber>`\n- `twitter:\u003chandle>`\n- `x:\u003chandle>`","in":"path","name":"userLocator","required":true,"schema":{"examples":["email:user@example.com","userId:507f1f77bcf86cd799439011","userId:did:example:cm4lr5piw0h6t1bjho0onryql","phoneNumber:+12125551234","twitter:johndoe","x:@johndoe"],"type":"string","isRequired":true,"description":"A user locator can be of the format:\n- `email:\u003cemail>`\n- `userId:\u003cuserId>`\n- `phoneNumber:\u003cphoneNumber>`\n- `twitter:\u003chandle>`\n- `x:\u003chandle>`","uniqueKey":"","typeLabel":"string"}},"9da38677-fef9-44ee-a182-e2a2919a731e":{"in":"path","name":"address","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"EVM":{"title":"EVM","description":"Link an EVM wallet on Base. The response has a `verificationChallenge`. To verify ownership, sign it with the wallet and send the request again with the signature as `proof`.","value":{"chain":"base"}},"Solana":{"title":"Solana","description":"Link a Solana wallet. The response has a `verificationChallenge`. To verify ownership, sign it with the wallet and send the request again with the signature as `proof`.","value":{"chain":"solana"}}},"schema":{"properties":{"chain":{"description":"The blockchain of the wallet","enum":["abstract","abstract-testnet","apechain","aptos","arbitrum","arbitrum-sepolia","arbitrumnova","arc","arc-testnet","astar-zkevm","avalanche","avalanche-fuji","base","base-goerli","base-sepolia","bsc","bsc-testnet","celo","celo-sepolia","chiliz","chiliz-spicy-testnet","coti","coti-testnet","curtis","elysium","elysium-testnet","ethereum","ethereum-goerli","ethereum-sepolia","flow","flow-testnet","hedera","hedera-testnet","hypersonic-testnet","lightlink","lightlink-pegasus","mantle","mantle-sepolia","mode","mode-sepolia","optimism","optimism-goerli","optimism-sepolia","plume","plume-testnet","polygon","polygon-amoy","polygon-mumbai","rari","rari-testnet","robinhood-chain","robinhood-chain-testnet","scroll","scroll-sepolia","sei-atlantic-2-testnet","sei-pacific-1","shape","shape-sepolia","skale-nebula","skale-nebula-testnet","solana","soneium","soneium-minato-testnet","space","space-testnet","stellar","story","story-testnet","sui","tempo","tempo-testnet","u2u-nebulas","u2u-solaris","verify-testnet","viction","viction-testnet","world-chain","world-chain-sepolia","xai","xai-sepolia-testnet","xion","zenchain-testnet","zkatana","zkyoto","zora","zora-goerli","zora-sepolia"],"examples":["solana"],"type":"string","isRequired":true,"uniqueKey":"chain","typeLabel":"enum\u003cstring>"},"proof":{"oneOf":[{"type":"object","description":"A signed message proving ownership of the wallet: a base64 signature by the wallet itself, or, for a Squads Smart Account vault on Solana, signatures by its members.","required":["accountIndex","settings","signatures","type"],"properties":{"accountIndex":{"description":"The index of the vault under the Settings account (a u8).","examples":[0],"maximum":255,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"proof.oneOf.0.accountIndex","typeLabel":"integer"},"settings":{"description":"The base58 address of the smart account's Settings account.","examples":["41i3Jkdn93M6JxiVqzeL4J6MfJiLD9RyYYSF4oAsLEPZ"],"minLength":1,"type":"string","isRequired":true,"uniqueKey":"proof.oneOf.0.settings","typeLabel":"string"},"signatures":{"description":"Signatures over the challenge, each a base58 member key and a base64 ed25519 signature: one by a member holding the Initiate, Vote and Execute permissions, or enough to reach the smart account's threshold.","items":{"properties":{"signature":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"proof.oneOf.0.signatures.items.[INDEX].signature","typeLabel":"string"},"signer":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"proof.oneOf.0.signatures.items.[INDEX].signer","typeLabel":"string"}},"required":["signature","signer"],"type":"object","uniqueKey":"proof.oneOf.0.signatures.items.[INDEX]","typeLabel":"object"},"maxItems":10,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"proof.oneOf.0.signatures","typeLabel":"object[]"},"type":{"const":"solana-smart-account","type":"string","isRequired":true,"uniqueKey":"proof.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"proof.oneOf.0","typeLabel":"object"},{"type":"string","description":"A signed message proving ownership of the wallet: a base64 signature by the wallet itself, or, for a Squads Smart Account vault on Solana, signatures by its members.","minLength":1,"uniqueKey":"proof.oneOf.1","typeLabel":"string"}],"uniqueKey":"proof","typeLabel":"object | string"}},"required":["chain"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"2ed17d62-d50c-4ee2-a083-58055e216545":{"content":{"application/json":{"schema":{"properties":{"address":{"description":"The wallet address","examples":["0x1234567890abcdef1234567890abcdef12345678"],"type":"string","isRequired":true,"uniqueKey":"address","typeLabel":"string"},"chain":{"description":"The blockchain of the wallet","enum":["abstract","abstract-testnet","apechain","aptos","arbitrum","arbitrum-sepolia","arbitrumnova","arc","arc-testnet","astar-zkevm","avalanche","avalanche-fuji","base","base-goerli","base-sepolia","bsc","bsc-testnet","celo","celo-sepolia","chiliz","chiliz-spicy-testnet","coti","coti-testnet","curtis","elysium","elysium-testnet","ethereum","ethereum-goerli","ethereum-sepolia","flow","flow-testnet","hedera","hedera-testnet","hypersonic-testnet","lightlink","lightlink-pegasus","mantle","mantle-sepolia","mode","mode-sepolia","optimism","optimism-goerli","optimism-sepolia","plume","plume-testnet","polygon","polygon-amoy","polygon-mumbai","rari","rari-testnet","robinhood-chain","robinhood-chain-testnet","scroll","scroll-sepolia","sei-atlantic-2-testnet","sei-pacific-1","shape","shape-sepolia","skale-nebula","skale-nebula-testnet","solana","soneium","soneium-minato-testnet","space","space-testnet","stellar","story","story-testnet","sui","tempo","tempo-testnet","u2u-nebulas","u2u-solaris","verify-testnet","viction","viction-testnet","world-chain","world-chain-sepolia","xai","xai-sepolia-testnet","xion","zenchain-testnet","zkatana","zkyoto","zora","zora-goerli","zora-sepolia"],"examples":["ethereum"],"type":"string","isRequired":true,"uniqueKey":"chain","typeLabel":"enum\u003cstring>"},"ownership":{"oneOf":[{"type":"object","description":"Ownership verification status of the wallet","required":["verified"],"properties":{"verified":{"const":true,"description":"Whether the wallet ownership has been verified","examples":[true],"type":"boolean","isRequired":true,"uniqueKey":"ownership.oneOf.0.verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"ownership.oneOf.0","typeLabel":"object"},{"type":"object","description":"Ownership verification status of the wallet","required":["verificationChallenge","verified"],"properties":{"verificationChallenge":{"description":"The challenge message that must be signed to verify ownership","type":"string","isRequired":true,"uniqueKey":"ownership.oneOf.1.verificationChallenge","typeLabel":"string"},"verified":{"const":false,"description":"Whether the wallet ownership has been verified","examples":[false],"type":"boolean","isRequired":true,"uniqueKey":"ownership.oneOf.1.verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"ownership.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"ownership","typeLabel":"object"},"type":{"description":"The type of linked wallet","enum":["external-wallet"],"examples":["external-wallet"],"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"required":["address","chain","ownership","type"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"address":"0x1234567890abcdef1234567890abcdef12345678","chain":"ethereum","ownership":{"verified":true},"type":"external-wallet"}}},"exampleType":"generated"}},"description":"Wallet linked to user","exampleType":"generated"}},"security":{"49434e82-f2ac-46fc-84f2-56be777e3a8e":{"apiKey":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"}}},"servers":{"e0901d56-1e08-4bd4-9ae9-0d2261fea77b":{"description":"Staging environment (testnets)","url":"https://staging.crossmint.com/api"},"c323b152-217b-4abe-8e41-971facf9f6db":{"description":"Production environment (mainnets)","url":"https://www.crossmint.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"API key required for authentication","in":"header","name":"X-API-KEY","type":"apiKey","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-KEY","type":"string","description":"API key required for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-KEY"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/_open-api/Users.json"},"subdomain":"crossmint","siteName":"Crossmint Docs","title":"Link External Wallet to User - Crossmint Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-24T00:43:48.426Z","originalFileLocation":"api-reference/users/link-wallet.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=\"system\"}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=\"Link an external wallet address to a user. Optionally provide a proof to verify ownership. API scope required: users.create\">\u003cmeta data-mint-head name=\"application-name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Link External Wallet to User - Crossmint Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Link an external wallet address to a user. Optionally provide a proof to verify ownership. API scope required: users.create\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Crossmint Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.crossmint.com/api-reference/users/link-wallet\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=REST\u0026amp;title=Link+External+Wallet+to+User\u0026amp;description=Link+an+external+wallet+address+to+a+user.+Optionally+provide+a+proof+to+verify+ownership.%0A%0A**API+scope+required**%3A+%60users.create%60\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=f208f3e53a54a5511bc87fa87f14187ebc58df8051a267da71cddd3a268b4706\">\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=\"Link External Wallet to User - Crossmint Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Link an external wallet address to a user. Optionally provide a proof to verify ownership. API scope required: users.create\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://crossmint.mintlify.site/_mintlify/api/og/v2?division=REST\u0026amp;title=Link+External+Wallet+to+User\u0026amp;description=Link+an+external+wallet+address+to+a+user.+Optionally+provide+a+proof+to+verify+ownership.%0A%0A**API+scope+required**%3A+%60users.create%60\u0026amp;theme=b8bba0b38c114479513683ad\u0026amp;signature=f208f3e53a54a5511bc87fa87f14187ebc58df8051a267da71cddd3a268b4706\">\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/crossmint/-1hhMU0vchFPUD3H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Crossmint Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36b37e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.crossmint.com/api-reference/users/link-wallet\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/link-wallet.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.crossmint.com/#organization\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/crossmint/a8gPOTKEuVFcSfC3/logo/crossmint-light.png?fit=max\u0026auto=format\u0026n=a8gPOTKEuVFcSfC3\u0026q=85\u0026s=8c2671e4c8f7da6956e1508bd68c2928\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.crossmint.com#website\",\"name\":\"Crossmint Docs\",\"url\":\"https://docs.crossmint.com\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.crossmint.com/api-reference/users/link-wallet#webpage\",\"url\":\"https://docs.crossmint.com/api-reference/users/link-wallet\",\"name\":\"Link External Wallet to User\",\"description\":\"Link an external wallet address to a user. Optionally provide a proof to verify ownership. API scope required: users.create\",\"dateModified\":\"2026-02-24T00:43:48.426Z\",\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.crossmint.com/api-reference/users/link-wallet#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.crossmint.com/api-reference/users/link-wallet#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.crossmint.com/api-reference/users/upsert-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST\",\"item\":\"https://docs.crossmint.com/api-reference/users/upsert-user\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Link External Wallet to User\",\"item\":\"https://docs.crossmint.com/api-reference/users/link-wallet\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.crossmint.com/api-reference/users/link-wallet#apireference\",\"headline\":\"Link External Wallet to User\",\"name\":\"Link External Wallet to User\",\"description\":\"Link an external wallet address to a user. Optionally provide a proof to verify ownership. API scope required: users.create\",\"url\":\"https://docs.crossmint.com/api-reference/users/link-wallet\",\"mainEntityOfPage\":{\"@id\":\"https://docs.crossmint.com/api-reference/users/link-wallet#webpage\"},\"dateModified\":\"2026-02-24T00:43:48.426Z\",\"publisher\":{\"@id\":\"https://docs.crossmint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.crossmint.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/users/link-wallet.md","siteName":"Crossmint Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/introduction/platform-overview"}]},{"tab":"Wallets","pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Identity","groups":[{"group":"Introduction","pages":[{"title":"Overview","href":"/identity/overview"}]},{"group":"Quickstarts ⚡","pages":[{"title":"Quickstart ⚡","sidebarTitle":"REST API","href":"/identity/quickstart"}]},{"group":"Guides","pages":[{"title":"Register User Data","href":"/identity/register-user-data"},{"title":"Data Requirements","href":"/identity/data-requirements"},{"title":"UI Customization","href":"/identity/ui-customization"},{"title":"Failure Reasons","href":"/identity/failure-reasons"}]},{"group":"API Reference","pages":[{"group":"REST","icon":"brackets-curly","pages":[{"openapi":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}","title":"Create or Update User","href":"/api-reference/users/upsert-user"},{"openapi":"api-reference/_open-api/Users.json GET /2025-06-09/users/{userLocator}","title":"Get a User","href":"/api-reference/users/get-user"},{"openapi":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}/legal-documents","title":"Accept Legal Document","href":"/api-reference/users/accept-legal-document"},{"openapi":"api-reference/_open-api/Users.json POST /2025-06-09/documents","title":"Upload a User Document","href":"/api-reference/users/upload-document"},{"openapi":"api-reference/_open-api/Users.json GET /2025-06-09/documents/{documentId}","title":"Get a User Document by ID","href":"/api-reference/users/get-document"},{"openapi":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}/identity-verification","title":"Trigger Identity Verification","href":"/api-reference/users/trigger-identity-verification"},{"openapi":"api-reference/_open-api/Users.json GET /2025-06-09/users/{userLocator}/identity-verification","title":"Get Identity Verification Status","description":"Get identity verification status for a user.\n\n**API scope required**: `users.read`","href":"/api-reference/users/get-identity-verification"},{"openapi":"api-reference/_open-api/Users.json PUT /2025-06-09/users/{userLocator}/linked-wallets/{address}","title":"Link External Wallet to User","href":"/api-reference/users/link-wallet"},{"openapi":"api-reference/_open-api/Users.json GET /2025-06-09/users/{userLocator}/linked-wallets/{address}","title":"Get Linked External Wallet","description":"Get a linked external wallet for a user by address.\n\n**API scope required**: `users.read`","href":"/api-reference/users/get-linked-wallet"},{"openapi":"api-reference/_open-api/Users.json DELETE /2025-06-09/users/{userLocator}/linked-wallets/{address}","title":"Unlink External Wallet from User","href":"/api-reference/users/unlink-wallet"}]}]}]},{"tab":"Stablecoin Orchestration","pages":[{"title":"Stablecoin Orchestration","href":"/stablecoin-orchestration/overview"}]},{"tab":"Checkout","pages":[{"title":"Checkout","href":"/payments/introduction"}]},{"tab":"Onramp","pages":[{"title":"Onramp","href":"/onramp/overview"}]},{"tab":"Offramp","pages":[{"title":"Offramp","href":"/offramp/overview"}]},{"tab":"Agents","pages":[{"title":"Agents","href":"/agents/overview"}]},{"tab":"Others","menu":[{"item":"Tokenization","pages":[{"title":"Tokenization","href":"/tokenization/introduction"}]}],"pages":[{"title":"Others","href":"/tokenization/introduction"}]}]},"basePath":"","title":"Link External Wallet to User - Crossmint Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}