Exchange a user JWT for a session key authorized to act on the user’s wallets. Returns the encrypted authorization key and the list of wallets it can access.
Directly managing user authorization keys via the API is an advanced setting. We recommend using
Privy’s SDKs, which internally manage user authorization keys if applicable.
This endpoint is used to create an ephemeral signing key for signing requests to take actions with a user’s wallet.The returned key is encrypted using Hybrid Public Key Encryption (HPKE), with the following configuration:
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Privy Docs","colors":{"primary":"#010110","light":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/privy-c2af3412/Ih_Fo3QYM486gzWq/logo/privy-logo-light.png?fit=max\u0026auto=format\u0026n=Ih_Fo3QYM486gzWq\u0026q=85\u0026s=bd297b680ace8a13db4d9ce977f93180","dark":"https://mintcdn.com/privy-c2af3412/Ih_Fo3QYM486gzWq/logo/privy-logo-dark.png?fit=max\u0026auto=format\u0026n=Ih_Fo3QYM486gzWq\u0026q=85\u0026s=24d83970695ab19a1803a2eb00dbea4e"},"favicon":"https://mintcdn.com/privy-c2af3412/YByWVKlFbSpnpSJG/favicon.png?fit=max\u0026auto=format\u0026n=YByWVKlFbSpnpSJG\u0026q=85\u0026s=ee4038168ea586e5f72041e5e2a1f5c8","api":{"openapi":{"source":"https://api.staging.privy.io/v1/openapi.json"},"playground":{"display":"interactive"},"examples":{"languages":["curl","java","javascript","php","go"]},"mdx":{"server":"https://api.privy.io"}},"background":{"color":{"light":"#FFFFFF","dark":"#010110"}},"navbar":{"links":[{"href":"https://demo.privy.io","label":"Demo"},{"href":"https://privy.io/slack","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.privy.io"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Privy Docs","og:image":"https://assets.privy.io/docs-og.png","twitter:title":"Privy Docs","twitter:card":"summary_large_image","twitter:image":"https://assets.privy.io/docs-og.png"},"organization":{"id":"https://www.privy.io/#organization","name":"Privy","url":"https://www.privy.io","logo":"https://assets.privy.io/docs-og.png","sameAs":["https://x.com/privy_io","https://github.com/privy-io"]}},"styling":{"codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"GTM-WV9MVTB3"}},"contextual":{"options":["claude","chatgpt","cursor","vscode","mcp","copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"privy-c2af3412","hasAudioNarration":false,"actualSubdomain":"privy-c2af3412","customDomains":["docs.privy.io"],"gitSource":{"type":"github","owner":"privy-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecc9ae476472d09cb894df","collectionId":"1b5f8b7f-2fa3-4e12-aea2-7cc2d8b90490","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecc9ae476472d09cb894df"},"feedback":{"issues":true,"thumbs":true,"edits":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":"6aee6add0cb48ef71e0f1964","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Wallets","count":291},{"language":"default","tag":"API reference","count":255},{"language":"default","tag":"Recipes","count":141},{"language":"default","tag":"All recipes","count":140},{"language":"default","tag":"Identity","count":137},{"language":"default","tag":"Signatures and transactions","count":91},{"language":"default","tag":"Users","count":87},{"language":"default","tag":"Basics","count":86},{"language":"default","tag":"Financial flows","count":82},{"language":"default","tag":"Controls","count":76}]},"assistantConfig":{},"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/privy-c2af3412/106de3f982828597/style.css"}],"page":{"pagePath":"api-reference/wallets/authenticate","slug":"/api-reference/wallets/authenticate","pageMetadata":{"title":"Authenticate","openapi":"post /v1/wallets/authenticate","description":"Exchange a user JWT for a session key authorized to act on the user's wallets. Returns the encrypted authorization key and the list of wallets it can access.","href":"/api-reference/wallets/authenticate"},"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: \"Exchange a user JWT for a session key authorized to act on the user’s wallets. Returns the encrypted authorization key and the list of wallets it can access.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsx(_components.p,{children:`Directly managing user authorization keys via the API is an advanced setting. We recommend using\nPrivy’s SDKs, which internally manage user authorization keys if applicable.`})}),`\n`,_jsxs(_components.p,{children:[`This endpoint is used to create an ephemeral signing key for signing requests to `,_jsx(_components.a,{href:`/api-reference/wallets/ethereum/eth-send-transaction`,children:`take actions`}),` with a user’s wallet.`]}),`\n`,_jsx(_components.p,{children:`The returned key is encrypted using Hybrid Public Key Encryption (HPKE), with the following configuration:`}),`\n`,_jsxs(`ul`,{children:[_jsx(`li`,{children:`KEM (Key Encapsulation Mechanism): DHKEM_P256_HKDF_SHA256`}),_jsx(`li`,{children:`KDF (Key Derivation Function): HKDF_SHA256`}),_jsx(`li`,{children:`AEAD (Authenticated Encryption with Associated Data): CHACHA20_POLY1305`}),_jsx(`li`,{children:`Mode: BASE`})]}),`\n`,_jsxs(_components.p,{children:[`The response `,_jsx(_components.code,{children:`authorization_key`}),` is ciphertext and must be decrypted.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Authenticate","openapi":"post /v1/wallets/authenticate","description":"Exchange a user JWT for a session key authorized to act on the user's wallets. Returns the encrypted authorization key and the list of wallets it can access.","href":"/api-reference/wallets/authenticate"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/privy-c2af3412/9a6cfa36ced76db0/welcome.js","/_mintlify/custom/privy-c2af3412/1af79d46bd64cd8b/fullstory.js","/_mintlify/custom/privy-c2af3412/e4d91321024fde21/recipes/recipes-search.js","/_mintlify/custom/privy-c2af3412/d31c5451398ab22c/check-links.js"],"openApiReferenceData":{"operation":{"tags":["Wallets"],"operationId":"authenticateWallet","summary":"Authenticate wallet session","description":"Exchange a user JWT for a session key authorized to act on the user's wallets. Returns the encrypted authorization key and the list of wallets it can access.","security":["f78b41c7-ef45-474d-b8e3-1c6f8cf33385"],"parameters":["a5fb80e7-ec60-4e17-a57e-3d40db912140","311246ea-310c-4457-992f-81a7659d7348"],"requestBody":"152a2ea0-6d5d-42ca-a3ef-4e9da0cf47e8","responses":{"200":"67fd354e-9b25-4301-b3d0-d555f6907bc0"},"method":"post","type":"path","servers":["850974b1-506a-4d71-9130-47c1416abc38"],"path":"/v1/wallets/authenticate","baseUrlOptions":["https://api.privy.io"],"title":"Authenticate wallet session","codeSamples":[],"requestExampleLanguages":["bash","java","javascript","php","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a5fb80e7-ec60-4e17-a57e-3d40db912140":{"schema":{"type":"string","description":"ID of your Privy app.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"privy-app-id","in":"header"},"311246ea-310c-4457-992f-81a7659d7348":{"schema":{"type":"string","minLength":1,"description":"MFA token from a completed MFA verification, required on MFA-protected requests for users with MFA enrolled.","x-stainless-param":"mfa_token","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"MFA token from a completed MFA verification, required on MFA-protected requests for users with MFA enrolled.","name":"privy-mfa-token","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_jwt":{"type":"string","description":"The user's JWT, to be used to authenticate the user.","isRequired":true,"uniqueKey":"user_jwt","typeLabel":"string"},"encryption_type":{"type":"string","enum":["HPKE"],"description":"The encryption type for the authentication response. Currently only supports HPKE.","isRequired":true,"uniqueKey":"encryption_type","typeLabel":"enum\u003cstring>"},"recipient_public_key":{"type":"string","description":"The public key of your ECDH keypair, in base64-encoded, SPKI-format, whose private key will be able to decrypt the session key.","isRequired":true,"uniqueKey":"recipient_public_key","typeLabel":"string"}},"required":["user_jwt","encryption_type","recipient_public_key"],"additionalProperties":false,"description":"Request body for wallet authentication with HPKE-encrypted response.","title":"WalletAuthenticateRequestBody","x-stainless-model":"wallets.wallet_authenticate_request_body","uniqueKey":"","typeLabel":"WalletAuthenticateRequestBody · object"},"example":{"user_jwt":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30","encryption_type":"HPKE","recipient_public_key":"DAQcDQgAEx4aoeD72yykviK+fckqE2CItVIGn1rCnvCXZ1HgpOcMEMialRmTrqIK4oZlYd1"},"examples":{"Example":{"title":"Example","value":{"user_jwt":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30","encryption_type":"HPKE","recipient_public_key":"DAQcDQgAEx4aoeD72yykviK+fckqE2CItVIGn1rCnvCXZ1HgpOcMEMialRmTrqIK4oZlYd1"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"67fd354e-9b25-4301-b3d0-d555f6907bc0":{"description":"Object with authorization key and wallet IDs.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"EncryptedWalletAuthenticateResponse","description":"The response from authenticating a wallet with HPKE encryption, containing an encrypted authorization key and wallet data.","required":["encrypted_authorization_key","expires_at","wallets"],"x-stainless-model":"wallets.wallet_authenticate_with_jwt_response","example":{"encrypted_authorization_key":{"encryption_type":"HPKE","encapsulated_key":"BECqbgIAcs3TpP5GadS6F8mXkSktR2DR8WNtd3e0Qcy7PpoRHEygpzjFWttntS+SEM3VSr4Thewh18ZP9chseLE=","ciphertext":"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgsqM8IKMlpFxVypBUa/Q2QvB1AmS/g5WHPp3SKq9A75uhRANCAATeX6BDghwclKAH8+/7IjvS1tCpvIfZ570IR44acX93pUGz5iEvpkg+HGaalHAXubuoUMq9CUWRm4wo+3090Nus"},"expires_at":1697059200000,"wallets":[{"id":"ubul5xhljqorce73sf82u0p3","address":"0x3DE69Fd93873d40459f27Ce5B74B42536f8d6149","chain_type":"ethereum","policy_ids":[],"additional_signers":[{"signer_id":"p3cyj3n8mt9f9u2htfize511","override_policy_ids":[]}],"created_at":1744300912643,"owner_id":"lzjb3xnjk2ntod3w1hgwa358","parent_wallet_id":null,"entity":null,"exported_at":null,"imported_at":null,"archived_at":null},{"id":"sb4y18l68xze8gfszafmyv3q","address":"9wtGmqMamnKfz49XBwnJASbjcVnnKnT78qKopCL54TAk","chain_type":"solana","policy_ids":[],"additional_signers":[{"signer_id":"p3cyj3n8mt9f9u2htfize511","override_policy_ids":[]}],"created_at":1744300912644,"owner_id":"lzjb3xnjk2ntod3w1hgwa358","parent_wallet_id":null,"entity":null,"exported_at":null,"imported_at":null,"archived_at":null}]},"properties":{"encrypted_authorization_key":{"type":"object","properties":{"encryption_type":{"type":"string","enum":["HPKE"],"description":"The encryption type used. Currently only supports HPKE.","isRequired":true,"uniqueKey":"oneOf.0.encrypted_authorization_key.encryption_type","typeLabel":"enum\u003cstring>"},"encapsulated_key":{"type":"string","description":"Base64-encoded ephemeral public key used in the HPKE encryption process. Required for decryption.","isRequired":true,"uniqueKey":"oneOf.0.encrypted_authorization_key.encapsulated_key","typeLabel":"string"},"ciphertext":{"type":"string","description":"The encrypted authorization key corresponding to the user's current authentication session.","isRequired":true,"uniqueKey":"oneOf.0.encrypted_authorization_key.ciphertext","typeLabel":"string"}},"required":["encryption_type","encapsulated_key","ciphertext"],"description":"HPKE-encrypted authorization key with encapsulated key and ciphertext.","title":"EncryptedAuthorizationKey","x-stainless-model":"wallets.encrypted_authorization_key","isRequired":true,"uniqueKey":"oneOf.0.encrypted_authorization_key","typeLabel":"EncryptedAuthorizationKey · object"},"expires_at":{"type":"number","description":"The expiration time of the authorization key in milliseconds since the epoch.","isRequired":true,"uniqueKey":"oneOf.0.expires_at","typeLabel":"number"},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the wallet. This will be the primary identifier when using the wallet in the future.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].id","typeLabel":"string"},"address":{"type":"string","description":"Address of the wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].address","typeLabel":"string"},"created_at":{"type":"number","description":"Unix timestamp of when the wallet was created in milliseconds.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].created_at","typeLabel":"number"},"chain_type":{"type":"string","enum":["ethereum","solana","cosmos","stellar","sui","aptos","movement","tron","bitcoin-segwit","bitcoin-taproot","pearl","near","ton","starknet","xrpl","spark"],"description":"The wallet chain types.","title":"WalletChainType","x-stainless-model":"wallets.wallet_chain_type","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].chain_type","typeLabel":"enum\u003cstring>"},"policy_ids":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.wallets.items.[INDEX].policy_ids.items.[INDEX]","typeLabel":"string"},"description":"List of policy IDs for policies that are enforced on the wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].policy_ids","typeLabel":"string[]"},"owner_id":{"oneOf":[{"type":"string","format":"cuid2","description":"The key quorum ID of the owner of the wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].owner_id.oneOf.0","typeLabel":"string\u003ccuid2>"},{"type":"null","format":"cuid2","description":"The key quorum ID of the owner of the wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].owner_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].owner_id","typeLabel":"string\u003ccuid2> | null"},"additional_signers":{"type":"array","items":{"type":"object","properties":{"signer_id":{"type":"string","format":"cuid2","description":"A unique identifier for a key quorum.","title":"KeyQuorumId","x-stainless-model":"shared.key_quorum_id","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].additional_signers.items.[INDEX].signer_id","typeLabel":"string\u003ccuid2>"},"override_policy_ids":{"type":"array","items":{"type":"string","minLength":24,"maxLength":24,"format":"cuid2","uniqueKey":"oneOf.0.wallets.items.[INDEX].additional_signers.items.[INDEX].override_policy_ids.items.[INDEX]","typeLabel":"string\u003ccuid2>"},"maxItems":1,"description":"An optional list of up to one policy ID to enforce on the wallet.","title":"PolicyInput","x-stainless-model":"wallets.policy_input","uniqueKey":"oneOf.0.wallets.items.[INDEX].additional_signers.items.[INDEX].override_policy_ids","typeLabel":"string\u003ccuid2>[]"}},"required":["signer_id"],"additionalProperties":false,"description":"A single additional signer on a wallet, with an optional policy override.","title":"WalletAdditionalSignerItem","x-stainless-model":"wallets.wallet_additional_signer_item","uniqueKey":"oneOf.0.wallets.items.[INDEX].additional_signers.items.[INDEX]","typeLabel":"WalletAdditionalSignerItem · object"},"description":"Additional signers for the wallet.","title":"WalletAdditionalSigner","x-stainless-model":"wallets.wallet_additional_signer","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].additional_signers","typeLabel":"WalletAdditionalSignerItem · object[]"},"exported_at":{"oneOf":[{"type":"number","description":"Unix timestamp of when the wallet was exported in milliseconds, if the wallet was exported.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].exported_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of when the wallet was exported in milliseconds, if the wallet was exported.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].exported_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].exported_at","typeLabel":"number | null"},"imported_at":{"oneOf":[{"type":"number","description":"Unix timestamp of when the wallet was imported in milliseconds, if the wallet was imported.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].imported_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of when the wallet was imported in milliseconds, if the wallet was imported.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].imported_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].imported_at","typeLabel":"number | null"},"display_name":{"type":"string","description":"A human-readable label for the wallet.","uniqueKey":"oneOf.0.wallets.items.[INDEX].display_name","typeLabel":"string"},"external_id":{"type":"string","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","description":"A customer-provided identifier for mapping to external systems. URL-safe characters only ([a-zA-Z0-9_-]), max 64 chars. Write-once: cannot be changed once set.","uniqueKey":"oneOf.0.wallets.items.[INDEX].external_id","typeLabel":"string"},"public_key":{"type":"string","description":"The compressed, raw public key for the wallet along the chain cryptographic curve.","uniqueKey":"oneOf.0.wallets.items.[INDEX].public_key","typeLabel":"string"},"parent_wallet_id":{"oneOf":[{"type":"string","description":"ID of the HD root wallet this wallet was derived from, or null if it was not derived from another wallet.","uniqueKey":"oneOf.0.wallets.items.[INDEX].parent_wallet_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the HD root wallet this wallet was derived from, or null if it was not derived from another wallet.","uniqueKey":"oneOf.0.wallets.items.[INDEX].parent_wallet_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.wallets.items.[INDEX].parent_wallet_id","typeLabel":"string | null"},"entity":{"oneOf":[{"type":"object","title":"WalletEntity","description":"The entity the wallet is attributed to.","required":["id","type"],"x-stainless-model":"wallets.wallet_entity","example":{"id":"jorpjo4rfxj62nx1itt8y1zt","type":"user"},"properties":{"id":{"type":"string","minLength":1,"description":"A Privy entity ID.","title":"EntityId","example":"jorpjo4rfxj62nx1itt8y1zt","x-stainless-model":"wallets.entity_id","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].entity.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["user","organization"],"description":"The type of entity a wallet is attributed to.","title":"WalletEntityType","example":"user","x-stainless-model":"wallets.wallet_entity_type","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].entity.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.0.wallets.items.[INDEX].entity.oneOf.0","typeLabel":"WalletEntity · object"},{"type":"null","description":"The entity the wallet is attributed to.","uniqueKey":"oneOf.0.wallets.items.[INDEX].entity.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.wallets.items.[INDEX].entity","typeLabel":"WalletEntity · object | null"},"authorization_threshold":{"type":"number","description":"The number of keys that must sign for an action to be valid.","uniqueKey":"oneOf.0.wallets.items.[INDEX].authorization_threshold","typeLabel":"number"},"automations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the automation.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].automations.items.[INDEX].id","typeLabel":"string"},"enabled":{"type":"boolean","description":"Whether this attachment is currently active — true only if both the attachment and the underlying automation are enabled.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].automations.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["id","enabled"],"additionalProperties":false,"description":"A summary of an automation attached to a wallet.","title":"AttachedWalletAutomation","example":{"id":"id2tptkqrxd39qo9j423etij","enabled":true},"x-stainless-model":"wallets.attached_wallet_automation","uniqueKey":"oneOf.0.wallets.items.[INDEX].automations.items.[INDEX]","typeLabel":"AttachedWalletAutomation · object"},"description":"Automations attached to the wallet, including disabled ones.","uniqueKey":"oneOf.0.wallets.items.[INDEX].automations","typeLabel":"AttachedWalletAutomation · object[]"},"archived_at":{"oneOf":[{"type":"number","default":null,"description":"Unix timestamp of when the wallet was archived in milliseconds, or null if the wallet is active.","uniqueKey":"oneOf.0.wallets.items.[INDEX].archived_at.oneOf.0","typeLabel":"number"},{"type":"null","default":null,"description":"Unix timestamp of when the wallet was archived in milliseconds, or null if the wallet is active.","uniqueKey":"oneOf.0.wallets.items.[INDEX].archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.wallets.items.[INDEX].archived_at","typeLabel":"number | null"},"chain":{"type":"string","title":"CustodialWalletChain","description":"The chain of this wallet, only present for custodial wallets.","enum":["base","solana","tempo"],"x-stainless-model":"wallets.custodial_wallet_chain","example":"tempo","uniqueKey":"oneOf.0.wallets.items.[INDEX].chain","typeLabel":"enum\u003cstring>"},"custody":{"type":"object","properties":{"provider":{"type":"string","description":"The custodian responsible for the wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].custody.provider","typeLabel":"string"},"provider_user_id":{"type":"string","description":"The resource ID of the beneficiary of the custodial wallet.","isRequired":true,"uniqueKey":"oneOf.0.wallets.items.[INDEX].custody.provider_user_id","typeLabel":"string"}},"required":["provider","provider_user_id"],"description":"Information about the custodian managing this wallet.","title":"WalletCustodian","x-stainless-model":"wallets.wallet_custodian","uniqueKey":"oneOf.0.wallets.items.[INDEX].custody","typeLabel":"WalletCustodian · object"}},"required":["id","address","created_at","chain_type","policy_ids","owner_id","additional_signers","exported_at","imported_at"],"description":"A wallet managed by Privy's wallet infrastructure.","title":"Wallet","example":{"id":"id2tptkqrxd39qo9j423etij","address":"0xF1DBff66C993EE895C8cb176c30b07A559d76496","display_name":"Treasury","external_id":"my-order-123","chain_type":"ethereum","policy_ids":[],"additional_signers":[],"owner_id":"rkiz0ivz254drv1xw982v3jq","parent_wallet_id":null,"entity":{"id":"jorpjo4rfxj62nx1itt8y1zt","type":"user"},"created_at":1741834854578,"exported_at":null,"imported_at":null,"archived_at":null},"x-stainless-model":"wallets.wallet","uniqueKey":"oneOf.0.wallets.items.[INDEX]","typeLabel":"Wallet · object"},"isRequired":true,"uniqueKey":"oneOf.0.wallets","typeLabel":"Wallet · object[]"}},"uniqueKey":"oneOf.0","typeLabel":"EncryptedWalletAuthenticateResponse · object"},{"type":"object","title":"RawWalletAuthenticateResponse","description":"The response from authenticating a wallet without encryption, containing a raw authorization key and wallet data.","required":["authorization_key","expires_at","wallets"],"x-stainless-model":"wallets.wallet_authenticate_with_jwt_response","properties":{"authorization_key":{"type":"string","description":"The raw authorization key data.","isRequired":true,"uniqueKey":"oneOf.1.authorization_key","typeLabel":"string"},"expires_at":{"type":"number","description":"The expiration time of the authorization key in milliseconds since the epoch.","isRequired":true,"uniqueKey":"oneOf.1.expires_at","typeLabel":"number"},"wallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the wallet. This will be the primary identifier when using the wallet in the future.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].id","typeLabel":"string"},"address":{"type":"string","description":"Address of the wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].address","typeLabel":"string"},"created_at":{"type":"number","description":"Unix timestamp of when the wallet was created in milliseconds.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].created_at","typeLabel":"number"},"chain_type":{"type":"string","enum":["ethereum","solana","cosmos","stellar","sui","aptos","movement","tron","bitcoin-segwit","bitcoin-taproot","pearl","near","ton","starknet","xrpl","spark"],"description":"The wallet chain types.","title":"WalletChainType","x-stainless-model":"wallets.wallet_chain_type","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].chain_type","typeLabel":"enum\u003cstring>"},"policy_ids":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.wallets.items.[INDEX].policy_ids.items.[INDEX]","typeLabel":"string"},"description":"List of policy IDs for policies that are enforced on the wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].policy_ids","typeLabel":"string[]"},"owner_id":{"oneOf":[{"type":"string","format":"cuid2","description":"The key quorum ID of the owner of the wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].owner_id.oneOf.0","typeLabel":"string\u003ccuid2>"},{"type":"null","format":"cuid2","description":"The key quorum ID of the owner of the wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].owner_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].owner_id","typeLabel":"string\u003ccuid2> | null"},"additional_signers":{"type":"array","items":{"type":"object","properties":{"signer_id":{"type":"string","format":"cuid2","description":"A unique identifier for a key quorum.","title":"KeyQuorumId","x-stainless-model":"shared.key_quorum_id","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].additional_signers.items.[INDEX].signer_id","typeLabel":"string\u003ccuid2>"},"override_policy_ids":{"type":"array","items":{"type":"string","minLength":24,"maxLength":24,"format":"cuid2","uniqueKey":"oneOf.1.wallets.items.[INDEX].additional_signers.items.[INDEX].override_policy_ids.items.[INDEX]","typeLabel":"string\u003ccuid2>"},"maxItems":1,"description":"An optional list of up to one policy ID to enforce on the wallet.","title":"PolicyInput","x-stainless-model":"wallets.policy_input","uniqueKey":"oneOf.1.wallets.items.[INDEX].additional_signers.items.[INDEX].override_policy_ids","typeLabel":"string\u003ccuid2>[]"}},"required":["signer_id"],"additionalProperties":false,"description":"A single additional signer on a wallet, with an optional policy override.","title":"WalletAdditionalSignerItem","x-stainless-model":"wallets.wallet_additional_signer_item","uniqueKey":"oneOf.1.wallets.items.[INDEX].additional_signers.items.[INDEX]","typeLabel":"WalletAdditionalSignerItem · object"},"description":"Additional signers for the wallet.","title":"WalletAdditionalSigner","x-stainless-model":"wallets.wallet_additional_signer","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].additional_signers","typeLabel":"WalletAdditionalSignerItem · object[]"},"exported_at":{"oneOf":[{"type":"number","description":"Unix timestamp of when the wallet was exported in milliseconds, if the wallet was exported.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].exported_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of when the wallet was exported in milliseconds, if the wallet was exported.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].exported_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].exported_at","typeLabel":"number | null"},"imported_at":{"oneOf":[{"type":"number","description":"Unix timestamp of when the wallet was imported in milliseconds, if the wallet was imported.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].imported_at.oneOf.0","typeLabel":"number"},{"type":"null","description":"Unix timestamp of when the wallet was imported in milliseconds, if the wallet was imported.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].imported_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].imported_at","typeLabel":"number | null"},"display_name":{"type":"string","description":"A human-readable label for the wallet.","uniqueKey":"oneOf.1.wallets.items.[INDEX].display_name","typeLabel":"string"},"external_id":{"type":"string","maxLength":64,"pattern":"^[a-zA-Z0-9_-]+$","description":"A customer-provided identifier for mapping to external systems. URL-safe characters only ([a-zA-Z0-9_-]), max 64 chars. Write-once: cannot be changed once set.","uniqueKey":"oneOf.1.wallets.items.[INDEX].external_id","typeLabel":"string"},"public_key":{"type":"string","description":"The compressed, raw public key for the wallet along the chain cryptographic curve.","uniqueKey":"oneOf.1.wallets.items.[INDEX].public_key","typeLabel":"string"},"parent_wallet_id":{"oneOf":[{"type":"string","description":"ID of the HD root wallet this wallet was derived from, or null if it was not derived from another wallet.","uniqueKey":"oneOf.1.wallets.items.[INDEX].parent_wallet_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the HD root wallet this wallet was derived from, or null if it was not derived from another wallet.","uniqueKey":"oneOf.1.wallets.items.[INDEX].parent_wallet_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.wallets.items.[INDEX].parent_wallet_id","typeLabel":"string | null"},"entity":{"oneOf":[{"type":"object","title":"WalletEntity","description":"The entity the wallet is attributed to.","required":["id","type"],"x-stainless-model":"wallets.wallet_entity","example":{"id":"jorpjo4rfxj62nx1itt8y1zt","type":"user"},"properties":{"id":{"type":"string","minLength":1,"description":"A Privy entity ID.","title":"EntityId","example":"jorpjo4rfxj62nx1itt8y1zt","x-stainless-model":"wallets.entity_id","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].entity.oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["user","organization"],"description":"The type of entity a wallet is attributed to.","title":"WalletEntityType","example":"user","x-stainless-model":"wallets.wallet_entity_type","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].entity.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.1.wallets.items.[INDEX].entity.oneOf.0","typeLabel":"WalletEntity · object"},{"type":"null","description":"The entity the wallet is attributed to.","uniqueKey":"oneOf.1.wallets.items.[INDEX].entity.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.wallets.items.[INDEX].entity","typeLabel":"WalletEntity · object | null"},"authorization_threshold":{"type":"number","description":"The number of keys that must sign for an action to be valid.","uniqueKey":"oneOf.1.wallets.items.[INDEX].authorization_threshold","typeLabel":"number"},"automations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the automation.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].automations.items.[INDEX].id","typeLabel":"string"},"enabled":{"type":"boolean","description":"Whether this attachment is currently active — true only if both the attachment and the underlying automation are enabled.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].automations.items.[INDEX].enabled","typeLabel":"boolean"}},"required":["id","enabled"],"additionalProperties":false,"description":"A summary of an automation attached to a wallet.","title":"AttachedWalletAutomation","example":{"id":"id2tptkqrxd39qo9j423etij","enabled":true},"x-stainless-model":"wallets.attached_wallet_automation","uniqueKey":"oneOf.1.wallets.items.[INDEX].automations.items.[INDEX]","typeLabel":"AttachedWalletAutomation · object"},"description":"Automations attached to the wallet, including disabled ones.","uniqueKey":"oneOf.1.wallets.items.[INDEX].automations","typeLabel":"AttachedWalletAutomation · object[]"},"archived_at":{"oneOf":[{"type":"number","default":null,"description":"Unix timestamp of when the wallet was archived in milliseconds, or null if the wallet is active.","uniqueKey":"oneOf.1.wallets.items.[INDEX].archived_at.oneOf.0","typeLabel":"number"},{"type":"null","default":null,"description":"Unix timestamp of when the wallet was archived in milliseconds, or null if the wallet is active.","uniqueKey":"oneOf.1.wallets.items.[INDEX].archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.wallets.items.[INDEX].archived_at","typeLabel":"number | null"},"chain":{"type":"string","title":"CustodialWalletChain","description":"The chain of this wallet, only present for custodial wallets.","enum":["base","solana","tempo"],"x-stainless-model":"wallets.custodial_wallet_chain","example":"tempo","uniqueKey":"oneOf.1.wallets.items.[INDEX].chain","typeLabel":"enum\u003cstring>"},"custody":{"type":"object","properties":{"provider":{"type":"string","description":"The custodian responsible for the wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].custody.provider","typeLabel":"string"},"provider_user_id":{"type":"string","description":"The resource ID of the beneficiary of the custodial wallet.","isRequired":true,"uniqueKey":"oneOf.1.wallets.items.[INDEX].custody.provider_user_id","typeLabel":"string"}},"required":["provider","provider_user_id"],"description":"Information about the custodian managing this wallet.","title":"WalletCustodian","x-stainless-model":"wallets.wallet_custodian","uniqueKey":"oneOf.1.wallets.items.[INDEX].custody","typeLabel":"WalletCustodian · object"}},"required":["id","address","created_at","chain_type","policy_ids","owner_id","additional_signers","exported_at","imported_at"],"description":"A wallet managed by Privy's wallet infrastructure.","title":"Wallet","example":{"id":"id2tptkqrxd39qo9j423etij","address":"0xF1DBff66C993EE895C8cb176c30b07A559d76496","display_name":"Treasury","external_id":"my-order-123","chain_type":"ethereum","policy_ids":[],"additional_signers":[],"owner_id":"rkiz0ivz254drv1xw982v3jq","parent_wallet_id":null,"entity":{"id":"jorpjo4rfxj62nx1itt8y1zt","type":"user"},"created_at":1741834854578,"exported_at":null,"imported_at":null,"archived_at":null},"x-stainless-model":"wallets.wallet","uniqueKey":"oneOf.1.wallets.items.[INDEX]","typeLabel":"Wallet · object"},"isRequired":true,"uniqueKey":"oneOf.1.wallets","typeLabel":"Wallet · object[]"}},"uniqueKey":"oneOf.1","typeLabel":"RawWalletAuthenticateResponse · object"}],"uniqueKey":"","typeLabel":"EncryptedWalletAuthenticateResponse · object | RawWalletAuthenticateResponse · object"},"examples":{"Example":{"title":"Example","value":{"encrypted_authorization_key":{"encryption_type":"HPKE","encapsulated_key":"BECqbgIAcs3TpP5GadS6F8mXkSktR2DR8WNtd3e0Qcy7PpoRHEygpzjFWttntS+SEM3VSr4Thewh18ZP9chseLE=","ciphertext":"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgsqM8IKMlpFxVypBUa/Q2QvB1AmS/g5WHPp3SKq9A75uhRANCAATeX6BDghwclKAH8+/7IjvS1tCpvIfZ570IR44acX93pUGz5iEvpkg+HGaalHAXubuoUMq9CUWRm4wo+3090Nus"},"expires_at":1697059200000,"wallets":[{"id":"ubul5xhljqorce73sf82u0p3","address":"0x3DE69Fd93873d40459f27Ce5B74B42536f8d6149","chain_type":"ethereum","policy_ids":[],"additional_signers":[{"signer_id":"p3cyj3n8mt9f9u2htfize511","override_policy_ids":[]}],"created_at":1744300912643,"owner_id":"lzjb3xnjk2ntod3w1hgwa358","parent_wallet_id":null,"entity":null,"exported_at":null,"imported_at":null,"archived_at":null},{"id":"sb4y18l68xze8gfszafmyv3q","address":"9wtGmqMamnKfz49XBwnJASbjcVnnKnT78qKopCL54TAk","chain_type":"solana","policy_ids":[],"additional_signers":[{"signer_id":"p3cyj3n8mt9f9u2htfize511","override_policy_ids":[]}],"created_at":1744300912644,"owner_id":"lzjb3xnjk2ntod3w1hgwa358","parent_wallet_id":null,"entity":null,"exported_at":null,"imported_at":null,"archived_at":null}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f78b41c7-ef45-474d-b8e3-1c6f8cf33385":{"appSecretAuth":{"type":"http","scheme":"basic","description":"Basic Auth header with your app ID as the username and your app secret as the password.","scopes":[],"schemeName":"appSecretAuth"}}},"servers":{"850974b1-506a-4d71-9130-47c1416abc38":{"url":"https://api.privy.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic Auth header with your app ID as the username and your app secret as the password.","scopes":[],"schemeName":"appSecretAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic Auth header with your app ID as the username and your app secret as the password.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"appSecretAuth","name":"Authorization"}],"title":"appSecretAuth"}]},"originalFileLocation":"https://api.staging.privy.io/v1/openapi.json"},"subdomain":"privy-c2af3412","siteName":"Privy Docs","title":"Authenticate - Privy Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-29T21:32:28.385Z","originalFileLocation":"api-reference/wallets/authenticate.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=\"Exchange a user JWT for a session key authorized to act on the user\u0026#x27;s wallets. Returns the encrypted authorization key and the list of wallets it can access.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Privy 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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_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/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authenticate - Privy Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Exchange a user JWT for a session key authorized to act on the user\u0026#x27;s wallets. Returns the encrypted authorization key and the list of wallets it can access.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Privy Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.privy.io/api-reference/wallets/authenticate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://assets.privy.io/docs-og.png\">\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=\"Privy Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Exchange a user JWT for a session key authorized to act on the user\u0026#x27;s wallets. Returns the encrypted authorization key and the list of wallets it can access.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://assets.privy.io/docs-og.png\">\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/privy-c2af3412/bJgmnaRQwH8sO8y5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Privy Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#010110\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.privy.io/api-reference/wallets/authenticate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/wallets/authenticate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.privy.io/#organization\",\"name\":\"Privy\",\"url\":\"https://www.privy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets.privy.io/docs-og.png\"},\"sameAs\":[\"https://x.com/privy_io\",\"https://github.com/privy-io\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.privy.io#website\",\"name\":\"Privy Docs\",\"url\":\"https://docs.privy.io\",\"publisher\":{\"@id\":\"https://www.privy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.privy.io/api-reference/wallets/authenticate#webpage\",\"url\":\"https://docs.privy.io/api-reference/wallets/authenticate\",\"name\":\"Authenticate\",\"description\":\"Exchange a user JWT for a session key authorized to act on the user's wallets. Returns the encrypted authorization key and the list of wallets it can access.\",\"dateModified\":\"2026-05-29T21:32:28.385Z\",\"isPartOf\":{\"@id\":\"https://docs.privy.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.privy.io/api-reference/wallets/authenticate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.privy.io/api-reference/wallets/authenticate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Wallets\",\"item\":\"https://docs.privy.io/api-reference/wallets/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wallets\",\"item\":\"https://docs.privy.io/api-reference/wallets/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Authenticate\",\"item\":\"https://docs.privy.io/api-reference/wallets/authenticate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.privy.io/api-reference/wallets/authenticate#apireference\",\"headline\":\"Authenticate\",\"name\":\"Authenticate\",\"description\":\"Exchange a user JWT for a session key authorized to act on the user's wallets. Returns the encrypted authorization key and the list of wallets it can access.\",\"url\":\"https://docs.privy.io/api-reference/wallets/authenticate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.privy.io/api-reference/wallets/authenticate#webpage\"},\"image\":\"https://assets.privy.io/docs-og.png\",\"dateModified\":\"2026-05-29T21:32:28.385Z\",\"publisher\":{\"@id\":\"https://www.privy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.privy.io#website\"}}]}\u003c/script>","siteName":"Privy Docs","nav":{"global":null,"tabs":[{"tab":"Basics","pages":[{"title":"Basics","href":"/basics/get-started/about"}]},{"tab":"Wallets","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/wallets/overview"}]},{"item":"Embedded wallets","pages":[{"title":"Embedded wallets","href":"/wallets/overview/embedded"}]},{"item":"Organization wallets","pages":[{"title":"Organization wallets","href":"/organizations/overview"}]},{"item":"External wallets","pages":[{"title":"External wallets","href":"/wallets/connectors/overview"}]},{"item":"Signatures and transactions","pages":[{"title":"Signatures and transactions","href":"/wallets/signatures-and-transactions"}]},{"item":"Balances and webhooks","pages":[{"title":"Balances and webhooks","href":"/wallets/gas-and-asset-management/assets/overview"}]},{"item":"Gas and fee management","pages":[{"title":"Gas and fee management","href":"/wallets/gas-and-asset-management/gas/overview"}]}],"pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Financial flows","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/financial-flows/overview"}]},{"item":"Deposits","pages":[{"title":"Deposits","href":"/financial-flows/deposits/overview"}]},{"item":"Payouts","pages":[{"title":"Payouts","href":"/financial-flows/payouts/overview"}]},{"item":"Earn","pages":[{"title":"Earn","href":"/wallets/actions/earn/overview"}]},{"item":"Cards","pages":[{"title":"Cards","href":"/financial-flows/cards/overview"}]},{"item":"Trade","pages":[{"title":"Trade","href":"/wallets/actions/swap/overview"}]},{"item":"Monetization","pages":[{"title":"Monetization","href":"/financial-flows/monetization"}]},{"item":"Treasury management","pages":[{"title":"Treasury management","href":"/treasury-management/overview"}]},{"item":"Private transactions","pages":[{"title":"Private transactions","href":"/financial-flows/private-transactions"}]}],"pages":[{"title":"Financial flows","href":"/financial-flows/overview"}]},{"tab":"Controls and policies","menu":[{"item":"Controls","pages":[{"title":"Controls","href":"/controls/overview"}]},{"item":"Policies","pages":[{"title":"Policies","href":"/controls/policies/overview"}]},{"item":"Manual approvals","pages":[{"title":"Manual approvals","href":"/controls/dashboard/overview"}]}],"pages":[{"title":"Controls and policies","href":"/controls/overview"}]},{"tab":"Identity","menu":[{"item":"Authentication","pages":[{"title":"Authentication","href":"/authentication/overview"}]},{"item":"Users","pages":[{"title":"Users","href":"/user-management/users/overview"}]},{"item":"KYC and KYB","pages":[{"title":"KYC and KYB","href":"/kyc-kyb/overview"}]}],"pages":[{"title":"Identity","href":"/authentication/overview"}]},{"tab":"Security","pages":[{"title":"Security","href":"/security/overview"}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"API reference","groups":[{"group":"Basics","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authorization signatures","href":"/api-reference/authorization-signatures"},{"title":"Idempotency keys","href":"/api-reference/idempotency-keys"},{"title":"Request expiry","href":"/api-reference/request-expiry"},{"title":"Webhooks overview","sidebarTitle":"Webhooks","href":"/api-reference/webhooks/overview"},{"title":"Privy labs APIs","sidebarTitle":"Privy labs","href":"/api-reference/labs/overview"}]},{"group":"Wallets","pages":[{"group":"Wallets","pages":[{"title":"Create wallet","openapi":"post /v1/wallets","href":"/api-reference/wallets/create"},{"title":"Create wallets in batch","openapi":"post /v1/wallets/batch","href":"/api-reference/wallets/batch-create"},{"title":"Create custodial wallets","openapi":"post /v1/custodial_wallets","href":"/api-reference/wallets/custodial-wallets"},{"title":"Get wallet","openapi":"get /v1/wallets/{wallet_id}","href":"/api-reference/wallets/get"},{"title":"Get wallets","openapi":"get /v1/wallets","href":"/api-reference/wallets/get-all"},{"title":"Get wallet by address","openapi":"post /v1/wallets/address","href":"/api-reference/wallets/get-by-address"},{"title":"Update wallet","openapi":"patch /v1/wallets/{wallet_id}","href":"/api-reference/wallets/update"},{"title":"Assign wallet entity","openapi":"post /v1/wallets/{wallet_id}/entity","href":"/api-reference/wallets/entity"},{"title":"Archive wallet","openapi":"post /v1/wallets/{wallet_id}/archive","href":"/api-reference/wallets/archive"},{"title":"Get balance","openapi":"get /v1/wallets/{wallet_id}/balance","href":"/api-reference/wallets/get-balance"},{"title":"Get transactions","openapi":"get /v1/wallets/{wallet_id}/transactions","href":"/api-reference/wallets/get-transactions"},{"title":"Export wallet","openapi":"post /v1/wallets/{wallet_id}/export","href":"/api-reference/wallets/export"},{"group":"Import wallet","pages":[{"title":"Initialize import","openapi":"post /v1/wallets/import/init","href":"/api-reference/wallets/import/init"},{"title":"Submit import","openapi":"post /v1/wallets/import/submit","description":"Submit a wallet import request.","href":"/api-reference/wallets/import/submit"}]},{"title":"Authenticate","openapi":"post /v1/wallets/authenticate","href":"/api-reference/wallets/authenticate"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet.archived","title":"Wallet archived","description":"Fired when a wallet is archived.","href":"/api-reference/webhooks/wallet/archived"},{"openapi":"webhook wallet.restored","title":"Wallet restored","href":"/api-reference/webhooks/wallet/restored"},{"openapi":"webhook wallet.funds_deposited","title":"Funds deposited","href":"/api-reference/webhooks/wallet/funds_deposited"},{"openapi":"webhook wallet.funds_withdrawn","title":"Funds withdrawn","href":"/api-reference/webhooks/wallet/funds_withdrawn"},{"openapi":"webhook wallet.private_key_export","title":"Private key export","href":"/api-reference/webhooks/wallet/private_key_export"},{"openapi":"webhook wallet.recovered","title":"Wallet recovered","href":"/api-reference/webhooks/wallet/recovered"},{"openapi":"webhook wallet.recovery_setup","title":"Wallet recovery setup","href":"/api-reference/webhooks/wallet/recovery_setup"}]}]},{"group":"Signatures and transactions","pages":[{"group":"Ethereum","pages":[{"title":"eth_sendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-send-transaction"},{"title":"wallet_sendCalls","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/wallet-send-calls"},{"title":"personal_sign","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/personal-sign"},{"title":"eth_signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-transaction"},{"title":"eth_signTypedData_v4","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-signtypeddata-v4"},{"title":"eth_signUserOperation","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-user-operation"},{"title":"eth_sign7702Authorization","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/eth-sign-7702-authorization"},{"title":"secp256k1_sign","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/ethereum/secp256k1-sign"}]},{"group":"Solana","pages":[{"title":"signMessage","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-message"},{"title":"signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-transaction"},{"title":"signAndSendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/solana/sign-and-send-transaction"}]},{"group":"Tempo","pages":[{"title":"eth_sendTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/tempo/eth-send-transaction"},{"title":"eth_signTransaction","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/tempo/eth-sign-transaction"}]},{"group":"Tron","pages":[{"title":"tron_sendTransaction","href":"/api-reference/wallets/tron/tron-send-transaction"},{"title":"tron_signTransaction","href":"/api-reference/wallets/tron/tron-sign-transaction"}]},{"group":"Spark BTC","pages":[{"title":"getBalance","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-balance"},{"title":"transfer","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/transfer"},{"title":"transferTokens","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/transfer-tokens"},{"title":"getStaticDepositAddress","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-static-deposit-address"},{"title":"claimStaticDeposit","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/claim-static-deposit"},{"title":"getClaimStaticDepositQuote","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-static-deposit-quote"},{"title":"createLightningInvoice","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/create-lightning-invoice"},{"title":"payLightningInvoice","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/pay-lightning-invoice"},{"title":"signMessageWithIdentityKey","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/sign-message-with-identity-key"},{"title":"getWithdrawalFeeQuote","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/get-withdrawal-fee-quote"},{"title":"withdraw","api":"post /v1/wallets/{wallet_id}/rpc","href":"/api-reference/wallets/spark/withdraw"}]},{"group":"Other chains","pages":[{"title":"Raw sign","openapi":"post /v1/wallets/{wallet_id}/raw_sign","href":"/api-reference/wallets/raw-sign"}]},{"group":"Transactions","pages":[{"title":"Get transaction","openapi":"get /v1/transactions/{transaction_id}","href":"/api-reference/transactions/get"},{"title":"Get transaction by external ID","openapi":"get /v1/transactions","href":"/api-reference/transactions/external-id"},{"title":"Get gas spend","openapi":"get /v1/apps/gas_spend","href":"/api-reference/transactions/gas-spend"},{"group":"Webhooks","pages":[{"openapi":"webhook transaction.broadcasted","title":"Transaction broadcasted","href":"/api-reference/webhooks/transaction/broadcasted"},{"openapi":"webhook transaction.confirmed","title":"Transaction confirmed","href":"/api-reference/webhooks/transaction/confirmed"},{"openapi":"webhook transaction.execution_reverted","title":"Transaction execution reverted","href":"/api-reference/webhooks/transaction/execution_reverted"},{"openapi":"webhook transaction.failed","title":"Transaction failed","href":"/api-reference/webhooks/transaction/failed"},{"openapi":"webhook transaction.provider_error","title":"Transaction provider error","href":"/api-reference/webhooks/transaction/provider_error"},{"openapi":"webhook transaction.replaced","title":"Transaction replaced","href":"/api-reference/webhooks/transaction/replaced"},{"openapi":"webhook transaction.still_pending","title":"Transaction still pending","href":"/api-reference/webhooks/transaction/still_pending"},{"openapi":"webhook user_operation.completed","title":"User operation completed","href":"/api-reference/webhooks/user-operation/completed"}]}]}]},{"group":"Deposits","pages":[{"group":"Fiat","pages":[{"title":"Create fiat deposit account","openapi":"post /v1/wallets/{wallet_id}/deposit_accounts/fiat","href":"/api-reference/fiat/deposit-accounts/create"},{"title":"List fiat deposit accounts","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/fiat","href":"/api-reference/fiat/deposit-accounts/list"},{"title":"Get fiat deposit account","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/fiat/{deposit_account_id}","href":"/api-reference/fiat/deposit-accounts/get"},{"title":"Update fiat deposit account","openapi":"patch /v1/wallets/{wallet_id}/deposit_accounts/fiat/{deposit_account_id}","href":"/api-reference/fiat/deposit-accounts/update"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet.deposit_account.deposit_started","title":"Deposit started","href":"/api-reference/webhooks/deposit-account/deposit_started"},{"openapi":"webhook wallet.deposit_account.deposit_completed","title":"Deposit completed","href":"/api-reference/webhooks/deposit-account/deposit_completed"},{"openapi":"webhook wallet.deposit_account.deposit_failed","title":"Deposit failed","href":"/api-reference/webhooks/deposit-account/deposit_failed"}]}]},{"group":"Crypto","pages":[{"title":"Create crypto deposit account","openapi":"post /v1/wallets/{wallet_id}/deposit_accounts/crypto","href":"/api-reference/crypto-deposits/create"},{"title":"Quote crypto deposit account","openapi":"post /v1/deposit_accounts/crypto/quote","href":"/api-reference/crypto-deposits/quote"},{"title":"Get crypto deposit account order","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/crypto/orders/{order_id}","href":"/api-reference/crypto-deposits/get-order"},{"title":"Get next crypto deposit account order","openapi":"get /v1/wallets/{wallet_id}/deposit_accounts/crypto/next_order","href":"/api-reference/crypto-deposits/get-next-order"}]}]},{"group":"Payouts","pages":[{"group":"Fiat","pages":[{"title":"Create a payout","openapi":"post /v1/wallets/{wallet_id}/payout/fiat","href":"/api-reference/wallets/payout/create"},{"group":"External fiat accounts","pages":[{"group":"For users","pages":[{"title":"Create external fiat account","openapi":"post /v1/users/{user_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/create"},{"title":"List external fiat accounts","openapi":"get /v1/users/{user_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/list"},{"title":"Get external fiat account","openapi":"get /v1/users/{user_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/get"},{"title":"Delete external fiat account","openapi":"delete /v1/users/{user_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/delete"}]},{"group":"For organizations","pages":[{"title":"Create external fiat account","openapi":"post /v1/organizations/{organization_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/organizations/create"},{"title":"List external fiat accounts","openapi":"get /v1/organizations/{organization_id}/external_fiat_accounts","href":"/api-reference/fiat/external-fiat-accounts/organizations/list"},{"title":"Get external fiat account","openapi":"get /v1/organizations/{organization_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/organizations/get"},{"title":"Delete external fiat account","openapi":"delete /v1/organizations/{organization_id}/external_fiat_accounts/{account_id}","href":"/api-reference/fiat/external-fiat-accounts/organizations/delete"}]}]},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_action.payout.created","title":"Payout created","href":"/api-reference/webhooks/wallet-action/payout/created"},{"openapi":"webhook wallet_action.payout.succeeded","title":"Payout succeeded","href":"/api-reference/webhooks/wallet-action/payout/succeeded"},{"openapi":"webhook wallet_action.payout.failed","title":"Payout failed","href":"/api-reference/webhooks/wallet-action/payout/failed"},{"openapi":"webhook wallet_action.payout.rejected","title":"Payout rejected","href":"/api-reference/webhooks/wallet-action/payout/rejected"}]}]},{"group":"Crypto","pages":[{"title":"Transfer","openapi":"post /v1/wallets/{wallet_id}/transfer","href":"/api-reference/wallets/transfer/index"},{"title":"Quote transfer fees","openapi":"post /v1/wallets/{wallet_id}/transfer/quote","href":"/api-reference/wallets/transfer/quote"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_action.transfer.created","title":"Transfer created","href":"/api-reference/webhooks/wallet-action/transfer/created"},{"openapi":"webhook wallet_action.transfer.succeeded","title":"Transfer succeeded","href":"/api-reference/webhooks/wallet-action/transfer/succeeded"},{"openapi":"webhook wallet_action.transfer.failed","title":"Transfer failed","href":"/api-reference/webhooks/wallet-action/transfer/failed"},{"openapi":"webhook wallet_action.transfer.rejected","title":"Transfer rejected","href":"/api-reference/webhooks/wallet-action/transfer/rejected"}]}]}]},{"group":"Swaps","pages":[{"title":"Get swap quote","openapi":"post /v1/wallets/{wallet_id}/swap/quote","href":"/api-reference/wallets/swap/quote"},{"title":"Swap tokens","openapi":"post /v1/wallets/{wallet_id}/swap","href":"/api-reference/wallets/swap/tokens"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_action.swap.created","title":"Swap created","href":"/api-reference/webhooks/wallet-action/swap/created"},{"openapi":"webhook wallet_action.swap.succeeded","title":"Swap succeeded","href":"/api-reference/webhooks/wallet-action/swap/succeeded"},{"openapi":"webhook wallet_action.swap.failed","title":"Swap failed","href":"/api-reference/webhooks/wallet-action/swap/failed"},{"openapi":"webhook wallet_action.swap.rejected","title":"Swap rejected","href":"/api-reference/webhooks/wallet-action/swap/rejected"}]}]},{"group":"Earn","pages":[{"title":"Deposit into vault","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/deposit","href":"/api-reference/wallets/earn/deposit"},{"title":"Withdraw from vault","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/withdraw","href":"/api-reference/wallets/earn/withdraw"},{"title":"Claim reward incentives","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/incentive/claim","href":"/api-reference/wallets/earn/incentive-claim"},{"title":"Get incentive rewards","openapi":"get /v1/wallets/{wallet_id}/earn/ethereum/incentive/claim","href":"/api-reference/wallets/earn/get-incentive-rewards"},{"title":"Get Ethereum vault details","openapi":"get /v1/earn/ethereum/vaults/{vault_id}","href":"/api-reference/wallets/earn/get-vault-details"},{"title":"Get Ethereum vault position","openapi":"get /v1/wallets/{wallet_id}/earn/ethereum/vaults","href":"/api-reference/wallets/earn/get-position"},{"title":"Earn fee collect","openapi":"post /v1/wallets/{wallet_id}/earn/ethereum/fees/collect","href":"/api-reference/wallets/earn/fees-collect"},{"group":"Webhooks","pages":[{"group":"Earn deposits","pages":[{"openapi":"webhook wallet_action.earn_deposit.created","title":"Earn deposit created","href":"/api-reference/webhooks/wallet-action/earn-deposit/created"},{"title":"Earn deposit succeeded","openapi":"webhook wallet_action.earn_deposit.succeeded","href":"/api-reference/webhooks/wallet-action/earn-deposit/succeeded"},{"title":"Earn deposit failed","openapi":"webhook wallet_action.earn_deposit.failed","href":"/api-reference/webhooks/wallet-action/earn-deposit/failed"},{"title":"Earn deposit rejected","openapi":"webhook wallet_action.earn_deposit.rejected","href":"/api-reference/webhooks/wallet-action/earn-deposit/rejected"}]},{"group":"Earn withdrawals","pages":[{"title":"Earn withdraw created","openapi":"webhook wallet_action.earn_withdraw.created","href":"/api-reference/webhooks/wallet-action/earn-withdraw/created"},{"title":"Earn withdraw succeeded","openapi":"webhook wallet_action.earn_withdraw.succeeded","href":"/api-reference/webhooks/wallet-action/earn-withdraw/succeeded"},{"title":"Earn withdraw failed","openapi":"webhook wallet_action.earn_withdraw.failed","href":"/api-reference/webhooks/wallet-action/earn-withdraw/failed"},{"title":"Earn withdraw rejected","openapi":"webhook wallet_action.earn_withdraw.rejected","href":"/api-reference/webhooks/wallet-action/earn-withdraw/rejected"}]},{"group":"Earn incentive claims","pages":[{"title":"Earn reward incentive claim created","openapi":"webhook wallet_action.earn_incentive_claim.created","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/created"},{"title":"Earn reward incentive claim succeeded","openapi":"webhook wallet_action.earn_incentive_claim.succeeded","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/succeeded"},{"title":"Earn reward incentive claim failed","openapi":"webhook wallet_action.earn_incentive_claim.failed","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/failed"},{"title":"Earn reward incentive claim rejected","openapi":"webhook wallet_action.earn_incentive_claim.rejected","href":"/api-reference/webhooks/wallet-action/earn-incentive-claim/rejected"}]},{"group":"Earn fee collections","pages":[{"title":"Earn fee collect created","openapi":"webhook wallet_action.earn_fee_collect.created","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/created"},{"title":"Earn fee collect succeeded","openapi":"webhook wallet_action.earn_fee_collect.succeeded","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/succeeded"},{"title":"Earn fee collect failed","openapi":"webhook wallet_action.earn_fee_collect.failed","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/failed"},{"title":"Earn fee collect rejected","openapi":"webhook wallet_action.earn_fee_collect.rejected","href":"/api-reference/webhooks/wallet-action/earn-fee-collect/rejected"}]}]}]},{"group":"Wallet actions","pages":[{"title":"Get wallet action","openapi":"get /v1/wallets/{wallet_id}/actions/{action_id}","href":"/api-reference/wallets/actions/get"},{"title":"Get wallet action by external ID","openapi":"get /v1/actions","href":"/api-reference/wallets/actions/external-id"},{"title":"List all wallet actions","openapi":"get /v1/wallets/{wallet_id}/actions","href":"/api-reference/wallets/actions/list"}]}]},{"group":"Controls","pages":[{"group":"Key quorums","pages":[{"title":"Create key quorum","openapi":"post /v1/key_quorums","href":"/api-reference/key-quorums/create"},{"title":"Get key quorums","openapi":"get /v1/key_quorums","href":"/api-reference/key-quorums/get-all"},{"title":"Get key quorum","openapi":"get /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/get"},{"title":"Update key quorum","openapi":"patch /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/update"},{"title":"Delete key quorum","openapi":"delete /v1/key_quorums/{key_quorum_id}","href":"/api-reference/key-quorums/delete"}]},{"group":"Policies","pages":[{"title":"Create policy","openapi":"post /v1/policies","href":"/api-reference/policies/create"},{"title":"Get policies","openapi":"get /v1/policies","href":"/api-reference/policies/get-all"},{"title":"Get policy","openapi":"get /v1/policies/{policy_id}","href":"/api-reference/policies/get"},{"title":"Update policy","openapi":"patch /v1/policies/{policy_id}","href":"/api-reference/policies/update"},{"title":"Delete policy","openapi":"delete /v1/policies/{policy_id}","href":"/api-reference/policies/delete"},{"group":"Rules","pages":[{"title":"Add a rule to a policy","openapi":"post /v1/policies/{policy_id}/rules","href":"/api-reference/policies/rules/create"},{"title":"Get a rule from a policy","openapi":"get /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/get"},{"title":"Update a rule in a policy","openapi":"patch /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/update"},{"title":"Delete a rule from a policy","openapi":"delete /v1/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/policies/rules/delete"}]}]},{"group":"Condition sets","pages":[{"title":"Create condition set","openapi":"post /v1/condition_sets","href":"/api-reference/condition-sets/create"},{"title":"Get condition sets","openapi":"get /v1/condition_sets","href":"/api-reference/condition-sets/get-all"},{"title":"Get condition set","openapi":"get /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/get"},{"title":"Update condition set","openapi":"patch /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/update"},{"title":"Delete condition set","openapi":"delete /v1/condition_sets/{condition_set_id}","href":"/api-reference/condition-sets/delete"},{"group":"Condition set items","pages":[{"title":"Add items to a condition set","openapi":"post /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/create"},{"title":"Get an item from a condition set","openapi":"get /v1/condition_sets/{condition_set_id}/condition_set_items/{condition_set_item_id}","href":"/api-reference/condition-sets/condition-set-items/get"},{"title":"Get all items from a condition set","openapi":"get /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/get-all"},{"title":"Update items in a condition set","openapi":"put /v1/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/condition-sets/condition-set-items/update"},{"title":"Delete an item from a condition set","openapi":"delete /v1/condition_sets/{condition_set_id}/condition_set_items/{condition_set_item_id}","href":"/api-reference/condition-sets/condition-set-items/delete"}]}]},{"group":"Aggregations","pages":[{"title":"Create aggregation","openapi":"post /v1/aggregations","href":"/api-reference/aggregations/create"},{"title":"Get aggregation","openapi":"get /v1/aggregations/{aggregation_id}","href":"/api-reference/aggregations/get"},{"title":"Delete aggregation","openapi":"delete /v1/aggregations/{aggregation_id}","href":"/api-reference/aggregations/delete"}]},{"group":"Wallet automations","pages":[{"title":"Create wallet automation","openapi":"post /v1/wallet_automations","href":"/api-reference/wallet-automations/create"},{"title":"List wallet automations","openapi":"get /v1/wallet_automations","href":"/api-reference/wallet-automations/list"},{"title":"Get wallet automation","openapi":"get /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/get"},{"title":"Update wallet automation","openapi":"patch /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/update"},{"title":"Delete wallet automation","openapi":"delete /v1/wallet_automations/{automation_id}","href":"/api-reference/wallet-automations/delete"},{"group":"Wallet attachments","pages":[{"title":"Attach wallet automations","openapi":"post /v1/wallets/{wallet_id}/automations/attach","href":"/api-reference/wallet-automations/attach"},{"title":"Detach wallet automations","openapi":"post /v1/wallets/{wallet_id}/automations/detach","href":"/api-reference/wallet-automations/detach"}]},{"title":"List wallet automation executions","openapi":"get /v1/wallet_automations/executions","href":"/api-reference/wallet-automations/list-executions"},{"title":"Reindex wallet automations","openapi":"post /v1/wallet_automations/reindex","href":"/api-reference/wallet-automations/reindex"},{"group":"Webhooks","pages":[{"openapi":"webhook wallet_automation.submitted","title":"Wallet automation submitted","href":"/api-reference/webhooks/wallet-automation/submitted"}]}]}]},{"group":"Identity","pages":[{"group":"Users","pages":[{"title":"Create user","openapi":"post /v1/users","playground":"interactive","href":"/api-reference/users/create"},{"group":"Get user","pages":[{"title":"Get user by ID","openapi":"get /v1/users/{user_id}","href":"/api-reference/users/get"},{"group":"Linked accounts","pages":[{"title":"Get user by wallet address","openapi":"post /v1/users/wallet/address","href":"/api-reference/users/get-by-wallet-address"},{"title":"Get user by smart wallet address","openapi":"post /v1/users/smart_wallet/address","href":"/api-reference/users/get-by-smart-wallet-address"},{"title":"Get user by custom auth ID","openapi":"post /v1/users/custom_auth/id","href":"/api-reference/users/get-by-custom-auth"},{"title":"Get user by email address","openapi":"post /v1/users/email/address","href":"/api-reference/users/get-by-email-address"},{"title":"Get user by phone number","openapi":"post /v1/users/phone/number","href":"/api-reference/users/get-by-phone-number"},{"title":"Get user by Discord username","openapi":"post /v1/users/discord/username","href":"/api-reference/users/get-by-discord-username"},{"title":"Get user by GitHub username","openapi":"post /v1/users/github/username","href":"/api-reference/users/get-by-github-username"},{"title":"Get user by Instagram username","openapi":"post /v1/users/instagram/username","href":"/api-reference/users/get-by-instagram-username"},{"title":"Get user by Twitter username","openapi":"post /v1/users/twitter/username","href":"/api-reference/users/get-by-twitter-username"},{"title":"Get user by Twitter subject","openapi":"post /v1/users/twitter/subject","href":"/api-reference/users/get-by-twitter-subject"},{"title":"Get user by Telegram username","openapi":"post /v1/users/telegram/username","href":"/api-reference/users/get-by-telegram-username"},{"title":"Get user by Telegram user ID","openapi":"post /v1/users/telegram/telegram_user_id","href":"/api-reference/users/get-by-telegram-user-id"},{"title":"Get user by Farcaster ID","openapi":"post /v1/users/farcaster/fid","href":"/api-reference/users/get-by-farcaster-id"},{"title":"Get user by Spotify subject","openapi":"post /v1/users/spotify/subject","href":"/api-reference/users/get-by-spotify-subject"},{"title":"Get user by Twitch username","openapi":"post /v1/users/twitch/username","href":"/api-reference/users/get-by-twitch-username"}]}]},{"title":"Get users","openapi":"get /v1/users","playground":"interactive","href":"/api-reference/users/get-all"},{"title":"Search users","openapi":"post /v1/users/search","href":"/api-reference/users/search"},{"title":"Refresh Twitter account","api":"post /v1/users/twitter/refresh","href":"/api-reference/users/refresh-twitter-account"},{"title":"Delete user","openapi":"delete /v1/users/{user_id}","href":"/api-reference/users/delete"},{"title":"Freeze user","openapi":"post /v1/users/{user_id}/freeze","href":"/api-reference/users/freeze"},{"title":"Unfreeze user","openapi":"delete /v1/users/{user_id}/freeze","href":"/api-reference/users/unfreeze"},{"title":"Add custom metadata","openapi":"post /v1/users/{user_id}/custom_metadata","href":"/api-reference/users/custom-metadata/create"},{"title":"Update custom metadata","openapi":"patch /v1/users/{user_id}/custom_metadata","href":"/api-reference/users/custom-metadata/update"},{"title":"Pregenerate wallets","openapi":"post /v1/users/{user_id}/wallets","href":"/api-reference/users/pregenerate-wallets"},{"group":"MFA","pages":[{"group":"SMS","pages":[{"title":"Start SMS MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/sms/enrollment/init","href":"/api-reference/users/mfa/sms/enrollment/init"},{"title":"Complete SMS MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/sms/enrollment/verify","href":"/api-reference/users/mfa/sms/enrollment/verify"},{"title":"Start SMS MFA verification","openapi":"post /v1/users/{user_id}/mfa/sms/verification/init","href":"/api-reference/users/mfa/sms/verification/init"},{"title":"Complete SMS MFA verification","openapi":"post /v1/users/{user_id}/mfa/sms/verification/verify","href":"/api-reference/users/mfa/sms/verification/verify"}]},{"group":"TOTP","pages":[{"title":"Start TOTP MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/totp/enrollment/init","href":"/api-reference/users/mfa/totp/enrollment/init"},{"title":"Complete TOTP MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/totp/enrollment/verify","href":"/api-reference/users/mfa/totp/enrollment/verify"},{"title":"Complete TOTP MFA verification","openapi":"post /v1/users/{user_id}/mfa/totp/verification/verify","href":"/api-reference/users/mfa/totp/verification/verify"}]},{"group":"Passkey","pages":[{"title":"Start passkey MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/passkey/enrollment/init","href":"/api-reference/users/mfa/passkey/enrollment/init"},{"title":"Complete passkey MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/passkey/enrollment/verify","href":"/api-reference/users/mfa/passkey/enrollment/verify"},{"title":"Start passkey MFA verification","openapi":"post /v1/users/{user_id}/mfa/passkey/verification/init","href":"/api-reference/users/mfa/passkey/verification/init"},{"title":"Complete passkey MFA verification","openapi":"post /v1/users/{user_id}/mfa/passkey/verification/verify","href":"/api-reference/users/mfa/passkey/verification/verify"}]},{"group":"Email","pages":[{"title":"Start email MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/email/enrollment/init","href":"/api-reference/users/mfa/email/enrollment/init"},{"title":"Complete email MFA enrollment","openapi":"post /v1/users/{user_id}/mfa/email/enrollment/verify","href":"/api-reference/users/mfa/email/enrollment/verify"},{"title":"Start email MFA verification","openapi":"post /v1/users/{user_id}/mfa/email/verification/init","href":"/api-reference/users/mfa/email/verification/init"},{"title":"Complete email MFA verification","openapi":"post /v1/users/{user_id}/mfa/email/verification/verify","href":"/api-reference/users/mfa/email/verification/verify"}]}]},{"group":"Allowlist","pages":[{"title":"List allowlist entries","openapi":"get /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/list-allowlist"},{"title":"Add to allowlist","openapi":"post /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/add-to-allowlist"},{"title":"Remove from allowlist","openapi":"delete /v1/apps/{app_id}/allowlist","href":"/api-reference/apps/remove-from-allowlist"}]},{"group":"Webhooks","pages":[{"openapi":"webhook user.authenticated","title":"User authenticated","href":"/api-reference/webhooks/user/authenticated"},{"openapi":"webhook user.created","title":"User created","href":"/api-reference/webhooks/user/created"},{"openapi":"webhook user.deleted","title":"User deleted","href":"/api-reference/webhooks/user/deleted"},{"openapi":"webhook user.linked_account","title":"User linked account","href":"/api-reference/webhooks/user/linked_account"},{"openapi":"webhook user.transferred_account","title":"User transferred account","href":"/api-reference/webhooks/user/transferred_account"},{"openapi":"webhook user.unlinked_account","title":"User unlinked account","href":"/api-reference/webhooks/user/unlinked_account"},{"openapi":"webhook user.updated_account","title":"User updated account","href":"/api-reference/webhooks/user/updated_account"},{"openapi":"webhook user.wallet_created","title":"User wallet created","href":"/api-reference/webhooks/user/wallet_created"},{"openapi":"webhook mfa.disabled","title":"MFA disabled","href":"/api-reference/webhooks/mfa/disabled"},{"openapi":"webhook mfa.enabled","title":"MFA enabled","href":"/api-reference/webhooks/mfa/enabled"}]},{"group":"KYC","pages":[{"title":"Get KYC status","openapi":"get /v1/users/{user_id}/kyc","href":"/api-reference/fiat/kyc-server/get"},{"title":"Initiate KYC terms of service","openapi":"post /v1/users/{user_id}/kyc/tos","href":"/api-reference/fiat/kyc-server/tos"},{"title":"Initiate KYC verification","openapi":"post /v1/users/{user_id}/kyc/links","href":"/api-reference/fiat/kyc-server/links"},{"title":"Submit KYC data","openapi":"post /v1/users/{user_id}/kyc/submit","href":"/api-reference/fiat/kyc-server/submit"},{"openapi":"webhook user.kyc.updated","title":"User KYC updated","href":"/api-reference/webhooks/user/kyc_updated"}]}]},{"group":"Organizations","pages":[{"title":"Create organization","openapi":"post /v1/organizations","href":"/api-reference/organizations/create"},{"title":"List organizations","openapi":"get /v1/organizations","href":"/api-reference/organizations/get-all"},{"title":"Get organization","openapi":"get /v1/organizations/{organization_id}","href":"/api-reference/organizations/get"},{"title":"Update organization","openapi":"patch /v1/organizations/{organization_id}","href":"/api-reference/organizations/update"},{"title":"Delete organization","openapi":"delete /v1/organizations/{organization_id}","href":"/api-reference/organizations/delete"},{"group":"KYB","pages":[{"title":"Get KYB status","openapi":"get /v1/organizations/{organization_id}/kyb","href":"/api-reference/fiat/kyb/get"},{"title":"Initiate KYB terms of service","openapi":"post /v1/organizations/{organization_id}/kyb/tos","href":"/api-reference/fiat/kyb/tos"},{"title":"Initiate KYB verification","openapi":"post /v1/organizations/{organization_id}/kyb/links","href":"/api-reference/fiat/kyb/links"},{"title":"Submit KYB data","openapi":"post /v1/organizations/{organization_id}/kyb/submit","href":"/api-reference/fiat/kyb/submit"},{"openapi":"webhook organization.kyb.updated","title":"Organization KYB updated","href":"/api-reference/webhooks/organization/kyb_updated"}]}]}]},{"group":"Intents","pages":[{"group":"Usage","pages":[{"title":"Get intent","openapi":"get /v1/intents/{intent_id}","href":"/api-reference/intents/get"},{"title":"List intents","openapi":"get /v1/intents","href":"/api-reference/intents/list"},{"title":"Create RPC transaction","openapi":"post /v1/intents/wallets/{wallet_id}/rpc","href":"/api-reference/intents/rpc"},{"title":"Create transfer action","openapi":"post /v1/intents/wallets/{wallet_id}/transfer","href":"/api-reference/intents/transfer"},{"title":"Authorize intent","openapi":"post /v1/intents/{intent_id}/authorize","href":"/api-reference/intents/authorize"},{"title":"Reject intent","openapi":"post /v1/intents/{intent_id}/reject","href":"/api-reference/intents/reject"}]},{"group":"Resource update intents","pages":[{"title":"Update wallet","openapi":"patch /v1/intents/wallets/{wallet_id}","href":"/api-reference/intents/update-wallet"},{"title":"Update key quorum","openapi":"patch /v1/intents/key_quorums/{key_quorum_id}","href":"/api-reference/intents/update-key-quorum"},{"title":"Update policy","openapi":"patch /v1/intents/policies/{policy_id}","href":"/api-reference/intents/update-policy"},{"title":"Create rule","openapi":"post /v1/intents/policies/{policy_id}/rules","href":"/api-reference/intents/create-rule"},{"title":"Update policy rule","openapi":"patch /v1/intents/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/intents/update-rule"},{"title":"Delete rule","openapi":"delete /v1/intents/policies/{policy_id}/rules/{rule_id}","href":"/api-reference/intents/delete-rule"},{"title":"Add items to a condition set","openapi":"post /v1/intents/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/intents/add-condition-set-items"},{"title":"Replace items in a condition set","openapi":"put /v1/intents/condition_sets/{condition_set_id}/condition_set_items","href":"/api-reference/intents/replace-condition-set-items"}]},{"group":"Webhooks","pages":[{"openapi":"webhook intent.created","title":"Intent created","href":"/api-reference/webhooks/intents/created"},{"openapi":"webhook intent.authorized","title":"Intent authorized","href":"/api-reference/webhooks/intents/authorized"},{"openapi":"webhook intent.rejected","title":"Intent rejected","href":"/api-reference/webhooks/intents/rejected"},{"openapi":"webhook intent.executed","title":"Intent executed","href":"/api-reference/webhooks/intents/executed"},{"openapi":"webhook intent.failed","title":"Intent failed","href":"/api-reference/webhooks/intents/failed"}]}]},{"group":"Credit usage","pages":[{"group":"Webhooks","pages":[{"openapi":"webhook usage.gas_sponsorship.recorded","title":"Gas sponsorship charge recorded","href":"/api-reference/webhooks/usage/gas_sponsorship_recorded"},{"openapi":"webhook usage.swap_provider_fee.recorded","title":"Swap provider fee charge recorded","href":"/api-reference/webhooks/usage/swap_provider_fee_recorded"}]}]},{"group":"Labs","pages":[{"group":"Swaps","pages":[{"title":"Advanced swap (Solana)","openapi":"post /v1/wallets/{wallet_id}/experimental/solana/advanced-swap","href":"/api-reference/labs/advanced-swap"}]}]}]}]},"basePath":"","title":"Authenticate - Privy Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}