> ## Documentation Index > Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt > Use this file to discover all available pages before exploring further. # Build a vault deposit signing payload > Builds an unsigned deposit signing payload for the given vault and wallet address. When the payload includes an approval step, the SDK signs and sends it before the main transaction. ## OpenAPI ````yaml https://app.dynamic.xyz/api-docs/public-api.yaml post /sdk/{environmentId}/yield/vaults/{vaultId}/deposit openapi: 3.0.1 info: title: Dashboard API description: Dashboard API documentation version: 1.0.0 servers: - url: https://app.dynamicauth.com/api/v0 - url: https://app.dynamic.xyz/api/v0 - url: http://localhost:3333/api/v0 security: [] tags: - name: Analytics description: Query usage analytics and event counts for your environment. - name: SDK description: SDK-facing endpoints consumed by embedded Dynamic clients. - name: Server description: Server-side SDK endpoints authenticated by environment API tokens. - name: Organizations description: >- Manage organizations — the top-level container for all environments and projects. - name: Projects description: Manage projects that group related environments under an organization. - name: Environments description: >- Manage environments (live and sandbox) where your authentication configuration lives. - name: Users description: List, search, and manage authenticated users within an environment. - name: Invites description: >- Manage invitation links that grant specific external users access to your environment. - name: Tokens description: >- Create and manage API tokens used to authenticate requests to the Dynamic API. - name: Origins description: >- Configure allowed origins (CORS) for SDK and API access to your environment. - name: Allowlists description: >- Manage allowlists to control which wallet addresses or email addresses can access your environment. - name: Wallets description: View and manage wallets linked to users in your environment. - name: Members description: Manage team members and their roles within an organization. - name: Sessions description: View and revoke active user sessions within an environment. - name: Settings description: Read and update environment-level configuration settings. - name: Exchanges description: >- Configure exchange integrations (Coinbase, Binance, etc.) for fiat on-ramp within your environment. - name: Providers description: >- List, enable, disable, and configure authentication providers (OAuth, email, wallet, SMS, etc.) for your environment. - name: Captcha description: >- Configure captcha verification (provider, site key, secret key) for your environment. - name: Gates description: >- Define access gates that restrict environment entry to users who meet specific criteria. - name: Chains description: >- Manage the blockchain networks available for wallet connection in your environment. - name: Exports description: Export user and wallet data from your environment as downloadable files. - name: Events description: Browse the event log of actions performed within your environment. - name: Webhooks description: >- Create and manage webhooks to receive real-time events (user.created, wallet.linked, etc.) at your endpoint. - name: Custom Fields description: >- Define and manage custom metadata fields collected from users at sign-up or login. - name: MfaSettings description: >- Configure multi-factor authentication (MFA) policies for your organization. - name: Mfa description: Manage MFA enrollment and verification for individual users. - name: CustomHostnames description: >- Configure custom hostnames for white-labeling the Dynamic authentication experience. - name: TestAccount description: >- Manage test accounts used for automated testing and QA within an environment. - name: NameServices description: >- Configure name service integrations (ENS, Unstoppable Domains, etc.) for human-readable wallet addresses. - name: GlobalWallets description: >- Manage global wallets shared across multiple environments in an organization. - name: GlobalWalletConnections description: Configure which environments can access and use global wallets. - name: GlobalWalletAccessControl description: Control which users and roles can access and operate global wallets. - name: UserApiTokens description: >- Create and manage user-scoped API tokens for programmatic access on behalf of a user. - name: Waas description: Wallet-as-a-Service endpoints for creating and managing embedded wallets. - name: WalletConnect description: Configure WalletConnect integration settings for your environment. - name: Checkout description: >- Accept crypto payments and deposits from any wallet. Settle in any token you choose. - name: Flow description: >- Accept crypto payments, deposits, and withdrawals. Amount and destination are fixed server-side at create; the post-create lifecycle is driven with a capability session token. - name: FlowAnalytics description: >- Query aggregated analytics and paginated transaction lists for the Flow product. - name: Gasless description: >- Query billing summaries and paginated transaction lists for sponsored (gasless) transactions. - name: Custom Networks description: >- Add and manage custom EVM-compatible networks beyond the built-in chain list. - name: Chainalysis description: >- Configure Chainalysis integration for blockchain address screening and risk assessment. - name: Visits description: Track and query user visit activity within your environment. - name: ExternalJwt description: >- Configure external JWT providers so existing auth tokens can be used with Dynamic. - name: SDK Views description: >- Manage SDK view configurations that customize the appearance of Dynamic modals and flows. - name: DeeplinkUrls description: Configure deep link URLs for mobile app integration with the Dynamic SDK. - name: OrganizationSettings description: >- Read and update organization-level settings such as approval workflow configuration. - name: AdminActions description: >- Manage admin action requests that require approval from another administrator. - name: ClientGrant description: | OAuth 2.0 Device Authorization Grant flow (RFC 8628) used by first-party Dynamic clients (CLI, MCP server, demo apps, IDE plugins) to obtain a revocable, 30-day client JWT without ever seeing the user's dashboard session token. - name: AuthorizedClients description: | Manage first-party clients (CLI / MCP / demo / IDE plugins) authorized to act as a dashboard user. Surfaced under Profile → Authorized Clients. - name: Kyb description: >- Verify a business's identity via AI Prise passthrough and check KYB tier status. paths: /sdk/{environmentId}/yield/vaults/{vaultId}/deposit: post: tags: - SDK summary: Build a vault deposit signing payload description: > Builds an unsigned deposit signing payload for the given vault and wallet address. When the payload includes an approval step, the SDK signs and sends it before the main transaction. operationId: yieldVaultDeposit parameters: - $ref: '#/components/parameters/environmentId' - name: vaultId in: path required: true schema: type: string description: Opaque vault identifier from the Dynamic dashboard. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/YieldVaultActionRequest' responses: '200': description: Deposit signing payload content: application/json: schema: $ref: '#/components/schemas/YieldVaultActionResponse' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' '502': $ref: '#/components/responses/BadGateway' components: parameters: environmentId: in: path name: environmentId required: true description: ID of the environment schema: $ref: '#/components/schemas/uuid' schemas: YieldVaultActionRequest: type: object description: >- Vault action request. `amount` is in the vault asset's human-readable units; `receiverAddress` defaults to `ownerAddress`. required: - ownerAddress - amount properties: ownerAddress: $ref: '#/components/schemas/WalletPublicKey' amount: $ref: '#/components/schemas/NonEmptyAmountString' receiverAddress: $ref: '#/components/schemas/WalletPublicKey' YieldVaultActionResponse: type: object required: - vaultId - signingPayload properties: vaultId: type: string description: Opaque vault identifier. signingPayload: $ref: '#/components/schemas/YieldSigningPayload' uuid: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 example: 95b11417-f18f-457f-8804-68e361f9164f WalletPublicKey: type: string pattern: ^[A-Za-z0-9_-]{18,100}$ description: >- Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON) example: '0xbF394748301603f18d953C90F0b087CBEC0E1834' maxLength: 255 NonEmptyAmountString: type: string pattern: ^(\d+(\.\d+)?|\.\d+)$ description: Digits with optional decimal part example: '100.00' YieldSigningPayload: type: object required: - chainId - chainName properties: chainId: type: string description: Chain identifier for the chain the payload targets. chainName: $ref: '#/components/schemas/ChainEnum' evmTransaction: $ref: '#/components/schemas/SwapEvmTransactionData' evmApproval: $ref: '#/components/schemas/SwapEvmApprovalData' description: >- Unsigned payload for a vault action. When present, `evmApproval` must be signed and sent before `evmTransaction`. BadRequest: type: object properties: error: description: Human-readable error message type: string Forbidden: type: object properties: error: description: Human-readable error message type: string example: Access Forbidden NotFound: type: object required: - error - code properties: error: description: Human-readable error message type: string example: Not Found code: description: Machine-readable error code type: string example: not_found InternalServerError: type: object properties: error: description: Human-readable error message type: string example: Internal Server Error BadGateway: type: object properties: error: description: Human-readable error message type: string example: Error from Snowflake service required: - error ChainEnum: type: string enum: - ETH - EVM - FLOW - SOL - ALGO - STARK - COSMOS - BTC - ECLIPSE - SUI - SPARK - TRON - APTOS - TON - STELLAR - ALEO - TEMPO - MIDNIGHT SwapEvmTransactionData: type: object required: - to - data - value properties: to: type: string description: Contract address to call data: type: string description: Encoded calldata (hex) value: type: string description: Native asset amount in wei (hex string, "0x0" if token-only) gasLimit: type: string description: Suggested gas limit (hex string) gasPrice: type: string description: Gas price in wei (hex string, legacy transactions) maxFeePerGas: type: string description: Max fee per gas (EIP-1559) maxPriorityFeePerGas: type: string description: Max priority fee per gas (EIP-1559) nonce: type: integer description: Transaction nonce SwapEvmApprovalData: type: object required: - tokenAddress - spenderAddress - amount properties: tokenAddress: type: string description: ERC-20 contract to approve spenderAddress: type: string description: Contract that needs the allowance (e.g. LiFi Diamond) amount: type: string description: Amount to approve in token's smallest unit responses: BadRequest: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequest' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Forbidden' NotFound: description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound' InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' BadGateway: description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/BadGateway' ````