Expand description
Types used as operation parameters and responses.
Modules§
Structs§
- AbiParameter
- A parameter in a Solidity ABI function or event definition.
- AbiSchema
- A Solidity ABI definition for decoding smart contract calldata.
- AbiSchema
Item AbiSchemaItem- Account
Balance Params - Query parameters for the account balance endpoint.
- Account
Balance Response - The balance of a digital asset account, aggregated across all wallets and supported chains.
- Account
Display Name - An optional display name for the account.
- Account
Response - A digital asset account that groups wallets under a single entity.
- Account
Wallet - A wallet belonging to a digital asset account.
- Account
Wallet Configuration Item - Configuration for a wallet to create within an account.
- Account
Wallet Ids - IDs for wallets to include in this account.
- Account
Wallets Configuration - Configuration for the wallets on this account.
- Accounts
Dashboard List Response - Paginated list of digital asset accounts for the dashboard.
- Accounts
List Response - Paginated list of digital asset accounts.
- Action
Request Body Condition - Condition on the original wallet action API request body fields.
- Additional
Signer Input - Additional signers for the wallet.
- Additional
Signer Item Input - A single additional signer for a wallet, with an optional policy override.
- Aggregation
- An aggregation that measures and tracks metrics over a period of time.
- Aggregation
Condition - Condition referencing an aggregation value. The field must start with “aggregation.” followed by the aggregation ID.
- Aggregation
Condition Field AggregationConditionField- Aggregation
Group By - A grouping configuration for an aggregation. Maximum of 2 group_by fields allowed.
- Aggregation
Input - Input for creating an aggregation.
- Aggregation
Input Name - The name of the aggregation.
- Aggregation
Metric - The metric configuration for an aggregation, defining what field/field_source to measure and the aggregation function to apply.
- Aggregation
Name - The name of the aggregation.
- Alchemy
Paymaster Context - The Alchemy paymaster context for a smart wallet network configuration.
- Allowlist
Deletion Response - Confirmation response for deleting an allowlist entry.
- Allowlist
Entry - An allowlist entry for an app.
- Analytics
Event Input - The input for capturing an analytics event.
- Analytics
Event Input Event Name AnalyticsEventInputEventName- AppResponse
- The response for getting an app.
- AppResponse
Allowlist Config AppResponseAllowlistConfig- AppResponse
Custom Oauth Providers Item AppResponseCustomOauthProvidersItem- Asset
Account With Balance - A digital asset account with its aggregated balance across all wallets and chains.
- Authenticate
JwtInput - Input for authenticating with a custom JWT.
- Authenticate
Mode - The authentication mode settings for the ceremony.
- Authenticate
Siwe Input - Input for authenticating a SIWE ceremony.
- Authenticate
Siwe Input Chain Id AuthenticateSiweInputChainId- Authenticate
Siwe Input Connector Type AuthenticateSiweInputConnectorType- Authenticate
Siwe Input Wallet Client Type AuthenticateSiweInputWalletClientType- Authenticate
Siws Input - Input for authenticating a SIWS ceremony.
- Authenticate
Siws Input Connector Type AuthenticateSiwsInputConnectorType- Authenticate
Siws Input Wallet Client Type AuthenticateSiwsInputWalletClientType- Authenticated
User - The authenticated user.
- Authenticated
User Identity Token AuthenticatedUserIdentityToken- Authenticated
User Privy Access Token AuthenticatedUserPrivyAccessToken- Authenticated
User Refresh Token AuthenticatedUserRefreshToken- Authenticated
User Token AuthenticatedUserToken- Authorization
KeyDashboard Response - Dashboard response for a wallet authorization key (includes role, which is an internal-only concept).
- Authorization
KeyResponse - Public-facing response for a wallet authorization key.
- Balance
Asset - A single asset entry in a balance, representing holdings across all supported chains.
- Balance
Asset ByChain - A single asset entry scoped to a specific chain.
- Balance
Response - Balances for an asset account or wallet
- Base
Action Result - Common fields for intent action execution results.
- Base
Intent Response - Common fields shared by all intent response types.
- Bitcoin
Address - Bitcoin address: bech32 (bc1), P2SH (3), or P2PKH (1).
- Bitcoin
Caip2 Variant1 BitcoinCaip2Variant1- Bps
- Value in basis points: integer from 0 to 10000 (0% to 100%).
- Bridge
BrlFiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Bridge
Crypto Deposit Metadata - Bridge metadata for a crypto deposit via liquidation address.
- Bridge
Crypto Transfer Metadata - Bridge metadata for a crypto deposit via transfer.
- Bridge
EurFiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Bridge
Fiat Customer Response - The response for getting a native onramp provider customer.
- Bridge
Fiat Deposit Metadata - Bridge metadata for a fiat deposit via virtual account.
- Bridge
Fiat Rejection Reason - A rejection reason for a customer KYC verification.
- Bridge
Fiat Transfer Metadata - Bridge metadata for a fiat deposit via transfer.
- Bridge
Fiat Virtual Account Destination - The destination chain, asset, and address for a virtual account transfer.
- Bridge
Fiat Virtual Account Request - The request input for creating virtual account.
- Bridge
Fiat Virtual Account Response - The response for creating virtual account.
- Bridge
Fiat Virtual Account Source - The source fiat currency configuration for a virtual account.
- Bridge
GbpFiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Bridge
MxnFiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Bridge
Refund Metadata - Bridge metadata for a refund via liquidation address.
- Bridge
Sandbox Fiat Customer Response - The response for getting a native onramp provider customer.
- Bridge
Sandbox Fiat Virtual Account Request - The request input for creating virtual account.
- Bridge
Sandbox Fiat Virtual Account Response - The response for creating virtual account.
- Bridge
Static Memo Deposit Metadata - Bridge metadata for a fiat deposit via static memo.
- Bridge
Transfer Refund Metadata - Bridge metadata for a transfer refund.
- Bridge
UsdFiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Caip2
- A valid CAIP-2 chain ID (e.g. ‘eip155:1’).
- Caip2
Chain Id - A CAIP-2 chain identifier in namespace:reference format (e.g. “eip155:1” for Ethereum mainnet, “solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp” for Solana mainnet).
- Cancel
Custom Order Response CancelCustomOrderResponse- Coinbase
OnRamp Ethereum Address - An Ethereum address with supported blockchains for Coinbase on-ramp.
- Coinbase
OnRamp Init Ethereum Input - Input for initializing a Coinbase on-ramp session for Ethereum.
- Coinbase
OnRamp Init Response - The response from initializing a Coinbase on-ramp session.
- Coinbase
OnRamp Init Solana Input - Input for initializing a Coinbase on-ramp session for Solana.
- Coinbase
OnRamp Solana Address - A Solana address with supported blockchains for Coinbase on-ramp.
- Coinbase
OnRamp Status Response - The response for getting the status of a Coinbase on-ramp session.
- Condition
Set - A condition set for grouping related condition values.
- Condition
SetAuthorization Headers - Headers required to authorize modifications to condition sets.
- Condition
SetId - Unique ID of the created condition set. This will be the primary identifier when using the condition set in the future.
- Condition
SetItem - A single item in a condition set.
- Condition
SetItem Condition SetId - Unique ID of the condition set this item belongs to.
- Condition
SetItem Id - Unique ID of the created condition set item.
- Condition
SetItem Request Params - Unique IDs of the condition set and the condition set item within the condition set to take actions on.
- Condition
SetItem Request Params Condition SetId ConditionSetItemRequestParamsConditionSetId- Condition
SetItem Request Params Condition SetItem Id ConditionSetItemRequestParamsConditionSetItemId- Condition
SetItem Value Input - A single value to add to a condition set.
- Condition
SetItem Value Input Value ConditionSetItemValueInputValue- Condition
SetItems - Array of condition set items.
- Condition
SetItems Request Body - Array of values to add to the condition set. Maximum 100 items per request.
- Condition
SetItems Response - Paginated list of condition set items.
- Condition
SetName - Name of the condition set.
- Condition
SetRequest Body - Request body for creating a condition set. Exactly one of
ownerorowner_idis required. - Condition
SetRequest Body Name - Name to assign to condition set.
- Condition
SetRequest Params - Unique ID of the condition set to take actions on.
- Condition
SetRequest Params Condition SetId ConditionSetRequestParamsConditionSetId- Configure
AppFor Fiat OnOff Ramping Body ConfigureAppForFiatOnOffRampingBody- Configure
AppFor Fiat OnOff Ramping Body ApiKey ConfigureAppForFiatOnOffRampingBodyApiKey- Create
Account From Wallet IdsInput - Input for creating a digital asset account from existing wallets with a
wallet_idsparameter. - Create
Account From Wallets Configuration Input - Input for creating a digital asset account from new wallets with a
wallets_configurationspecification. - Create
Condition SetItems Condition SetId CreateConditionSetItemsConditionSetId- Create
Custom Order Response CreateCustomOrderResponse- Create
Kraken User Body CreateKrakenUserBody- Create
Kraken User Body Full Name CreateKrakenUserBodyFullName- Create
Kraken User Body Phone CreateKrakenUserBodyPhone- Create
Kraken User Body Residence CreateKrakenUserBodyResidence- Create
Kraken User Body TaxIds Item CreateKrakenUserBodyTaxIdsItem- Create
Kraken User Response CreateKrakenUserResponse- Create
Kraken User Response Data CreateKrakenUserResponseData- Create
Kraken User Response Data Result CreateKrakenUserResponseDataResult- Create
Kraken User Response Data Result User CreateKrakenUserResponseDataResultUser- Create
Link Auth Intent Input - Input for creating a Link auth intent to initiate Stripe onramp authentication.
- Create
Link Auth Intent Response - The created Link auth intent.
- Create
OrUpdate Fiat Customer Request Input - The request input for creating (or updating) a native onramp provider customer.
- Create
Organization Secret Account Id CreateOrganizationSecretAccountId- Create
Organization Secret Response - Response returned when creating a new organization secret.
- Create
Policy Body CreatePolicyBody- Create
Policy Body Name - Name to assign to policy.
- Create
Policy Body Rules Item CreatePolicyBodyRulesItem- Create
Policy Body Rules Item Name CreatePolicyBodyRulesItemName- Create
Policy Update Intent Body CreatePolicyUpdateIntentBody- Create
Policy Update Intent Body Name - Name to assign to policy.
- Create
Rule Policy Id CreateRulePolicyId- Create
Stripe Onramp Session Input - Input for creating a Stripe onramp session.
- Create
Stripe Onramp Session Input Session Id CreateStripeOnrampSessionInputSessionId- Create
Stripe Onramp Session Response - The created onramp session.
- Create
User Body CreateUserBody- Create
User Body Wallets Item CreateUserBodyWalletsItem- Create
User Body Wallets Item Additional Signers Item CreateUserBodyWalletsItemAdditionalSignersItem- Create
User Body Wallets Item Additional Signers Item Override Policy IdsItem CreateUserBodyWalletsItemAdditionalSignersItemOverridePolicyIdsItem- Create
User Body Wallets Item Policy IdsItem CreateUserBodyWalletsItemPolicyIdsItem- Create
User Fiat Account Body CreateUserFiatAccountBody- Create
User Fiat Account Body Account CreateUserFiatAccountBodyAccount- Create
User Fiat Account Body Account Account Number CreateUserFiatAccountBodyAccountAccountNumber- Create
User Fiat Account Body Account Owner Name CreateUserFiatAccountBodyAccountOwnerName- Create
User Fiat Account Body Account Routing Number CreateUserFiatAccountBodyAccountRoutingNumber- Create
User Fiat Account Body Address CreateUserFiatAccountBodyAddress- Create
User Fiat Account Body Address City CreateUserFiatAccountBodyAddressCity- Create
User Fiat Account Body Address Country CreateUserFiatAccountBodyAddressCountry- Create
User Fiat Account Body Address Postal Code CreateUserFiatAccountBodyAddressPostalCode- Create
User Fiat Account Body Address State CreateUserFiatAccountBodyAddressState- Create
User Fiat Account Body Address Street Line1 CreateUserFiatAccountBodyAddressStreetLine1- Create
User Fiat Account Body Address Street Line2 CreateUserFiatAccountBodyAddressStreetLine2- Create
User Fiat Account Body Bank Name CreateUserFiatAccountBodyBankName- Create
User Fiat Account Body First Name CreateUserFiatAccountBodyFirstName- Create
User Fiat Account Body Iban CreateUserFiatAccountBodyIban- Create
User Fiat Account Body Iban Account Number CreateUserFiatAccountBodyIbanAccountNumber- Create
User Fiat Account Body Iban Bic CreateUserFiatAccountBodyIbanBic- Create
User Fiat Account Body Iban Country CreateUserFiatAccountBodyIbanCountry- Create
User Fiat Account Body Last Name CreateUserFiatAccountBodyLastName- Create
User Fiat Account Body Swift CreateUserFiatAccountBodySwift- Create
User Fiat Account Body Swift Account CreateUserFiatAccountBodySwiftAccount- Create
User Fiat Account Body Swift Account Account Number CreateUserFiatAccountBodySwiftAccountAccountNumber- Create
User Fiat Account Body Swift Account Bic CreateUserFiatAccountBodySwiftAccountBic- Create
User Fiat Account Body Swift Account Country CreateUserFiatAccountBodySwiftAccountCountry- Create
User Fiat Account Body Swift Address CreateUserFiatAccountBodySwiftAddress- Create
User Fiat Account Body Swift Address City CreateUserFiatAccountBodySwiftAddressCity- Create
User Fiat Account Body Swift Address Country CreateUserFiatAccountBodySwiftAddressCountry- Create
User Fiat Account Body Swift Address Postal Code CreateUserFiatAccountBodySwiftAddressPostalCode- Create
User Fiat Account Body Swift Address State CreateUserFiatAccountBodySwiftAddressState- Create
User Fiat Account Body Swift Address Street Line1 CreateUserFiatAccountBodySwiftAddressStreetLine1- Create
User Fiat Account Body Swift Address Street Line2 CreateUserFiatAccountBodySwiftAddressStreetLine2- Create
User Fiat Account Body Swift Short Business Description CreateUserFiatAccountBodySwiftShortBusinessDescription- Create
User Fiat Account Response CreateUserFiatAccountResponse- Create
User Fiat TosBody CreateUserFiatTosBody- Create
User Wallet Body CreateUserWalletBody- Create
Wallet Body CreateWalletBody- Create
Wallet Body Display Name - A human-readable label for the wallet.
- Create
Wallet Body External Id - 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 after creation.
- Cross
AppConnection - A cross-app connection definition
- Cross
AppConnections Response - The response for getting the list of cross-app connections.
- Cross
AppEmbedded Wallet - An embedded wallet associated with a cross-app account.
- Cross
AppSmart Wallet - A smart wallet associated with a cross-app account.
- Crypto
Currency Code - Cryptocurrency symbol. Uppercase alphanumeric, 2-10 characters.
- Currency
- A crypto currency identified by a CAIP-2 chain ID and optional asset.
- Currency
Amount - A monetary value with its currency denomination.
- Custodial
Wallet - Information about a custodial wallet.
- Custodial
Wallet Create Input - The input for creating a custodial wallet.
- Custodial
Wallet Create Input Provider User Id - The resource ID of the beneficiary of the custodial wallet, given by the licensing provider.
- Custodial
Wallet Policy IdsItem CustodialWalletPolicyIdsItem- Custom
JwtAuthenticate Request Body - The request body for authenticating with a custom JWT.
- Custom
JwtLink Request Body - The request body for linking a custom JWT account.
- Custom
Metadata - Custom metadata associated with the user.
- CustomO
Auth Provider Id - The ID of a custom OAuth provider, set up for this app. Must start with “custom:”.
- Custom
Token Transfer Source - Source for a transfer identified by a token contract address (EVM) or mint address (Solana). Use this variant for tokens that are not first-class assets.
- Custom
Token Transfer Source Amount - Amount as a decimal string in the token’s standard unit (e.g. “1.5” for 1.5 USDC, “0.01” for 0.01 ETH). Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100 characters.
- Delete
Aggregation Aggregation Id DeleteAggregationAggregationId- Delete
Condition SetCondition SetId DeleteConditionSetConditionSetId- Delete
Condition SetItem Condition SetId DeleteConditionSetItemConditionSetId- Delete
Condition SetItem Condition SetItem Id DeleteConditionSetItemConditionSetItemId- Delete
Policy Policy Id DeletePolicyPolicyId- Delete
Rule Policy Id DeleteRulePolicyId- Delete
Rule Rule Id DeleteRuleRuleId- Developer
Fee - Estimated fee paid to the developer.
- Device
Authorization Response - Response from the device authorization endpoint per RFC 8628. Contains codes and URIs for the device flow.
- Device
Verify Request Body - Request body for approving or denying a device authorization request. The user must be authenticated and belong to the target app.
- Device
Verify Response - Response indicating the device authorization action was processed.
- Earn
Asset - Asset metadata for an earn vault position.
- Earn
Deposit Action Response - Response for an earn deposit action.
- Earn
Deposit Request Body - Input for depositing assets into an ERC-4626 vault. Exactly one of
amountorraw_amountmust be provided. - Earn
Deposit Request Body Amount - Human-readable decimal amount to deposit (e.g. “1.5” for 1.5 USDC).
Exactly one of
amountorraw_amountmust be provided. - Earn
Deposit Request Body RawAmount - Amount in smallest unit to deposit (e.g. “1500000” for 1.5 USDC with 6
decimals). Exactly one of
amountorraw_amountmust be provided. - Earn
Incentive Claim Action Response - Response for an earn incentive claim action.
- Earn
Incentive Claim Request Body - Input for claiming incentive rewards.
- Earn
Incentive Reward Entry - A reward token with claimed and unclaimed amounts.
- Earn
Incentive Reward Entry Amount Claimed - Total amount already claimed, in smallest unit.
- Earn
Incentive Reward Entry Amount Unclaimed - Amount available to claim on-chain but not yet claimed, in smallest unit.
- Earn
Incentive Rewards Query - Query parameters for fetching incentive rewards.
- Earn
Incentive Rewards Response - All incentive rewards for a wallet, with claimed and unclaimed amounts per token.
- Earn
Incetive Claim Reward Entry - A specific reward token and amount associated with an earn incentive claim.
- Earn
Withdraw Action Response - Response for an earn withdraw action.
- Earn
Withdraw Request Body - Input for withdrawing assets from an ERC-4626 vault. Exactly one of
amountorraw_amountmust be provided. - Earn
Withdraw Request Body Amount - Human-readable decimal amount to withdraw (e.g. “1.5” for 1.5 USDC).
Exactly one of
amountorraw_amountmust be provided. - Earn
Withdraw Request Body RawAmount - Amount in smallest unit to withdraw (e.g. “1500000” for 1.5 USDC with 6
decimals). Exactly one of
amountorraw_amountmust be provided. - Email
Domain - An email domain.
- Email
Domain Invite Input - Allowlist invite input for an email domain.
- Email
Invite Input - Allowlist invite input for an email address.
- Embedded
Wallet Chain Config - Chain-specific configuration for embedded wallets.
- Embedded
Wallet Config Schema - Configuration for embedded wallets including the mode.
- Embedded
Wallet Creation Input - The fields describing embedded wallet creation, used for user import and embedded wallet generation.
- Embedded
Wallet Input Schema - Input configuration for embedded wallets.
- Encrypted
Authorization Key - HPKE-encrypted authorization key with encapsulated key and ciphertext.
- Encrypted
Bound Authenticate Response - Encrypted response from bound wallet authentication, with bindings.
- Ethereum7702
Authorization Condition - Allowed contract addresses for eth_sign7702Authorization requests.
- Ethereum
Calldata Condition - The decoded calldata in a smart contract interaction as the smart contract method’s parameters. Note that ‘ethereum_calldata’ conditions must contain an abi parameter with the JSON ABI of the smart contract.
- Ethereum
Earn Position Query - Query parameters for fetching an earn vault position.
- Ethereum
Earn Position Response - A wallet’s position in an earn vault.
- Ethereum
Earn Vault Details Response - Detailed vault information including current APY, liquidity, and asset metadata.
- Ethereum
Personal Sign RpcInput - Executes the EVM
personal_signRPC (EIP-191) to sign a message. - Ethereum
Personal Sign RpcInput Params - Parameters for the EVM
personal_signRPC. - Ethereum
Personal Sign RpcInput Params Message EthereumPersonalSignRpcInputParamsMessage- Ethereum
Personal Sign RpcResponse - Response to the EVM
personal_signRPC. - Ethereum
Personal Sign RpcResponse Data - Data returned by the EVM
personal_signRPC. - Ethereum
Secp256k1 Sign RpcInput - Signs a raw hash on the secp256k1 curve.
- Ethereum
Secp256k1 Sign RpcInput Params - Parameters for the EVM
secp256k1_signRPC. - Ethereum
Secp256k1 Sign RpcResponse - Response to the EVM
secp256k1_signRPC. - Ethereum
Secp256k1 Sign RpcResponse Data - Data returned by the EVM
secp256k1_signRPC. - Ethereum
Send Calls Call - A single call within a batched wallet_sendCalls request.
- Ethereum
Send Calls RpcInput - Executes the
wallet_sendCallsRPC (EIP-5792) to batch multiple calls into a single atomic transaction. - Ethereum
Send Calls RpcInput Params - Parameters for the
wallet_sendCallsRPC. - Ethereum
Send Calls RpcResponse - Response to the
wallet_sendCallsRPC. - Ethereum
Send Calls RpcResponse Data - Data returned by the
wallet_sendCallsRPC. - Ethereum
Send Transaction RpcInput - Executes the EVM
eth_sendTransactionRPC to sign and broadcast a transaction. - Ethereum
Send Transaction RpcInput Params - Parameters for the EVM
eth_sendTransactionRPC. - Ethereum
Send Transaction RpcInput Reference Id EthereumSendTransactionRpcInputReferenceId- Ethereum
Send Transaction RpcResponse - Response to the EVM
eth_sendTransactionRPC. - Ethereum
Send Transaction RpcResponse Data - Data returned by the EVM
eth_sendTransactionRPC. - Ethereum
Sign7702 Authorization - A signed EIP-7702 authorization that delegates code execution to a contract address.
- Ethereum
Sign7702 Authorization RpcInput - Signs an EIP-7702 authorization.
- Ethereum
Sign7702 Authorization RpcInput Params - Parameters for the EVM
eth_sign7702AuthorizationRPC. - Ethereum
Sign7702 Authorization RpcResponse - Response to the EVM
eth_sign7702AuthorizationRPC. - Ethereum
Sign7702 Authorization RpcResponse Data - Data returned by the EVM
eth_sign7702AuthorizationRPC. - Ethereum
Sign Transaction RpcInput - Executes the EVM
eth_signTransactionRPC to sign a transaction. - Ethereum
Sign Transaction RpcInput Params - Parameters for the EVM
eth_signTransactionRPC. - Ethereum
Sign Transaction RpcResponse - Response to the EVM
eth_signTransactionRPC. - Ethereum
Sign Transaction RpcResponse Data - Data returned by the EVM
eth_signTransactionRPC. - Ethereum
Sign Typed Data RpcInput - Executes the EVM
eth_signTypedData_v4RPC (EIP-712) to sign a typed data object. - Ethereum
Sign Typed Data RpcInput Params - Parameters for the EVM
eth_signTypedData_v4RPC. - Ethereum
Sign Typed Data RpcResponse - Response to the EVM
eth_signTypedData_v4RPC. - Ethereum
Sign Typed Data RpcResponse Data - Data returned by the EVM
eth_signTypedData_v4RPC. - Ethereum
Sign User Operation RpcInput - Executes an RPC method to hash and sign a UserOperation.
- Ethereum
Sign User Operation RpcInput Params - Parameters for the EVM
eth_signUserOperationRPC. - Ethereum
Sign User Operation RpcResponse - Response to the EVM
eth_signUserOperationRPC. - Ethereum
Sign User Operation RpcResponse Data - Data returned by the EVM
eth_signUserOperationRPC. - Ethereum
Transaction Condition - The verbatim Ethereum transaction object in an eth_signTransaction or eth_sendTransaction request.
- Ethereum
Typed Data Domain Condition - Attributes from the signing domain that will verify the signature.
- Ethereum
Typed Data Input - EIP-712 typed data object.
- Ethereum
Typed Data Message Condition - ‘types’ and ‘primary_type’ attributes of the TypedData JSON object defined in EIP-712.
- Ethereum
Typed Data Message Condition Typed Data EthereumTypedDataMessageConditionTypedData- Ethereum
Vault Details Input - Input for fetching vault details.
- Ethereum
Vault Details Response - Detailed vault information including current APY and liquidity.
- Ethereum
Vault Position - A user’s position in a DeFi vault.
- Ethereum
Vault Position Asset EthereumVaultPositionAsset- Ethereum
Vault Response - A vault configuration for yield features.
- Ethereum
Yield Claim IdInput - Input for fetching a yield reward claim by ID.
- Ethereum
Yield Claim Input - Input for claiming incentive rewards from vault participation.
- Ethereum
Yield Claim Response - Response from a yield reward claim operation.
- Ethereum
Yield Claim Reward - A single reward token claimed from vault participation.
- Ethereum
Yield Deposit Input - Input for depositing assets into an ERC-4626 vault.
- Ethereum
Yield Deposit Input Asset Amount - The amount of the underlying asset to deposit, in the smallest unit (e.g., wei for ETH, 6 decimals for USDC). Must be a non-negative integer string.
- Ethereum
Yield Position Response - A user’s position in a yield vault.
- Ethereum
Yield Position Response Asset EthereumYieldPositionResponseAsset- Ethereum
Yield Positions Input - Input for fetching yield positions.
- Ethereum
Yield Sweep IdInput - Input for fetching a yield sweep by ID.
- Ethereum
Yield Sweep Response - A yield sweep record representing a deposit or withdrawal.
- Ethereum
Yield Withdraw Input - Input for withdrawing assets from an ERC-4626 vault.
- Ethereum
Yield Withdraw Input Asset Amount - The amount of the underlying asset to withdraw, in the smallest unit (e.g., wei for ETH, 6 decimals for USDC). Must be a non-negative integer string.
- EvmAddress
- EVM address: 0x followed by 40 hex characters. Preserves input case.
- EvmCaip2
- EVM CAIP-2 chain identifier (e.g. “eip155:1”, “eip155:84532”).
- EvmCaip2
Chain Id - An EVM CAIP-2 chain identifier (e.g., “eip155:8453” for Base).
- EvmChecksum
Address - EVM address normalized to EIP-55 checksum case.
- EvmTransaction
Wallet Action Step - A wallet action step consisting of an EVM transaction.
- EvmUser
Operation Wallet Action Step - A wallet action step consisting of an EVM user operation.
- Exchange
Stripe Tokens Input - Input for exchanging a Link auth intent for OAuth tokens.
- Exchange
Stripe Tokens Input Auth Intent Id ExchangeStripeTokensInputAuthIntentId- Exchange
Stripe Tokens Input Crypto Customer Id ExchangeStripeTokensInputCryptoCustomerId- Exchange
Stripe Tokens Response - Confirmation that tokens were exchanged and stored.
- Execute
Quote Body ExecuteQuoteBody- Execute
Quote Body User Id ExecuteQuoteBodyUserId- Execute
Quote Response ExecuteQuoteResponse- Execute
Quote Response Data ExecuteQuoteResponseData- Execute
Quote Response Data Result ExecuteQuoteResponseDataResult- Export
Private KeyRpc Input - Exports the private key of the wallet.
- Export
Private KeyRpc Response - Response to the
exportPrivateKeyRPC. - Export
Seed Phrase RpcInput - Exports the seed phrase of the wallet.
- Export
Seed Phrase RpcResponse - Response to the
exportSeedPhraseRPC. - External
Transaction Wallet Action Step - A wallet action step representing a cross-chain/cross-asset fill by an external provider.
- Failure
Reason - A description of why a wallet action (or a step within a wallet action) failed.
- Farcaster
Authenticate Input - Input for authenticating with Farcaster.
- Farcaster
Authenticate Request Body - The request body for authenticating with Farcaster.
- Farcaster
Connect Init Response - Proxy for the Farcaster Connect init response as defined in FIP-11.
- Farcaster
Connect Init Response Body - The response body for initiating a Farcaster connection.
- Farcaster
Connect Status Completed Response - Proxy for the Farcaster Connect completed status response as defined in FIP-11.
- Farcaster
Connect Status Completed Response Body - The response body for completing a Farcaster connection.
- Farcaster
Connect Status Pending Response - Proxy for the Farcaster Connect pending status response as defined in FIP-11.
- Farcaster
Connect Status Pending Response Body - The response body for pending a Farcaster connection.
- Farcaster
Init Input - Input for initiating a Farcaster connection.
- Farcaster
Init Request Body - The request body for initiating a Farcaster connection.
- Farcaster
Link Input - Input for linking a Farcaster account.
- Farcaster
Link Request Body - The request body for linking a Farcaster account.
- Farcaster
Signer Approved - A Farcaster signer response when the signer has been approved.
- Farcaster
Signer Init Pending Approval - A Farcaster signer init response when the signer is pending approval.
- Farcaster
Signer Init Request Body - The request body for initiating a Farcaster signer connection.
- Farcaster
Signer Revoked - A Farcaster signer response when the signer has been revoked.
- Farcaster
Signer Status Pending Approval - A Farcaster signer status response when the signer is pending approval.
- Farcaster
Unlink Input - Input for unlinking a Farcaster account.
- Farcaster
Unlink Request Body - The request body for unlinking a Farcaster account.
- Farcaster
V2Authenticate Input - Input for authenticating a Farcaster V2 account.
- Farcaster
V2Authenticate Request Body - The request body for authenticating a Farcaster V2 account.
- Farcaster
V2Init Input - Input for initiating a Farcaster V2 connection.
- Farcaster
V2Init Request Body - The request body for initiating a Farcaster V2 connection.
- Farcaster
V2Init Response - Response for initiating a Farcaster V2 connection.
- Farcaster
V2Init Response Body - The response body for initiating a Farcaster V2 connection.
- FeeConfiguration
- How transfer fees are specified. If omitted, a default fee configuration is applied.
- Fiat
Amount - A positive decimal amount as a string (e.g. “100”, “50.25”, “0.001”).
- Fiat
Currency Code - ISO 4217 fiat currency code. Three uppercase ASCII letters.
- Fiat
Onramp Destination - Destination cryptocurrency details for a fiat onramp quote request.
- Fiat
Onramp Provider Error - An error from a specific fiat onramp provider when fetching quotes.
- Fiat
Onramp Quote - A single fiat onramp quote from a provider.
- Fiat
Onramp Source - Source currency details for a fiat onramp quote request.
- Fiat
Onramp Stripe SdkSession Response - Provider session initialization for embedded SDK providers (Stripe).
- Fiat
Onramp UrlSession Response - Provider session initialization for popup-based providers.
- Funding
Config Response Schema - Configuration for funding and on-ramp options.
- Funding
Option - A funding option with method and provider.
- Funds
Deposited Webhook Payload - Payload for the wallet.funds_deposited webhook event.
- Funds
Deposited Webhook Payload Block FundsDepositedWebhookPayloadBlock- Funds
Withdrawn Webhook Payload - Payload for the wallet.funds_withdrawn webhook event.
- Funds
Withdrawn Webhook Payload Block FundsWithdrawnWebhookPayloadBlock- Gas
- Gas cost for a blockchain action. Includes both raw base-unit amount and a human-readable decimal string, plus the gas token symbol.
- GasSpend
Request Body - Query parameters for getting gas spend for a set of wallets. The time
range from
start_timestamptoend_timestampmust not exceed 30 days. - GasSpend
Response Body - Aggregated Privy gas credits charged for a set of wallets over a time range.
- GetAccount
Account Id - ID of the account.
- GetAccount
Balance Account Id - ID of the account.
- GetAggregation
Aggregation Id GetAggregationAggregationId- GetBy
Wallet Address Request Body - Request body for looking up a wallet by its blockchain address.
- GetCondition
SetCondition SetId GetConditionSetConditionSetId- GetCondition
SetItem Condition SetId GetConditionSetItemConditionSetId- GetCondition
SetItem Condition SetItem Id GetConditionSetItemConditionSetItemId- GetCondition
SetItems Condition SetId GetConditionSetItemsConditionSetId- GetCondition
SetItems Cursor GetConditionSetItemsCursor- GetCustom
Order History Response GetCustomOrderHistoryResponse- GetCustom
Order Response GetCustomOrderResponse- GetEarn
Summary Currency GetEarnSummaryCurrency- GetFiat
Customer Request Input - The request input for getting a native onramp provider customer.
- GetFiat
Onramp Quotes Input - The request input for getting fiat onramp quotes.
- GetFiat
Onramp Quotes Response - The response containing fiat onramp quotes.
- GetFiat
Onramp Transaction Status Input - The request input for checking a fiat onramp session status.
- GetFiat
Onramp Transaction Status Response - The response containing the fiat onramp session status.
- GetFiat
Onramp UrlInput - The request input for getting a fiat onramp provider session URL.
- GetKraken
Embed Assets Asset Id - The asset identifier (e.g., BTC, ETH)
- GetKraken
Embed Assets Lang - RFC5646 language tag for localized content.
- GetKraken
Embed Assets Quote - Quote currency for pricing information.
- GetKraken
Embed Assets Response GetKrakenEmbedAssetsResponse- GetKraken
Embed Assets Response Data GetKrakenEmbedAssetsResponseData- GetKraken
Embed Assets Response Data Result GetKrakenEmbedAssetsResponseDataResult- GetKraken
Embed Assets Response Data Result AthValue GetKrakenEmbedAssetsResponseDataResultAthValue- GetKraken
Embed Assets Response Data Result Change Percent24h GetKrakenEmbedAssetsResponseDataResultChangePercent24h- GetKraken
Embed Assets Response Data Result Change Value24h GetKrakenEmbedAssetsResponseDataResultChangeValue24h- GetKraken
Embed Assets Response Data Result Circulating Supply GetKrakenEmbedAssetsResponseDataResultCirculatingSupply- GetKraken
Embed Assets Response Data Result Links GetKrakenEmbedAssetsResponseDataResultLinks- GetKraken
Embed Assets Response Data Result Links Logo GetKrakenEmbedAssetsResponseDataResultLinksLogo- GetKraken
Embed Assets Response Data Result Links Self GetKrakenEmbedAssetsResponseDataResultLinksSelf- GetKraken
Embed Assets Response Data Result Market CapValue GetKrakenEmbedAssetsResponseDataResultMarketCapValue- GetKraken
Embed Assets Response Data Result MaxSupply GetKrakenEmbedAssetsResponseDataResultMaxSupply- GetKraken
Embed Assets Response Data Result Symbol GetKrakenEmbedAssetsResponseDataResultSymbol- GetKraken
Embed Assets Response Data Result Total Supply GetKrakenEmbedAssetsResponseDataResultTotalSupply- GetKraken
Embed Assets Response Data Result Volume Value24h GetKrakenEmbedAssetsResponseDataResultVolumeValue24h- GetKraken
User Response GetKrakenUserResponse- GetKraken
User Response Data GetKrakenUserResponseData- GetKraken
User Response Data Result GetKrakenUserResponseDataResult- GetKraken
User Response Data Result User GetKrakenUserResponseDataResultUser- GetMaster
Account Portfolio Details Quote GetMasterAccountPortfolioDetailsQuote- GetMaster
Account Portfolio Details Response GetMasterAccountPortfolioDetailsResponse- GetMaster
Account Portfolio Details Response Result GetMasterAccountPortfolioDetailsResponseResult- GetMaster
Account Portfolio Details Response Result Assets Item GetMasterAccountPortfolioDetailsResponseResultAssetsItem- GetMaster
Account Portfolio Details Response Result Assets Item Asset GetMasterAccountPortfolioDetailsResponseResultAssetsItemAsset- GetMaster
Account Portfolio Details Response Result Assets Item Avail Trade GetMasterAccountPortfolioDetailsResponseResultAssetsItemAvailTrade- GetMaster
Account Portfolio Details Response Result Assets Item Avail Trade Value GetMasterAccountPortfolioDetailsResponseResultAssetsItemAvailTradeValue- GetMaster
Account Portfolio Details Response Result Assets Item AvgEntry Price GetMasterAccountPortfolioDetailsResponseResultAssetsItemAvgEntryPrice- GetMaster
Account Portfolio Details Response Result Assets Item Cash Balance GetMasterAccountPortfolioDetailsResponseResultAssetsItemCashBalance- GetMaster
Account Portfolio Details Response Result Assets Item Cash Value GetMasterAccountPortfolioDetailsResponseResultAssetsItemCashValue- GetMaster
Account Portfolio Details Response Result Assets Item Cost Basis GetMasterAccountPortfolioDetailsResponseResultAssetsItemCostBasis- GetMaster
Account Portfolio Details Response Result Assets Item Credit Line Available GetMasterAccountPortfolioDetailsResponseResultAssetsItemCreditLineAvailable- GetMaster
Account Portfolio Details Response Result Assets Item Credit Line Used GetMasterAccountPortfolioDetailsResponseResultAssetsItemCreditLineUsed- GetMaster
Account Portfolio Details Response Result Assets Item Held Orders Spot GetMasterAccountPortfolioDetailsResponseResultAssetsItemHeldOrdersSpot- GetMaster
Account Portfolio Details Response Result Assets Item Index Price GetMasterAccountPortfolioDetailsResponseResultAssetsItemIndexPrice- GetMaster
Account Portfolio Details Response Result Assets Item Lots Upnl GetMasterAccountPortfolioDetailsResponseResultAssetsItemLotsUpnl- GetMaster
Account Portfolio Details Response Result Currency GetMasterAccountPortfolioDetailsResponseResultCurrency- GetMaster
Account Portfolio History Include Assets Variant0 Item GetMasterAccountPortfolioHistoryIncludeAssetsVariant0Item- GetMaster
Account Portfolio History Include Assets Variant1 GetMasterAccountPortfolioHistoryIncludeAssetsVariant1- GetMaster
Account Portfolio History Quote GetMasterAccountPortfolioHistoryQuote- GetMaster
Account Portfolio History Response GetMasterAccountPortfolioHistoryResponse- GetMaster
Account Portfolio History Response Result GetMasterAccountPortfolioHistoryResponseResult- GetMaster
Account Portfolio History Response Result Currency GetMasterAccountPortfolioHistoryResponseResultCurrency- GetMaster
Account Portfolio History Response Result History Item GetMasterAccountPortfolioHistoryResponseResultHistoryItem- GetMaster
Account Portfolio History Response Result History Item Assets Value GetMasterAccountPortfolioHistoryResponseResultHistoryItemAssetsValue- GetMaster
Account Portfolio History Response Result History Item Assets Value Balance GetMasterAccountPortfolioHistoryResponseResultHistoryItemAssetsValueBalance- GetMaster
Account Portfolio History Response Result History Item Total Balance GetMasterAccountPortfolioHistoryResponseResultHistoryItemTotalBalance- GetMaster
Account Portfolio History Response Result History Item Total Pnl GetMasterAccountPortfolioHistoryResponseResultHistoryItemTotalPnl- GetMaster
Account Portfolio History Response Result History Item Total PnlPct GetMasterAccountPortfolioHistoryResponseResultHistoryItemTotalPnlPct- GetMaster
Account Portfolio History Response Result Total Pnl GetMasterAccountPortfolioHistoryResponseResultTotalPnl- GetMaster
Account Portfolio History Response Result Total PnlPct GetMasterAccountPortfolioHistoryResponseResultTotalPnlPct- GetMaster
Account Portfolio Summary Quote GetMasterAccountPortfolioSummaryQuote- GetMaster
Account Portfolio Transactions Assets Item GetMasterAccountPortfolioTransactionsAssetsItem- GetMaster
Account Portfolio Transactions Quote GetMasterAccountPortfolioTransactionsQuote- GetMaster
Account Portfolio Transactions RefIds Item GetMasterAccountPortfolioTransactionsRefIdsItem- GetMaster
Account Portfolio Transactions RefIds Item RefId GetMasterAccountPortfolioTransactionsRefIdsItemRefId- GetMaster
Account Portfolio Transactions Response GetMasterAccountPortfolioTransactionsResponse- GetMaster
Account Portfolio Transactions Response Result GetMasterAccountPortfolioTransactionsResponseResult- GetMaster
Account Portfolio Transactions Response Result Stats GetMasterAccountPortfolioTransactionsResponseResultStats- GetMaster
Account Portfolio Transactions Response Result Transactions Item GetMasterAccountPortfolioTransactionsResponseResultTransactionsItem- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Receive Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1ReceiveAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Spend Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1SpendAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceive- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Amount Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveAmountAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Amount Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveAmountAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Balance GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveBalance- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Balance Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveBalanceAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Balance Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveBalanceAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Fee GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveFee- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive FeeAmount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveFeeAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive FeeAsset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveFeeAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Amount Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedAmountAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Amount Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedAmountAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Fee GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedFee- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted FeeAmount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedFeeAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted FeeAsset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedFeeAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Total GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedTotal- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Total Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedTotalAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Total Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedTotalAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Total GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveTotal- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Total Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveTotalAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Total Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveTotalAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpend- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Amount Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendAmountAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Amount Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendAmountAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Balance GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendBalance- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Balance Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendBalanceAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Balance Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendBalanceAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Fee GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendFee- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend FeeAmount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendFeeAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend FeeAsset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendFeeAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Amount Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedAmountAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Amount Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedAmountAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Fee GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedFee- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted FeeAmount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedFeeAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted FeeAsset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedFeeAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Total GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedTotal- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Total Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedTotalAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Total Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedTotalAsset- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Total GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendTotal- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Total Amount GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendTotalAmount- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Total Asset GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendTotalAsset- GetPolicy
Policy Id GetPolicyPolicyId- GetPortfolio
Details Quote GetPortfolioDetailsQuote- GetPortfolio
Details Response GetPortfolioDetailsResponse- GetPortfolio
Details Response Data GetPortfolioDetailsResponseData- GetPortfolio
Details Response Data Result GetPortfolioDetailsResponseDataResult- GetPortfolio
Details Response Data Result Assets Item GetPortfolioDetailsResponseDataResultAssetsItem- GetPortfolio
Details Response Data Result Assets Item Asset GetPortfolioDetailsResponseDataResultAssetsItemAsset- GetPortfolio
Details Response Data Result Assets Item Avail Trade GetPortfolioDetailsResponseDataResultAssetsItemAvailTrade- GetPortfolio
Details Response Data Result Assets Item Avail Trade Value GetPortfolioDetailsResponseDataResultAssetsItemAvailTradeValue- GetPortfolio
Details Response Data Result Assets Item AvgEntry Price GetPortfolioDetailsResponseDataResultAssetsItemAvgEntryPrice- GetPortfolio
Details Response Data Result Assets Item Cash Balance GetPortfolioDetailsResponseDataResultAssetsItemCashBalance- GetPortfolio
Details Response Data Result Assets Item Cash Value GetPortfolioDetailsResponseDataResultAssetsItemCashValue- GetPortfolio
Details Response Data Result Assets Item Cost Basis GetPortfolioDetailsResponseDataResultAssetsItemCostBasis- GetPortfolio
Details Response Data Result Assets Item Credit Line Available GetPortfolioDetailsResponseDataResultAssetsItemCreditLineAvailable- GetPortfolio
Details Response Data Result Assets Item Credit Line Used GetPortfolioDetailsResponseDataResultAssetsItemCreditLineUsed- GetPortfolio
Details Response Data Result Assets Item Held Orders Spot GetPortfolioDetailsResponseDataResultAssetsItemHeldOrdersSpot- GetPortfolio
Details Response Data Result Assets Item Index Price GetPortfolioDetailsResponseDataResultAssetsItemIndexPrice- GetPortfolio
Details Response Data Result Assets Item Lots Upnl GetPortfolioDetailsResponseDataResultAssetsItemLotsUpnl- GetPortfolio
Details Response Data Result Currency GetPortfolioDetailsResponseDataResultCurrency- GetPortfolio
Summary Quote GetPortfolioSummaryQuote- GetPortfolio
Transactions Assets Item GetPortfolioTransactionsAssetsItem- GetPortfolio
Transactions Quote GetPortfolioTransactionsQuote- GetPortfolio
Transactions RefIds Item GetPortfolioTransactionsRefIdsItem- GetPortfolio
Transactions RefIds Item RefId GetPortfolioTransactionsRefIdsItemRefId- GetPortfolio
Transactions Response GetPortfolioTransactionsResponse- GetPortfolio
Transactions Response Data GetPortfolioTransactionsResponseData- GetPortfolio
Transactions Response Data Result GetPortfolioTransactionsResponseDataResult- GetPortfolio
Transactions Response Data Result Stats GetPortfolioTransactionsResponseDataResultStats- GetPortfolio
Transactions Response Data Result Transactions Item GetPortfolioTransactionsResponseDataResultTransactionsItem- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Receive Asset GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1ReceiveAsset- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Spend Asset GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1SpendAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive GetPortfolioTransactionsResponseDataResultTransactionsItemReceive- GetPortfolio
Transactions Response Data Result Transactions Item Receive Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Amount Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveAmountAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Amount Asset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveAmountAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Balance GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveBalance- GetPortfolio
Transactions Response Data Result Transactions Item Receive Balance Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveBalanceAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Balance Asset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveBalanceAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Fee GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveFee- GetPortfolio
Transactions Response Data Result Transactions Item Receive FeeAmount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveFeeAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive FeeAsset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveFeeAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Amount Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedAmountAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Amount Asset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedAmountAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Fee GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedFee- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted FeeAmount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedFeeAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted FeeAsset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedFeeAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Total GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedTotal- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Total Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedTotalAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Total Asset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedTotalAsset- GetPortfolio
Transactions Response Data Result Transactions Item Receive Total GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveTotal- GetPortfolio
Transactions Response Data Result Transactions Item Receive Total Amount GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveTotalAmount- GetPortfolio
Transactions Response Data Result Transactions Item Receive Total Asset GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveTotalAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend GetPortfolioTransactionsResponseDataResultTransactionsItemSpend- GetPortfolio
Transactions Response Data Result Transactions Item Spend Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Amount Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendAmountAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Amount Asset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendAmountAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Balance GetPortfolioTransactionsResponseDataResultTransactionsItemSpendBalance- GetPortfolio
Transactions Response Data Result Transactions Item Spend Balance Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendBalanceAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Balance Asset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendBalanceAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Fee GetPortfolioTransactionsResponseDataResultTransactionsItemSpendFee- GetPortfolio
Transactions Response Data Result Transactions Item Spend FeeAmount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendFeeAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend FeeAsset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendFeeAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Amount Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedAmountAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Amount Asset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedAmountAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Fee GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedFee- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted FeeAmount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedFeeAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted FeeAsset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedFeeAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Total GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedTotal- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Total Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedTotalAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Total Asset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedTotalAsset- GetPortfolio
Transactions Response Data Result Transactions Item Spend Total GetPortfolioTransactionsResponseDataResultTransactionsItemSpendTotal- GetPortfolio
Transactions Response Data Result Transactions Item Spend Total Amount GetPortfolioTransactionsResponseDataResultTransactionsItemSpendTotalAmount- GetPortfolio
Transactions Response Data Result Transactions Item Spend Total Asset GetPortfolioTransactionsResponseDataResultTransactionsItemSpendTotalAsset- GetProtfolio
History ForUser Include Assets Variant0 Item GetProtfolioHistoryForUserIncludeAssetsVariant0Item- GetProtfolio
History ForUser Include Assets Variant1 GetProtfolioHistoryForUserIncludeAssetsVariant1- GetProtfolio
History ForUser Quote GetProtfolioHistoryForUserQuote- GetProtfolio
History ForUser Response GetProtfolioHistoryForUserResponse- GetProtfolio
History ForUser Response Data GetProtfolioHistoryForUserResponseData- GetProtfolio
History ForUser Response Data Result GetProtfolioHistoryForUserResponseDataResult- GetProtfolio
History ForUser Response Data Result Currency GetProtfolioHistoryForUserResponseDataResultCurrency- GetProtfolio
History ForUser Response Data Result History Item GetProtfolioHistoryForUserResponseDataResultHistoryItem- GetProtfolio
History ForUser Response Data Result History Item Assets Value GetProtfolioHistoryForUserResponseDataResultHistoryItemAssetsValue- GetProtfolio
History ForUser Response Data Result History Item Assets Value Balance GetProtfolioHistoryForUserResponseDataResultHistoryItemAssetsValueBalance- GetProtfolio
History ForUser Response Data Result History Item Total Balance GetProtfolioHistoryForUserResponseDataResultHistoryItemTotalBalance- GetProtfolio
History ForUser Response Data Result History Item Total Pnl GetProtfolioHistoryForUserResponseDataResultHistoryItemTotalPnl- GetProtfolio
History ForUser Response Data Result History Item Total PnlPct GetProtfolioHistoryForUserResponseDataResultHistoryItemTotalPnlPct- GetProtfolio
History ForUser Response Data Result Total Pnl GetProtfolioHistoryForUserResponseDataResultTotalPnl- GetProtfolio
History ForUser Response Data Result Total PnlPct GetProtfolioHistoryForUserResponseDataResultTotalPnlPct- GetQuote
Response GetQuoteResponse- GetQuote
Response Data GetQuoteResponseData- GetQuote
Response Data Result GetQuoteResponseDataResult- GetQuote
Response Data Result Quoted Receive GetQuoteResponseDataResultQuotedReceive- GetQuote
Response Data Result Quoted Receive Asset GetQuoteResponseDataResultQuotedReceiveAsset- GetQuote
Response Data Result Quoted Receive Fee GetQuoteResponseDataResultQuotedReceiveFee- GetQuote
Response Data Result Quoted Receive Subtotal GetQuoteResponseDataResultQuotedReceiveSubtotal- GetQuote
Response Data Result Quoted Receive Total GetQuoteResponseDataResultQuotedReceiveTotal- GetQuote
Response Data Result Quoted Spend GetQuoteResponseDataResultQuotedSpend- GetQuote
Response Data Result Quoted Spend Asset GetQuoteResponseDataResultQuotedSpendAsset- GetQuote
Response Data Result Quoted Spend Fee GetQuoteResponseDataResultQuotedSpendFee- GetQuote
Response Data Result Quoted Spend Subtotal GetQuoteResponseDataResultQuotedSpendSubtotal- GetQuote
Response Data Result Quoted Spend Total GetQuoteResponseDataResultQuotedSpendTotal- GetQuote
Response Data Result Quoted Unit Price GetQuoteResponseDataResultQuotedUnitPrice- GetQuote
Response Data Result Quoted Unit Price Asset GetQuoteResponseDataResultQuotedUnitPriceAsset- GetQuote
Response Data Result Quoted Unit Price Denomination Asset GetQuoteResponseDataResultQuotedUnitPriceDenominationAsset- GetQuote
Response Data Result Quoted Unit Price Unit Price GetQuoteResponseDataResultQuotedUnitPriceUnitPrice- GetQuote
Response Data Result Receive GetQuoteResponseDataResultReceive- GetQuote
Response Data Result Receive Asset GetQuoteResponseDataResultReceiveAsset- GetQuote
Response Data Result Receive Fee GetQuoteResponseDataResultReceiveFee- GetQuote
Response Data Result Receive Subtotal GetQuoteResponseDataResultReceiveSubtotal- GetQuote
Response Data Result Receive Total GetQuoteResponseDataResultReceiveTotal- GetQuote
Response Data Result Spend GetQuoteResponseDataResultSpend- GetQuote
Response Data Result Spend Asset GetQuoteResponseDataResultSpendAsset- GetQuote
Response Data Result Spend Fee GetQuoteResponseDataResultSpendFee- GetQuote
Response Data Result Spend Subtotal GetQuoteResponseDataResultSpendSubtotal- GetQuote
Response Data Result Spend Total GetQuoteResponseDataResultSpendTotal- GetQuote
Response Data Result Unit Price GetQuoteResponseDataResultUnitPrice- GetQuote
Response Data Result Unit Price Asset GetQuoteResponseDataResultUnitPriceAsset- GetQuote
Response Data Result Unit Price Denomination Asset GetQuoteResponseDataResultUnitPriceDenominationAsset- GetQuote
Response Data Result Unit Price Unit Price GetQuoteResponseDataResultUnitPriceUnitPrice- GetQuote
User Id - The ID of the Privy user.
- GetRule
Policy Id GetRulePolicyId- GetRule
Rule Id GetRuleRuleId- GetStripe
Crypto Customer Response - Stripe onramp session status and customer verification info.
- GetUser
Fiat Accounts Response GetUserFiatAccountsResponse- GetUser
Fiat Accounts Response Accounts Item GetUserFiatAccountsResponseAccountsItem- GetUser
Fiat KycLink Body GetUserFiatKycLinkBody- GetUser
Fiat KycLink Response GetUserFiatKycLinkResponse- GetUser
Fiat KycLink Response Rejection Reasons Item GetUserFiatKycLinkResponseRejectionReasonsItem- GetUser
Fiat KycStatus Response GetUserFiatKycStatusResponse- GetUsers
Cursor GetUsersCursor- GetUsers
Response GetUsersResponse- GetWallet
Balance Response GetWalletBalanceResponse- GetWallet
Balance Response Balances Item GetWalletBalanceResponseBalancesItem- GetWallets
Authorization Key - Filter wallets by authorization public key. Returns wallets owned by key quorums that include the specified P-256 public key (base64-encoded DER format). Cannot be used together with user_id.
- GetWallets
Cursor GetWalletsCursor- GetWallets
Response GetWalletsResponse- Guest
Authenticate Request Body - The request body for authenticating a guest.
- Guest
Authenticate Request Body Guest Credential GuestAuthenticateRequestBodyGuestCredential- HdInit
Input - The input for HD wallets.
- HdPath
- A BIP-32 hierarchical deterministic wallet derivation path.
- HdSubmit
Input - The submission input for importing an HD wallet.
- Hex
- A hex-encoded string prefixed with ‘0x’, capped at 100002 characters (50,000 bytes).
- Hpke
Import Config - Optional HPKE configuration for wallet import decryption. These parameters allow importing wallets encrypted by external providers that use different HPKE configurations.
- Hyperliquid
Token Address - Hyperliquid L1 spot token identifier: 0x followed by 32–40 hex characters, normalized to lowercase.
- Initiate
Master Account Withdrawal Body InitiateMasterAccountWithdrawalBody- Initiate
Master Account Withdrawal Body Amount InitiateMasterAccountWithdrawalBodyAmount- Initiate
Master Account Withdrawal Body Asset InitiateMasterAccountWithdrawalBodyAsset- Initiate
Master Account Withdrawal Body Key InitiateMasterAccountWithdrawalBodyKey- Initiate
Master Account Withdrawal Response InitiateMasterAccountWithdrawalResponse- Initiate
Master Account Withdrawal Response Result InitiateMasterAccountWithdrawalResponseResult- Initiate
User Fiat KycBody Bridge Birth Date InitiateUserFiatKycBodyBridgeBirthDate- Initiate
User Fiat KycBody Bridge Documents Item InitiateUserFiatKycBodyBridgeDocumentsItem- Initiate
User Fiat KycBody Bridge Documents Item Description InitiateUserFiatKycBodyBridgeDocumentsItemDescription- Initiate
User Fiat KycBody Bridge Documents Item File InitiateUserFiatKycBodyBridgeDocumentsItemFile- Initiate
User Fiat KycBody Bridge Documents Item Purposes Item InitiateUserFiatKycBodyBridgeDocumentsItemPurposesItem- Initiate
User Fiat KycBody Bridge First Name InitiateUserFiatKycBodyBridgeFirstName- Initiate
User Fiat KycBody Bridge Identifying Information Item InitiateUserFiatKycBodyBridgeIdentifyingInformationItem- Initiate
User Fiat KycBody Bridge Identifying Information Item Issuing Country InitiateUserFiatKycBodyBridgeIdentifyingInformationItemIssuingCountry- Initiate
User Fiat KycBody Bridge KycScreen InitiateUserFiatKycBodyBridgeKycScreen- Initiate
User Fiat KycBody Bridge KycScreen Screened At InitiateUserFiatKycBodyBridgeKycScreenScreenedAt- Initiate
User Fiat KycBody Bridge Last Name InitiateUserFiatKycBodyBridgeLastName- Initiate
User Fiat KycBody Bridge Middle Name InitiateUserFiatKycBodyBridgeMiddleName- Initiate
User Fiat KycBody Bridge Nationality InitiateUserFiatKycBodyBridgeNationality- Initiate
User Fiat KycBody Bridge Ofac Screen InitiateUserFiatKycBodyBridgeOfacScreen- Initiate
User Fiat KycBody Bridge Ofac Screen Screened At InitiateUserFiatKycBodyBridgeOfacScreenScreenedAt- Initiate
User Fiat KycBody Bridge Phone InitiateUserFiatKycBodyBridgePhone- Initiate
User Fiat KycBody Bridge Residential Address InitiateUserFiatKycBodyBridgeResidentialAddress- Initiate
User Fiat KycBody Bridge Residential Address City InitiateUserFiatKycBodyBridgeResidentialAddressCity- Initiate
User Fiat KycBody Bridge Residential Address Country InitiateUserFiatKycBodyBridgeResidentialAddressCountry- Initiate
User Fiat KycBody Bridge Residential Address Postal Code InitiateUserFiatKycBodyBridgeResidentialAddressPostalCode- Initiate
User Fiat KycBody Bridge Residential Address Street Line1 InitiateUserFiatKycBodyBridgeResidentialAddressStreetLine1- Initiate
User Fiat KycBody Bridge Residential Address Street Line2 InitiateUserFiatKycBodyBridgeResidentialAddressStreetLine2- Initiate
User Fiat KycBody Bridge Residential Address Subdivision InitiateUserFiatKycBodyBridgeResidentialAddressSubdivision- Initiate
User Fiat KycBody Bridge Sandbox Birth Date InitiateUserFiatKycBodyBridgeSandboxBirthDate- Initiate
User Fiat KycBody Bridge Sandbox Documents Item InitiateUserFiatKycBodyBridgeSandboxDocumentsItem- Initiate
User Fiat KycBody Bridge Sandbox Documents Item Description InitiateUserFiatKycBodyBridgeSandboxDocumentsItemDescription- Initiate
User Fiat KycBody Bridge Sandbox Documents Item File InitiateUserFiatKycBodyBridgeSandboxDocumentsItemFile- Initiate
User Fiat KycBody Bridge Sandbox Documents Item Purposes Item InitiateUserFiatKycBodyBridgeSandboxDocumentsItemPurposesItem- Initiate
User Fiat KycBody Bridge Sandbox First Name InitiateUserFiatKycBodyBridgeSandboxFirstName- Initiate
User Fiat KycBody Bridge Sandbox Identifying Information Item InitiateUserFiatKycBodyBridgeSandboxIdentifyingInformationItem- Initiate
User Fiat KycBody Bridge Sandbox Identifying Information Item Issuing Country InitiateUserFiatKycBodyBridgeSandboxIdentifyingInformationItemIssuingCountry- Initiate
User Fiat KycBody Bridge Sandbox KycScreen InitiateUserFiatKycBodyBridgeSandboxKycScreen- Initiate
User Fiat KycBody Bridge Sandbox KycScreen Screened At InitiateUserFiatKycBodyBridgeSandboxKycScreenScreenedAt- Initiate
User Fiat KycBody Bridge Sandbox Last Name InitiateUserFiatKycBodyBridgeSandboxLastName- Initiate
User Fiat KycBody Bridge Sandbox Middle Name InitiateUserFiatKycBodyBridgeSandboxMiddleName- Initiate
User Fiat KycBody Bridge Sandbox Nationality InitiateUserFiatKycBodyBridgeSandboxNationality- Initiate
User Fiat KycBody Bridge Sandbox Ofac Screen InitiateUserFiatKycBodyBridgeSandboxOfacScreen- Initiate
User Fiat KycBody Bridge Sandbox Ofac Screen Screened At InitiateUserFiatKycBodyBridgeSandboxOfacScreenScreenedAt- Initiate
User Fiat KycBody Bridge Sandbox Phone InitiateUserFiatKycBodyBridgeSandboxPhone- Initiate
User Fiat KycBody Bridge Sandbox Residential Address InitiateUserFiatKycBodyBridgeSandboxResidentialAddress- Initiate
User Fiat KycBody Bridge Sandbox Residential Address City InitiateUserFiatKycBodyBridgeSandboxResidentialAddressCity- Initiate
User Fiat KycBody Bridge Sandbox Residential Address Country InitiateUserFiatKycBodyBridgeSandboxResidentialAddressCountry- Initiate
User Fiat KycBody Bridge Sandbox Residential Address Postal Code InitiateUserFiatKycBodyBridgeSandboxResidentialAddressPostalCode- Initiate
User Fiat KycBody Bridge Sandbox Residential Address Street Line1 InitiateUserFiatKycBodyBridgeSandboxResidentialAddressStreetLine1- Initiate
User Fiat KycBody Bridge Sandbox Residential Address Street Line2 InitiateUserFiatKycBodyBridgeSandboxResidentialAddressStreetLine2- Initiate
User Fiat KycBody Bridge Sandbox Residential Address Subdivision InitiateUserFiatKycBodyBridgeSandboxResidentialAddressSubdivision- Initiate
User Fiat KycBody Bridge Sandbox Signed Agreement Id InitiateUserFiatKycBodyBridgeSandboxSignedAgreementId- Initiate
User Fiat KycBody Bridge Sandbox Transliterated First Name InitiateUserFiatKycBodyBridgeSandboxTransliteratedFirstName- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Last Name InitiateUserFiatKycBodyBridgeSandboxTransliteratedLastName- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Middle Name InitiateUserFiatKycBodyBridgeSandboxTransliteratedMiddleName- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddress- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address City InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressCity- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address Country InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressCountry- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address Postal Code InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressPostalCode- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address Street Line1 InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressStreetLine1- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address Street Line2 InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressStreetLine2- Initiate
User Fiat KycBody Bridge Sandbox Transliterated Residential Address Subdivision InitiateUserFiatKycBodyBridgeSandboxTransliteratedResidentialAddressSubdivision- Initiate
User Fiat KycBody Bridge Signed Agreement Id InitiateUserFiatKycBodyBridgeSignedAgreementId- Initiate
User Fiat KycBody Bridge Transliterated First Name InitiateUserFiatKycBodyBridgeTransliteratedFirstName- Initiate
User Fiat KycBody Bridge Transliterated Last Name InitiateUserFiatKycBodyBridgeTransliteratedLastName- Initiate
User Fiat KycBody Bridge Transliterated Middle Name InitiateUserFiatKycBodyBridgeTransliteratedMiddleName- Initiate
User Fiat KycBody Bridge Transliterated Residential Address InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddress- Initiate
User Fiat KycBody Bridge Transliterated Residential Address City InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressCity- Initiate
User Fiat KycBody Bridge Transliterated Residential Address Country InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressCountry- Initiate
User Fiat KycBody Bridge Transliterated Residential Address Postal Code InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressPostalCode- Initiate
User Fiat KycBody Bridge Transliterated Residential Address Street Line1 InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressStreetLine1- Initiate
User Fiat KycBody Bridge Transliterated Residential Address Street Line2 InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressStreetLine2- Initiate
User Fiat KycBody Bridge Transliterated Residential Address Subdivision InitiateUserFiatKycBodyBridgeTransliteratedResidentialAddressSubdivision- Initiate
User Fiat Offramp Body InitiateUserFiatOfframpBody- Initiate
User Fiat Offramp Body Amount InitiateUserFiatOfframpBodyAmount- Initiate
User Fiat Offramp Body Destination InitiateUserFiatOfframpBodyDestination- Initiate
User Fiat Offramp Body Source InitiateUserFiatOfframpBodySource- Initiate
User Fiat Onramp Body InitiateUserFiatOnrampBody- Initiate
User Fiat Onramp Body Amount InitiateUserFiatOnrampBodyAmount- Initiate
User Fiat Onramp Body Destination InitiateUserFiatOnrampBodyDestination- Initiate
User Fiat Onramp Body Source InitiateUserFiatOnrampBodySource- Intent
Authorization - Authorization quorum for an intent
- Intent
Authorize Input - Request body for authorizing an intent.
- Intent
Authorized Webhook Payload - Payload for the intent.authorized webhook event.
- Intent
Binding - A binding that scopes a user signing key to a specific intent.
- Intent
Created Webhook Payload - Payload for the intent.created webhook event.
- Intent
Creation Headers - Headers required to create an intent.
- Intent
Executed Webhook Payload - Payload for the intent.executed webhook event.
- Intent
Failed Webhook Payload - Payload for the intent.failed webhook event.
- Intent
Rejected Webhook Payload - Payload for the intent.rejected webhook event.
- KeyQuorum
- A key quorum for authorizing wallet operations.
- KeyQuorum
Authorization Headers - Headers required to authorize modifications to key quorums.
- KeyQuorum
Authorization Keys Item KeyQuorumAuthorizationKeysItem- KeyQuorum
Authorization Keys Item Display Name KeyQuorumAuthorizationKeysItemDisplayName- KeyQuorum
Create Request Body - Request input for creating a key quorum. At least one of
user_ids,public_keys, orkey_quorum_idsis required. - KeyQuorum
Create Request Body Display Name KeyQuorumCreateRequestBodyDisplayName- KeyQuorum
Display Name KeyQuorumDisplayName- KeyQuorum
Id - A unique identifier for a key quorum.
- KeyQuorum
Intent Response - Response for a key quorum intent
- KeyQuorum
Intent Response Request Details - The original key quorum update request that would be sent to the key quorum endpoint
- KeyQuorum
Update Request Body - Request input for updating an existing key quorum. At least one field must be provided.
- KeyQuorum
Update Request Body Display Name KeyQuorumUpdateRequestBodyDisplayName- Kraken
Embed Cancel Custom Order Input - Request body for cancelling a custom order.
- Kraken
Embed Cancel Custom Order Input User Id KrakenEmbedCancelCustomOrderInputUserId- Kraken
Embed Cancel Custom Order Path - Path parameters for cancelling a custom order.
- Kraken
Embed Cancel Custom Order Path Order Id KrakenEmbedCancelCustomOrderPathOrderId- Kraken
Embed Cancel Custom Order Response - Response body for cancelling a custom order.
- Kraken
Embed Cancel Custom Order Result - Result payload for cancel custom order response.
- Kraken
Embed Create Custom Order Input - Request body for creating a custom order.
- Kraken
Embed Create Custom Order Input User Id KrakenEmbedCreateCustomOrderInputUserId- Kraken
Embed Create Custom Order Response - Response body for creating a custom order.
- Kraken
Embed Create Custom Order Result - Result payload for create custom order response.
- Kraken
Embed Current DayPnl - Current day profit and loss for a portfolio, calculated from the most recent available balance.
- Kraken
Embed Current DayPnl Pnl KrakenEmbedCurrentDayPnlPnl- Kraken
Embed Custom Order - Full custom order object.
- Kraken
Embed Custom Order Action - Trade action for a custom order.
- Kraken
Embed Custom Order Action FeeBps KrakenEmbedCustomOrderActionFeeBps- Kraken
Embed Custom Order Action Spread Bps KrakenEmbedCustomOrderActionSpreadBps- Kraken
Embed Custom Order Amount - Asset amount for custom order actions.
- Kraken
Embed Custom Order Amount Amount KrakenEmbedCustomOrderAmountAmount- Kraken
Embed Custom Order Cancelled Webhook Payload - Payload for the kraken_embed.custom_order.cancelled webhook event.
- Kraken
Embed Custom Order Executed Webhook Payload - Payload for the kraken_embed.custom_order.executed webhook event.
- Kraken
Embed Custom Order Execution Failed Webhook Payload - Payload for the kraken_embed.custom_order.execution_failed webhook event.
- Kraken
Embed Custom Order Occurrence - A single execution occurrence of a custom order.
- Kraken
Embed Custom Order Occurrence Executed Action - Executed action details for a custom order occurrence.
- Kraken
Embed Custom Order Occurrence Trigger - Trigger metadata for a custom order occurrence.
- Kraken
Embed Custom Order Quote Asset - Target asset for the other side of the custom order trade.
- Kraken
Embed Custom Order Status - Custom order status with optional reason for cancelled or paused states.
- Kraken
Embed Custom Order Trigger - Price trigger for a custom order. The order executes when base_asset/quote_asset rate meets the condition against target_price.
- Kraken
Embed Custom Order Trigger Target Price KrakenEmbedCustomOrderTriggerTargetPrice- Kraken
Embed Earn Amount - An earn amount with native and converted values.
- Kraken
Embed Earn Amount Converted KrakenEmbedEarnAmountConverted- Kraken
Embed Earn Amount Native KrakenEmbedEarnAmountNative- Kraken
Embed Earn AprEstimate - Low and high estimate of the yield of an earn asset.
- Kraken
Embed Earn AprEstimate High KrakenEmbedEarnAprEstimateHigh- Kraken
Embed Earn AprEstimate Low KrakenEmbedEarnAprEstimateLow- Kraken
Embed Earn Asset - A single asset that can yield rewards.
- Kraken
Embed Earn User Allocation - User allocation for an earn asset.
- Kraken
Embed GetAsset List Query Params Schema - Query parameters for listing and filtering available assets.
- Kraken
Embed GetAsset List Query Params Schema Filter Assets Item KrakenEmbedGetAssetListQueryParamsSchemaFilterAssetsItem- Kraken
Embed GetAsset List Query Params Schema Lang KrakenEmbedGetAssetListQueryParamsSchemaLang- Kraken
Embed GetAsset List Query Params Schema Quote KrakenEmbedGetAssetListQueryParamsSchemaQuote- Kraken
Embed GetCustom Order History Query Params - Query parameters for getting custom order history.
- Kraken
Embed GetCustom Order History Query Params Order Id KrakenEmbedGetCustomOrderHistoryQueryParamsOrderId- Kraken
Embed GetCustom Order History Query Params User Id KrakenEmbedGetCustomOrderHistoryQueryParamsUserId- Kraken
Embed GetCustom Order History Response - Response body for getting custom order execution history.
- Kraken
Embed GetCustom Order History Result - Result payload for custom order history response.
- Kraken
Embed GetCustom Order Query Params - Query parameters for getting a single custom order.
- Kraken
Embed GetCustom Order Query Params Order Id KrakenEmbedGetCustomOrderQueryParamsOrderId- Kraken
Embed GetCustom Order Query Params User Id KrakenEmbedGetCustomOrderQueryParamsUserId- Kraken
Embed GetCustom Order Response - Response body for getting a single custom order.
- Kraken
Embed GetCustom Order Result - Result payload for get custom order response.
- Kraken
Embed GetEarn Assets Kraken Response - Kraken API response envelope for earn assets.
- Kraken
Embed GetEarn Assets Query Params - Query parameters for listing earn assets.
- Kraken
Embed GetEarn Assets Query Params Assets Item KrakenEmbedGetEarnAssetsQueryParamsAssetsItem- Kraken
Embed GetEarn Assets Query Params Currency KrakenEmbedGetEarnAssetsQueryParamsCurrency- Kraken
Embed GetEarn Assets Query Params User KrakenEmbedGetEarnAssetsQueryParamsUser- Kraken
Embed GetEarn Assets Response - List of earn assets with APR estimates and optional user allocations.
- Kraken
Embed GetEarn Assets Result - Result payload for earn assets response.
- Kraken
Embed GetEarn Summary Kraken Response - Kraken API response envelope for earn summary.
- Kraken
Embed GetEarn Summary Query Params - Query parameters for getting an earn summary.
- Kraken
Embed GetEarn Summary Query Params Currency KrakenEmbedGetEarnSummaryQueryParamsCurrency- Kraken
Embed GetEarn Summary Response - Earn summary for a user including Auto-Earn status, total rewards, and upcoming payouts.
- Kraken
Embed GetEarn Summary Result - Result payload for earn summary response.
- Kraken
Embed GetEarn Summary Result Total Allocated Converted KrakenEmbedGetEarnSummaryResultTotalAllocatedConverted- Kraken
Embed GetEarn Summary Result Total Rewarded Converted Current Rate KrakenEmbedGetEarnSummaryResultTotalRewardedConvertedCurrentRate- Kraken
Embed GetEarn Summary Result Total Rewarded Converted True Rates KrakenEmbedGetEarnSummaryResultTotalRewardedConvertedTrueRates- Kraken
Embed GetPortfolio Details Query Params Schema - Query parameters for portfolio details endpoint.
- Kraken
Embed GetPortfolio Details Query Params Schema Quote KrakenEmbedGetPortfolioDetailsQueryParamsSchemaQuote- Kraken
Embed GetPortfolio Summary Query Params - Query parameters for getting a portfolio summary.
- Kraken
Embed GetPortfolio Summary Query Params Quote KrakenEmbedGetPortfolioSummaryQueryParamsQuote- Kraken
Embed GetPortfolio Summary Response - High-level summary of a user’s portfolio including total value, available balance, and unrealized P&L.
- Kraken
Embed GetPortfolio Summary Response Data KrakenEmbedGetPortfolioSummaryResponseData- Kraken
Embed GetPortfolio Summary Response Data Result KrakenEmbedGetPortfolioSummaryResponseDataResult- Kraken
Embed GetPortfolio Summary Response Data Result Available Balance KrakenEmbedGetPortfolioSummaryResponseDataResultAvailableBalance- Kraken
Embed GetPortfolio Summary Response Data Result Cost Basis KrakenEmbedGetPortfolioSummaryResponseDataResultCostBasis- Kraken
Embed GetPortfolio Summary Response Data Result Currency KrakenEmbedGetPortfolioSummaryResponseDataResultCurrency- Kraken
Embed GetPortfolio Summary Response Data Result Lots Upnl KrakenEmbedGetPortfolioSummaryResponseDataResultLotsUpnl- Kraken
Embed GetPortfolio Summary Response Data Result Open Orders KrakenEmbedGetPortfolioSummaryResponseDataResultOpenOrders- Kraken
Embed GetPortfolio Summary Response Data Result Portfolio Value KrakenEmbedGetPortfolioSummaryResponseDataResultPortfolioValue- Kraken
Embed GetPortfolio Summary Response Data Result Withheld Value KrakenEmbedGetPortfolioSummaryResponseDataResultWithheldValue- Kraken
Embed GetPortfolio Transactions Query Params Schema - Query parameters for filtering and paginating portfolio transactions.
- Kraken
Embed GetPortfolio Transactions Query Params Schema Assets Item KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaAssetsItem- Kraken
Embed GetPortfolio Transactions Query Params Schema Quote KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaQuote- Kraken
Embed GetPortfolio Transactions Query Params Schema RefIds Item KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaRefIdsItem- Kraken
Embed GetPortfolio Transactions Query Params Schema RefIds Item RefId KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaRefIdsItemRefId- Kraken
Embed GetQuote Query Params - Query parameters for getting a quote status.
- Kraken
Embed GetQuote Query Params User Id - The ID of the Privy user.
- Kraken
Embed List Custom Orders Query Params - Query parameters for listing custom orders.
- Kraken
Embed List Custom Orders Query Params User Id KrakenEmbedListCustomOrdersQueryParamsUserId- Kraken
Embed List Custom Orders Response - Response body for listing custom orders.
- Kraken
Embed List Custom Orders Result - Result payload for list custom orders response.
- Kraken
Embed Quote Cancelled Webhook Payload - Payload for the kraken_embed.quote.cancelled webhook event.
- Kraken
Embed Quote Executed Webhook Payload - Payload for the kraken_embed.quote_executed webhook event.
- Kraken
Embed Quote Execution Failed Webhook Payload - Payload for the kraken_embed.quote.execution_failed webhook event.
- Kraken
Embed Start Address Metadata - Optional best-effort metadata hints for proof of address verification.
- Kraken
Embed Start Address Metadata Address KrakenEmbedStartAddressMetadataAddress- Kraken
Embed Start Address Verification UrlInput - Input payload for starting proof of address verification via URL.
- Kraken
Embed Start Identity Info - Identity information hints including full name and date of birth for proof of identity verification.
- Kraken
Embed Start Identity Info Full Name KrakenEmbedStartIdentityInfoFullName- Kraken
Embed Start Identity Metadata - Optional best-effort metadata hints for proof of identity verification.
- Kraken
Embed Start Identity Verification UrlInput - Input payload for starting proof of identity verification via URLs.
- Kraken
Embed Start Liveness Verification UrlInput - Input payload for starting proof of liveness verification via URLs.
- Kraken
Embed Start Verification Debug - Debug options for start verification. Only works in non-production environments.
- Kraken
Embed Start Verification UrlResponse - Response body for starting verification via URL.
- Kraken
Embed Start Verification UrlResult - Result payload for start verification URL response.
- Kraken
Embed Toggle Auto Earn Kraken Response - Kraken API response envelope for toggle auto-earn. Result is null on success.
- Kraken
Embed Toggle Auto Earn Query Params - Query parameters for toggling Auto-Earn.
- Kraken
Embed Toggle Auto Earn Response - Response from toggling Auto-Earn. The response body is empty on success.
- Kraken
Embed Upcoming Reward - An upcoming earn reward for a specific asset.
- Kraken
Embed User Closed Webhook Payload - Payload for the kraken_embed.user.closed webhook event.
- Kraken
Embed User Disabled Webhook Payload - Payload for the kraken_embed.user.disabled webhook event.
- Kraken
Embed User Verified Webhook Payload - Payload for the kraken_embed.user.verified webhook event.
- Link
Auth Intent Created - Auth intent created. Pass id to authenticate().
- Link
Auth Intent NoAccount - No Link account for this email. Call registerLinkUser() then retry.
- Link
JwtInput - Input for linking a custom JWT account.
- Linked
Account Apple Input - The payload for importing an Apple account.
- Linked
Account Apple Input Subject LinkedAccountAppleInputSubject- Linked
Account Apple Oauth - An Apple OAuth account linked to the user.
- Linked
Account Authorization Key - An authorization key linked to the user.
- Linked
Account Base Wallet - Base schema for wallet accounts linked to the user.
- Linked
Account Bitcoin Segwit Embedded Wallet - A Bitcoin SegWit embedded wallet account linked to the user.
- Linked
Account Bitcoin Taproot Embedded Wallet - A Bitcoin Taproot embedded wallet account linked to the user.
- Linked
Account Cross App - A cross-app account linked to the user.
- Linked
Account Curve Signing Embedded Wallet - A curve signing embedded wallet account linked to the user.
- Linked
Account Custom Jwt - A custom JWT account linked to the user.
- Linked
Account Custom JwtInput - The payload for importing a Custom JWT account.
- Linked
Account Custom JwtInput Custom User Id LinkedAccountCustomJwtInputCustomUserId- Linked
Account Custom Oauth - A custom OAuth account linked to the user.
- Linked
Account Discord Input - The payload for importing a Discord account.
- Linked
Account Discord Input Subject LinkedAccountDiscordInputSubject- Linked
Account Discord Input Username LinkedAccountDiscordInputUsername- Linked
Account Discord Oauth - A Discord OAuth account linked to the user.
- Linked
Account Email - An email account linked to the user.
- Linked
Account Email Input - The payload for importing an email account.
- Linked
Account Ethereum - An Ethereum wallet account linked to the user.
- Linked
Account Ethereum Embedded Wallet - An Ethereum embedded wallet account linked to the user.
- Linked
Account Farcaster - A Farcaster account linked to the user.
- Linked
Account Farcaster Input - The payload for importing a Farcaster account.
- Linked
Account Farcaster Input Bio LinkedAccountFarcasterInputBio- Linked
Account Farcaster Input Display Name LinkedAccountFarcasterInputDisplayName- Linked
Account Farcaster Input Homepage Url LinkedAccountFarcasterInputHomepageUrl- Linked
Account Farcaster Input Profile Picture Url LinkedAccountFarcasterInputProfilePictureUrl- Linked
Account Farcaster Input Username LinkedAccountFarcasterInputUsername- Linked
Account Github Input - The payload for importing a Github account.
- Linked
Account Github Input Subject LinkedAccountGithubInputSubject- Linked
Account Github Input Username LinkedAccountGithubInputUsername- Linked
Account Github Oauth - A GitHub OAuth account linked to the user.
- Linked
Account Google Input - The payload for importing a Google account.
- Linked
Account Google Input Subject LinkedAccountGoogleInputSubject- Linked
Account Google Oauth - A Google OAuth account linked to the user.
- Linked
Account Instagram Input - The payload for importing an Instagram account.
- Linked
Account Instagram Input Subject LinkedAccountInstagramInputSubject- Linked
Account Instagram Input Username LinkedAccountInstagramInputUsername- Linked
Account Instagram Oauth - An Instagram OAuth account linked to the user.
- Linked
Account Line Input - The payload for importing a LINE account.
- Linked
Account Line Input Name LinkedAccountLineInputName- Linked
Account Line Input Subject LinkedAccountLineInputSubject- Linked
Account Line Oauth - A LINE OAuth account linked to the user.
- Linked
Account Linked InInput - The payload for importing a LinkedIn account.
- Linked
Account Linked InInput Subject LinkedAccountLinkedInInputSubject- Linked
Account Linked InOauth - A LinkedIn OAuth account linked to the user.
- Linked
Account Passkey - A passkey account linked to the user.
- Linked
Account Passkey Input - The payload for importing a passkey account.
- Linked
Account Passkey Input Credential Id LinkedAccountPasskeyInputCredentialId- Linked
Account Passkey Input Credential Public Key LinkedAccountPasskeyInputCredentialPublicKey- Linked
Account Passkey Input Credential Username LinkedAccountPasskeyInputCredentialUsername- Linked
Account Phone - A phone number account linked to the user.
- Linked
Account Phone Input - The payload for importing a phone account.
- Linked
Account Smart Wallet - A smart wallet account linked to the user.
- Linked
Account Solana - A Solana wallet account linked to the user.
- Linked
Account Solana Embedded Wallet - A Solana embedded wallet account linked to the user.
- Linked
Account Spotify Input - The payload for importing a Spotify account.
- Linked
Account Spotify Oauth - A Spotify OAuth account linked to the user.
- Linked
Account Telegram - A Telegram account linked to the user.
- Linked
Account Telegram Input - The payload for importing a Telegram account.
- Linked
Account Telegram Input First Name LinkedAccountTelegramInputFirstName- Linked
Account Telegram Input Last Name LinkedAccountTelegramInputLastName- Linked
Account Telegram Input Photo Url LinkedAccountTelegramInputPhotoUrl- Linked
Account Telegram Input Telegram User Id LinkedAccountTelegramInputTelegramUserId- Linked
Account Telegram Input Username LinkedAccountTelegramInputUsername- Linked
Account Tiktok Input - The payload for importing a Tiktok account.
- Linked
Account Tiktok Input Name LinkedAccountTiktokInputName- Linked
Account Tiktok Input Subject LinkedAccountTiktokInputSubject- Linked
Account Tiktok Input Username LinkedAccountTiktokInputUsername- Linked
Account Tiktok Oauth - A TikTok OAuth account linked to the user.
- Linked
Account Twitch Input - The payload for importing a Twitch account.
- Linked
Account Twitch Input Subject LinkedAccountTwitchInputSubject- Linked
Account Twitch Input Username LinkedAccountTwitchInputUsername- Linked
Account Twitch Oauth - A Twitch OAuth account linked to the user.
- Linked
Account Twitter Input - The payload for importing a Twitter account.
- Linked
Account Twitter Input Name LinkedAccountTwitterInputName- Linked
Account Twitter Input Subject LinkedAccountTwitterInputSubject- Linked
Account Twitter Input Username LinkedAccountTwitterInputUsername- Linked
Account Twitter Oauth - A Twitter OAuth account linked to the user.
- Linked
Account Wallet Input - The payload for importing a wallet account.
- List
Accounts Cursor ListAccountsCursor- List
Asset Rates Asset Id - The asset identifier (e.g., BTC, ETH)
- List
Asset Rates Quote ListAssetRatesQuote- List
Asset Rates Response ListAssetRatesResponse- List
Asset Rates Response Data ListAssetRatesResponseData- List
Asset Rates Response Data Result ListAssetRatesResponseDataResult- List
Asset Rates Response Data Result Meta ListAssetRatesResponseDataResultMeta- List
Asset Rates Response Data Result Meta Page Newest Rate ListAssetRatesResponseDataResultMetaPageNewestRate- List
Asset Rates Response Data Result Meta Page Newest Rate Price ListAssetRatesResponseDataResultMetaPageNewestRatePrice- List
Asset Rates Response Data Result Meta Page Oldest Rate ListAssetRatesResponseDataResultMetaPageOldestRate- List
Asset Rates Response Data Result Meta Page Oldest Rate Price ListAssetRatesResponseDataResultMetaPageOldestRatePrice- List
Asset Rates Response Data Result Meta Page Price Change Percent ListAssetRatesResponseDataResultMetaPagePriceChangePercent- List
Asset Rates Response Data Result Meta Page Price Change Value ListAssetRatesResponseDataResultMetaPagePriceChangeValue- List
Asset Rates Response Data Result Rates Item ListAssetRatesResponseDataResultRatesItem- List
Asset Rates Response Data Result Rates Item Price ListAssetRatesResponseDataResultRatesItemPrice- List
Assets Filter Assets Item ListAssetsFilterAssetsItem- List
Assets Lang ListAssetsLang- List
Assets Quote ListAssetsQuote- List
Assets Response ListAssetsResponse- List
Assets Response Data ListAssetsResponseData- List
Assets Response Data Result ListAssetsResponseDataResult- List
Assets Response Data Result Assets Item ListAssetsResponseDataResultAssetsItem- List
Assets Response Data Result Assets Item AthValue ListAssetsResponseDataResultAssetsItemAthValue- List
Assets Response Data Result Assets Item Change Percent1h ListAssetsResponseDataResultAssetsItemChangePercent1h- List
Assets Response Data Result Assets Item Change Percent1y ListAssetsResponseDataResultAssetsItemChangePercent1y- List
Assets Response Data Result Assets Item Change Percent7d ListAssetsResponseDataResultAssetsItemChangePercent7d- List
Assets Response Data Result Assets Item Change Percent24h ListAssetsResponseDataResultAssetsItemChangePercent24h- List
Assets Response Data Result Assets Item Change Percent30d ListAssetsResponseDataResultAssetsItemChangePercent30d- List
Assets Response Data Result Assets Item Circulating Supply ListAssetsResponseDataResultAssetsItemCirculatingSupply- List
Assets Response Data Result Assets Item Circulating Supply Value ListAssetsResponseDataResultAssetsItemCirculatingSupplyValue- List
Assets Response Data Result Assets Item Disabled Against Item ListAssetsResponseDataResultAssetsItemDisabledAgainstItem- List
Assets Response Data Result Assets Item Id ListAssetsResponseDataResultAssetsItemId- List
Assets Response Data Result Assets Item Links ListAssetsResponseDataResultAssetsItemLinks- List
Assets Response Data Result Assets Item Links Logo ListAssetsResponseDataResultAssetsItemLinksLogo- List
Assets Response Data Result Assets Item Links Self ListAssetsResponseDataResultAssetsItemLinksSelf- List
Assets Response Data Result Assets Item Market CapValue ListAssetsResponseDataResultAssetsItemMarketCapValue- List
Assets Response Data Result Assets Item MaxSupply ListAssetsResponseDataResultAssetsItemMaxSupply- List
Assets Response Data Result Assets Item MaxSupply Value ListAssetsResponseDataResultAssetsItemMaxSupplyValue- List
Assets Response Data Result Assets Item Price ListAssetsResponseDataResultAssetsItemPrice- List
Assets Response Data Result Assets Item Total Supply ListAssetsResponseDataResultAssetsItemTotalSupply- List
Assets Response Data Result Assets Item Total Supply Value ListAssetsResponseDataResultAssetsItemTotalSupplyValue- List
Assets Response Data Result Assets Item Volume Value24h ListAssetsResponseDataResultAssetsItemVolumeValue24h- List
Assets Response Data Result Links ListAssetsResponseDataResultLinks- List
Assets Response Data Result Meta ListAssetsResponseDataResultMeta- List
Custom Orders Response ListCustomOrdersResponse- List
Earn Assets Assets Item ListEarnAssetsAssetsItem- List
Earn Assets Currency ListEarnAssetsCurrency- List
Earn Assets User ListEarnAssetsUser- List
Intents Cursor ListIntentsCursor- List
Intents Response ListIntentsResponse- List
Organization Secrets Account Id ListOrganizationSecretsAccountId- List
Stripe Consumer Wallets Response - List of registered wallets for a crypto customer.
- List
Stripe Payment Tokens Response - List of payment tokens for a crypto customer.
- Look
UpUser ByCustom Auth IdBody LookUpUserByCustomAuthIdBody- Look
UpUser ByDiscord Username Body LookUpUserByDiscordUsernameBody- Look
UpUser ByEmail Body LookUpUserByEmailBody- Look
UpUser ByFarcaster IdBody LookUpUserByFarcasterIdBody- Look
UpUser ByGithub Username Body LookUpUserByGithubUsernameBody- Look
UpUser ByPhone Number Body LookUpUserByPhoneNumberBody- Look
UpUser BySmart Wallet Address Body LookUpUserBySmartWalletAddressBody- Look
UpUser ByTelegram User IdBody LookUpUserByTelegramUserIdBody- Look
UpUser ByTelegram Username Body LookUpUserByTelegramUsernameBody- Look
UpUser ByTwitter Subject Body LookUpUserByTwitterSubjectBody- Look
UpUser ByTwitter Username Body LookUpUserByTwitterUsernameBody- Look
UpUser ByWallet Address Body LookUpUserByWalletAddressBody- MfaDisabled
Webhook Payload - Payload for the mfa.disabled webhook event.
- MfaEnabled
Webhook Payload - Payload for the mfa.enabled webhook event.
- MfaPasskey
Enrollment Request Body - The request body for enrolling a passkey MFA flow.
- MfaPasskey
Init Request Body - The request body for initiating a passkey MFA flow.
- MfaPasskey
Init Response Body - The response body for initializing a passkey MFA flow.
- MfaPasskey
Verify Request Body - The request body for verifying a passkey MFA flow.
- MfaSms
Enroll Request Body - The request body for enrolling a SMS MFA code.
- MfaSms
Enroll Request Body Code MfaSmsEnrollRequestBodyCode- MfaSms
Init Enroll Input - Input for enrolling SMS MFA.
- MfaSms
Init Verify Input - Input for verifying SMS MFA.
- MfaSms
Verify Request Body - The request body for verifying a SMS MFA code.
- MfaSms
Verify Request Body Code MfaSmsVerifyRequestBodyCode- MfaTotp
Init Response Body - The response body for initializing a TOTP MFA code.
- MfaTotp
Input - The input for verifying a TOTP MFA code.
- MfaTotp
Input Code MfaTotpInputCode- MfaVerify
Response Body - The response body for verifying a MFA code.
- Moonpay
Fiat OnRamp Ethereum Config - Configuration for a Moonpay fiat on-ramp for an Ethereum-compatible chain.
- Moonpay
Fiat OnRamp Ethereum Input - Input for a Moonpay fiat on-ramp for an Ethereum-compatible chain.
- Moonpay
Fiat OnRamp Solana Config - Configuration for a Moonpay fiat on-ramp for Solana.
- Moonpay
Fiat OnRamp Solana Input - Input for a Moonpay fiat on-ramp for Solana.
- Moonpay
OnRamp Sandbox Config - Sandbox configuration for a Moonpay on-ramp.
- Moonpay
OnRamp Sign Response - The response from signing a Moonpay on-ramp.
- Moonpay
UiConfig - UI configuration for the Moonpay on-ramp widget.
- Named
Token Transfer Source - Source for a transfer identified by a named asset (e.g. “usdc”, “eth”). Use this variant for first-class assets maintained by Privy.
- Named
Token Transfer Source Amount - Amount as a decimal string in the token’s standard unit (e.g. “1.5” for 1.5 USDC, “0.01” for 0.01 ETH). Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100 characters.
- OAuth
Authenticate Recovery Response - The response from authenticating with OAuth for recovery.
- OAuth
Authenticate Request Body - The request body for authenticating an OAuth account.
- OAuth
Authenticate Request Body Code Verifier OAuthAuthenticateRequestBodyCodeVerifier- OAuth
Authorization Code Request Body - The request body for getting an OAuth authorization code.
- OAuth
CallbackI Cloud Expo Input - The input for the iCloud Expo OAuth callback.
- OAuth
Grant - An active OAuth grant representing an authorized session.
- OAuth
Grant List Response - List of active OAuth grants for the authenticated user.
- OAuth
Grant Revoke Response - Response from revoking an OAuth grant.
- OAuth
InitI Cloud Recovery Input - The input for initiating an iCloud OAuth recovery flow.
- OAuth
Init Recovery Input - The input for initiating an OAuth recovery flow.
- OAuth
Init Request Body - The request body for initiating an OAuth ceremony.
- OAuth
Init Response Body - The response for initiating an OAuth ceremony.
- OAuth
Link Request Body - The request body for linking an OAuth account.
- OAuth
Link Request Body Code Verifier OAuthLinkRequestBodyCodeVerifier- OAuth
Link Response Body - The response for linking an OAuth account.
- OAuth
Token Authorization Code Request Body - Request body for the authorization_code grant type.
- OAuth
Token Device Code Pending Error - Error response returned while the device authorization is still pending (RFC 8628 Section 3.5).
- OAuth
Token Device Code Request Body - Request body for the urn:ietf:params:oauth:grant-type:device_code grant type (RFC 8628). Used by CLI clients to poll for authorization.
- OAuth
Token Refresh Token Request Body - Request body for the refresh_token grant type. Rotates the refresh token and issues a new access token.
- OAuth
Token Success Response - Successful token response per RFC 6749 Section 5.1.
- OAuth
Tokens - OAuth tokens associated with the user.
- OAuth
Transfer Request Body - The request body for transferring an OAuth account.
- OAuth
Transfer User Info - User info for an OAuth transfer.
- OAuth
Transfer User Info Meta - Metadata for an OAuth transfer user info.
- OAuth
Unlink Request Body - The request body for unlinking an OAuth account.
- OAuth
Verify Request Body - The request body for verifying a PRAT.
- OAuth
Verify Response Body - The response body when verifying a PRAT.
- Offramp
Deposit Instructions - Deposit instructions for an offramp transfer.
- Offramp
Response - Response for an offramp transfer initiation.
- Onramp
Deposit Instructions - Bank deposit instructions for an onramp transfer.
- Onramp
KycResponse - Response for an onramp KYC verification.
- Onramp
Response - Response for an onramp transfer initiation.
- Onramp
Session Fees - Fee breakdown for a Stripe onramp transaction.
- Onramp
Session Params - Parameters for creating a Stripe onramp session.
- Onramp
Session Params Crypto Customer Id OnrampSessionParamsCryptoCustomerId- Onramp
Session Params Destination Network OnrampSessionParamsDestinationNetwork- Onramp
Session Params Payment Token OnrampSessionParamsPaymentToken- Onramp
Session Params Source Amount OnrampSessionParamsSourceAmount- Onramp
Session Params Wallet Address OnrampSessionParamsWalletAddress- Onramp
Session Transaction Details - Transaction details returned from a Stripe onramp session.
- Optional
Refresh Token Input - The input for refreshing a session or logging out.
- Organization
Secret IdInput - Request body for targeting a specific organization secret.
- Organization
Secret IdInput Secret Id - The organization secret ID.
- Organization
Secret View - View of an organization secret for list and management endpoints.
- Organization
Secrets List Response - Response returned when listing organization secrets for an account.
- Output
With Previous Transaction Data - A Spark token output with its previous transaction data.
- Owner
IdInput - The key quorum ID to set as the owner of the resource. If you provide this, do not specify an owner.
- Owner
Input Public Key - Owner input specifying a P-256 public key.
- Owner
Input User - Owner input specifying a Privy user ID.
- P256
Public Key - A P-256 (secp256r1) public key.
- Passkey
Assertion Response - The authenticator assertion response from a WebAuthn authentication ceremony.
- Passkey
Attestation Response - The authenticator attestation response from a WebAuthn registration ceremony.
- Passkey
Authenticate Input - Input for authenticating with a passkey.
- Passkey
Authenticator Enrollment Options - WebAuthn registration options as defined by the Web Authentication specification.
- Passkey
Authenticator Enrollment Response - WebAuthn registration response as defined by the Web Authentication specification.
- Passkey
Authenticator Selection - Authenticator selection criteria for a WebAuthn registration ceremony.
- Passkey
Authenticator Verify Options - WebAuthn authentication options as defined by the Web Authentication specification.
- Passkey
Authenticator Verify Response - WebAuthn authentication response as defined by the Web Authentication specification.
- Passkey
Client Extension Results - Client extension results returned by the WebAuthn authenticator.
- Passkey
Cred Props Result - The result of the WebAuthn credProps extension.
- Passkey
Credential Descriptor - A WebAuthn credential descriptor identifying a specific public key credential.
- Passkey
Enrollment Extensions - Extensions for a WebAuthn registration ceremony.
- Passkey
Init Input - Input for initiating a passkey ceremony.
- Passkey
Link Input - Input for linking a passkey credential.
- Passkey
MfaMethod - A Passkey MFA method.
- Passkey
PubKey Cred Param - A public key credential parameter specifying the algorithm and credential type.
- Passkey
Register Input - Input for registering a passkey credential.
- Passkey
Relying Party - Relying party information for a WebAuthn ceremony.
- Passkey
User - User entity for a WebAuthn registration ceremony.
- Passkey
Verify Extensions - Extensions for a WebAuthn authentication ceremony.
- Passwordless
Authenticate Request Body - The request body for authenticating a passwordless account.
- Passwordless
Authenticate Request Body Code PasswordlessAuthenticateRequestBodyCode- Passwordless
Init Request Body - The request body for initiating a passwordless ceremony.
- Passwordless
Link Request Body - The request body for linking a passwordless account.
- Passwordless
Link Request Body Code PasswordlessLinkRequestBodyCode- Passwordless
SmsAuthenticate Request Body - The request body for authenticating a passwordless sms account.
- Passwordless
SmsAuthenticate Request Body Code PasswordlessSmsAuthenticateRequestBodyCode- Passwordless
SmsInit Request Body - The request body for initiating a passwordless sms ceremony.
- Passwordless
SmsLink Request Body - The request body for linking a passwordless sms account.
- Passwordless
SmsLink Request Body Code PasswordlessSmsLinkRequestBodyCode- Passwordless
SmsTransfer Request Body - The request body for transferring a passwordless sms account.
- Passwordless
SmsUnlink Request Body - The request body for unlinking a passwordless sms account.
- Passwordless
SmsUpdate Request Body - The request body for updating a passwordless sms account.
- Passwordless
SmsUpdate Request Body Code PasswordlessSmsUpdateRequestBodyCode- Passwordless
Transfer Request Body - The request body for transferring a passwordless account.
- Passwordless
Unlink Request Body - The request body for unlinking a passwordless account.
- Passwordless
Update Request Body - The request body for updating a passwordless account.
- Passwordless
Update Request Body Code PasswordlessUpdateRequestBodyCode- Patch
Users Custom Metadata - The payload for partially updating custom metadata on a user.
- Phone
Invite Input - Allowlist invite input for a phone number.
- Policy
- A policy for controlling wallet operations.
- Policy
Authorization Headers - Headers required to authorize modifications to policies.
- Policy
Id - Unique ID of the created policy. This will be the primary identifier when using the policy in the future.
- Policy
Input - An optional list of up to one policy ID to enforce on the wallet.
- Policy
Intent Request Details - Request details for a policy intent.
- Policy
Intent Request Details Body PolicyIntentRequestDetailsBody- Policy
Intent Request Details Body Name - Name to assign to policy.
- Policy
Intent Request Details Url PolicyIntentRequestDetailsUrl- Policy
Intent Response - Response for a policy intent
- Policy
Intent Response Request Details - The original policy update request that would be sent to the policy endpoint
- Policy
Intent Response Request Details Body PolicyIntentResponseRequestDetailsBody- Policy
Intent Response Request Details Body Name - Name to assign to policy.
- Policy
Name - Name to assign to policy.
- Policy
Request Body - Unique ID of the policy to take actions on.
- Policy
Request Body Policy Id PolicyRequestBodyPolicyId- Policy
Rule Request Body - The rules that apply to each method the policy covers.
- Policy
Rule Request Body Name PolicyRuleRequestBodyName- Policy
Rule Request Params - Unique IDs of the policy and the rule within the policy to take actions on.
- Policy
Rule Request Params Policy Id PolicyRuleRequestParamsPolicyId- Policy
Rule Request Params Rule Id PolicyRuleRequestParamsRuleId- Policy
Rule Response - A rule that defines the conditions and action to take if the conditions are true.
- Policy
Rule Response Name PolicyRuleResponseName- Private
KeyExport Input - Input for exporting a wallet (private key or seed phrase) with HPKE encryption.
- Private
KeyExport Response - Response containing HPKE-encrypted wallet data (private key or seed phrase).
- Private
KeyExport Webhook Payload - Payload for the wallet.private_key_export webhook event.
- Private
KeyInit Input - The input for private key wallets.
- Private
KeySubmit Input - The submission input for importing a private key wallet.
- Privy
Fee - Estimated fee paid to Privy.
- PrivyO
Auth Provider Id - The ID of a Privy app as an OAuth provider. Must start with “privy:”.
- RawBound
Authenticate Response - Unencrypted response from bound wallet authentication, with bindings.
- RawSign
Bytes Params - Parameters for hashing and signing bytes with the
raw_signRPC. - RawSign
Bytes Params Bytes - The bytes to hash and sign.
- RawSign
Hash Params - Parameters for signing a pre-computed hash with the
raw_signRPC. - RawSign
Input - Provide either
hash(to sign a pre-computed hash) ORbytes,encoding, andhash_function(to hash and then sign). These options are mutually exclusive. - RawSign
Response - Response to the
raw_signRPC. - RawSign
Response Data - Data returned by the
raw_signRPC. - Recipient
Public KeyVariant0 RecipientPublicKeyVariant0- Recipient
Public KeyVariant1 RecipientPublicKeyVariant1- Recovery
ConfigurationI Cloud Input - The input for getting the iCloud recovery configuration.
- Recovery
ConfigurationI Cloud Response - The response containing the iCloud recovery configuration.
- Recovery
KeyMaterial Input - The input for getting the recovery key material.
- Recovery
KeyMaterial Response - The response containing the recovery key material.
- Refresh
Stripe Quote Response - Refreshed quote with new expiry.
- Relayer
Fee - Estimated fee paid to the relayer.
- Request
Quote Body RequestQuoteBody- Request
Quote Body Amount RequestQuoteBodyAmount- Request
Quote Body Amount Amount RequestQuoteBodyAmountAmount- Request
Quote Body Amount Asset RequestQuoteBodyAmountAsset- Request
Quote Body FeeBps RequestQuoteBodyFeeBps- Request
Quote Body Quote RequestQuoteBodyQuote- Request
Quote Body Quote Asset RequestQuoteBodyQuoteAsset- Request
Quote Body Quote Currency RequestQuoteBodyQuoteCurrency- Request
Quote Body Spread Bps RequestQuoteBodySpreadBps- Request
Quote Body User Id RequestQuoteBodyUserId- Request
Quote Response RequestQuoteResponse- Request
Quote Response Data RequestQuoteResponseData- Request
Quote Response Data Result RequestQuoteResponseDataResult- Request
Quote Response Data Result Quoted Receive RequestQuoteResponseDataResultQuotedReceive- Request
Quote Response Data Result Quoted Receive Asset RequestQuoteResponseDataResultQuotedReceiveAsset- Request
Quote Response Data Result Quoted Receive Fee RequestQuoteResponseDataResultQuotedReceiveFee- Request
Quote Response Data Result Quoted Receive Subtotal RequestQuoteResponseDataResultQuotedReceiveSubtotal- Request
Quote Response Data Result Quoted Receive Total RequestQuoteResponseDataResultQuotedReceiveTotal- Request
Quote Response Data Result Quoted Spend RequestQuoteResponseDataResultQuotedSpend- Request
Quote Response Data Result Quoted Spend Asset RequestQuoteResponseDataResultQuotedSpendAsset- Request
Quote Response Data Result Quoted Spend Fee RequestQuoteResponseDataResultQuotedSpendFee- Request
Quote Response Data Result Quoted Spend Subtotal RequestQuoteResponseDataResultQuotedSpendSubtotal- Request
Quote Response Data Result Quoted Spend Total RequestQuoteResponseDataResultQuotedSpendTotal- Request
Quote Response Data Result Quoted Unit Price RequestQuoteResponseDataResultQuotedUnitPrice- Request
Quote Response Data Result Quoted Unit Price Asset RequestQuoteResponseDataResultQuotedUnitPriceAsset- Request
Quote Response Data Result Quoted Unit Price Denomination Asset RequestQuoteResponseDataResultQuotedUnitPriceDenominationAsset- Request
Quote Response Data Result Quoted Unit Price Unit Price RequestQuoteResponseDataResultQuotedUnitPriceUnitPrice- Request
Quote Response Data Result Receive RequestQuoteResponseDataResultReceive- Request
Quote Response Data Result Receive Asset RequestQuoteResponseDataResultReceiveAsset- Request
Quote Response Data Result Receive Fee RequestQuoteResponseDataResultReceiveFee- Request
Quote Response Data Result Receive Subtotal RequestQuoteResponseDataResultReceiveSubtotal- Request
Quote Response Data Result Receive Total RequestQuoteResponseDataResultReceiveTotal- Request
Quote Response Data Result Spend RequestQuoteResponseDataResultSpend- Request
Quote Response Data Result Spend Asset RequestQuoteResponseDataResultSpendAsset- Request
Quote Response Data Result Spend Fee RequestQuoteResponseDataResultSpendFee- Request
Quote Response Data Result Spend Subtotal RequestQuoteResponseDataResultSpendSubtotal- Request
Quote Response Data Result Spend Total RequestQuoteResponseDataResultSpendTotal- Request
Quote Response Data Result Unit Price RequestQuoteResponseDataResultUnitPrice- Request
Quote Response Data Result Unit Price Asset RequestQuoteResponseDataResultUnitPriceAsset- Request
Quote Response Data Result Unit Price Denomination Asset RequestQuoteResponseDataResultUnitPriceDenominationAsset- Request
Quote Response Data Result Unit Price Unit Price RequestQuoteResponseDataResultUnitPriceUnitPrice- Response
Passkey Init Authenticate - Response for initiating a passkey authentication ceremony.
- Response
Passkey Init Link - Response for initiating a passkey link ceremony.
- Response
Passkey Init Register - Response for initiating a passkey registration ceremony.
- Revoke
Organization Secret Account Id RevokeOrganizationSecretAccountId- RpcIntent
Request Details - Request details for an RPC intent.
- RpcIntent
Request Details Url RpcIntentRequestDetailsUrl- RpcIntent
Response - Response for an RPC intent
- RpcIntent
Response Request Details - The original RPC request that would be sent to the wallet endpoint
- Rule
Delete Intent Response - Response for a delete rule intent
- Rule
Intent Create Request Details - Request details for creating a rule via intent.
- Rule
Intent Create Request Details Url RuleIntentCreateRequestDetailsUrl- Rule
Intent Delete Request Details - Request details for deleting a rule via intent.
- Rule
Intent Delete Request Details Url RuleIntentDeleteRequestDetailsUrl- Rule
Intent Response - Response for a rule intent
- Rule
Intent Update Request Details - Request details for updating a rule via intent.
- Rule
Intent Update Request Details Url RuleIntentUpdateRequestDetailsUrl- Rule
Mutate Intent Response - Response for a create or update rule intent
- Seed
Phrase Export Input - Input for exporting a wallet (private key or seed phrase) with HPKE encryption.
- Seed
Phrase Export Response - Response containing HPKE-encrypted wallet data (private key or seed phrase).
- Seed
Phrase Export Webhook Payload - Payload for the wallet.seed_phrase_export webhook event.
- Siwe
Address Input - Input containing a SIWE wallet address.
- Siwe
Authenticate Request Body - The request body for authenticating a SIWE ceremony.
- Siwe
Authenticate Request Body Chain Id SiweAuthenticateRequestBodyChainId- Siwe
Authenticate Request Body Connector Type SiweAuthenticateRequestBodyConnectorType- Siwe
Authenticate Request Body Wallet Client Type SiweAuthenticateRequestBodyWalletClientType- Siwe
Init Input - Input for initiating a SIWE ceremony.
- Siwe
Init Request Body - The request body for initiating a SIWE ceremony.
- Siwe
Init Response Body - The response body for initiating a SIWE ceremony.
- Siwe
Input - Input for a SIWE signing ceremony.
- Siwe
Input Chain Id SiweInputChainId- Siwe
Input Connector Type SiweInputConnectorType- Siwe
Input Wallet Client Type SiweInputWalletClientType- Siwe
Link Request Body - The request body for linking a SIWE ceremony.
- Siwe
Link Request Body Chain Id SiweLinkRequestBodyChainId- Siwe
Link Request Body Connector Type SiweLinkRequestBodyConnectorType- Siwe
Link Request Body Wallet Client Type SiweLinkRequestBodyWalletClientType- Siwe
Link Smart Wallet Request Body - The request body for linking a SIWE ceremony to a smart wallet.
- Siwe
Nonce - A SIWE nonce response.
- Siwe
Unlink Request Body - The request body for unlinking a SIWE ceremony.
- Siws
Address Input - Input containing a SIWS wallet address.
- Siws
Authenticate Request Body - The request body for authenticating a SIWS ceremony.
- Siws
Authenticate Request Body Connector Type SiwsAuthenticateRequestBodyConnectorType- Siws
Authenticate Request Body Wallet Client Type SiwsAuthenticateRequestBodyWalletClientType- Siws
Init Input - Input for initiating a SIWS ceremony.
- Siws
Init Request Body - The request body for initiating a SIWS ceremony.
- Siws
Init Response Body - The response body for initiating a SIWS ceremony.
- Siws
Input - Input for a SIWS signing ceremony.
- Siws
Input Connector Type SiwsInputConnectorType- Siws
Input Wallet Client Type SiwsInputWalletClientType- Siws
Link Request Body - The request body for linking a SIWS ceremony.
- Siws
Link Request Body Connector Type SiwsLinkRequestBodyConnectorType- Siws
Link Request Body Wallet Client Type SiwsLinkRequestBodyWalletClientType- Siws
Nonce - A SIWS nonce response.
- Siws
Unlink Request Body - The request body for unlinking a SIWS ceremony.
- Smart
Wallet Configuration Disabled - A disabled smart wallet configuration.
- Smart
Wallet Configuration Enabled - An enabled smart wallet configuration.
- Smart
Wallet Configuration Input Enabled - An enabled smart wallet configuration input.
- Smart
Wallet Network Configuration - Network configuration for a smart wallet.
- Smart
Wallet Network Configuration Chain Id SmartWalletNetworkConfigurationChainId- Smart
Wallet Network Configuration Input - Input for network configuration for a smart wallet.
- Smart
Wallet Network Configuration Input Chain Id SmartWalletNetworkConfigurationInputChainId- Smart
Wallet Siwe Input - Input for a smart wallet SIWE signing ceremony.
- SmsMfa
Method - A SMS MFA method.
- Solana
Address - Solana address: base58-encoded public key (32 bytes).
- Solana
Caip2 - Solana CAIP-2 chain identifier (e.g. “solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp”).
- Solana
Program Instruction Condition - Solana Program attributes, enables allowlisting Solana Programs.
- Solana
Sign AndSend Transaction RpcInput - Executes the SVM
signAndSendTransactionRPC to sign and broadcast a transaction. - Solana
Sign AndSend Transaction RpcInput Params - Parameters for the SVM
signAndSendTransactionRPC. - Solana
Sign AndSend Transaction RpcInput Params Transaction SolanaSignAndSendTransactionRpcInputParamsTransaction- Solana
Sign AndSend Transaction RpcInput Reference Id SolanaSignAndSendTransactionRpcInputReferenceId- Solana
Sign AndSend Transaction RpcResponse - Response to the SVM
signAndSendTransactionRPC. - Solana
Sign AndSend Transaction RpcResponse Data - Data returned by the SVM
signAndSendTransactionRPC. - Solana
Sign Message RpcInput - Executes the SVM
signMessageRPC to sign a message. - Solana
Sign Message RpcInput Params - Parameters for the SVM
signMessageRPC. - Solana
Sign Message RpcInput Params Message SolanaSignMessageRpcInputParamsMessage- Solana
Sign Message RpcResponse - Response to the SVM
signMessageRPC. - Solana
Sign Message RpcResponse Data - Data returned by the SVM
signMessageRPC. - Solana
Sign Transaction RpcInput - Executes the SVM
signTransactionRPC to sign a transaction. - Solana
Sign Transaction RpcInput Params - Parameters for the SVM
signTransactionRPC. - Solana
Sign Transaction RpcInput Params Transaction SolanaSignTransactionRpcInputParamsTransaction- Solana
Sign Transaction RpcResponse - Response to the SVM
signTransactionRPC. - Solana
Sign Transaction RpcResponse Data - Data returned by the SVM
signTransactionRPC. - Solana
System Program Instruction Condition - Solana System Program attributes, including more granular Transfer instruction fields.
- Solana
Token Program Instruction Condition - Solana Token Program attributes, including more granular TransferChecked instruction fields.
- Spark
Balance - The balance of a Spark wallet.
- Spark
Claim Static Deposit RpcInput - Claims a static deposit into the Spark wallet.
- Spark
Claim Static Deposit RpcInput Params - Parameters for the Spark
claimStaticDepositRPC. - Spark
Claim Static Deposit RpcResponse - Response to the Spark
claimStaticDepositRPC. - Spark
Claim Static Deposit RpcResponse Data - Data returned by the Spark
claimStaticDepositRPC. - Spark
Create Lightning Invoice RpcInput - Creates a Lightning invoice for the Spark wallet.
- Spark
Create Lightning Invoice RpcInput Params - Parameters for the Spark
createLightningInvoiceRPC. - Spark
Create Lightning Invoice RpcResponse - Response to the Spark
createLightningInvoiceRPC. - Spark
GetBalance RpcInput - Gets the balance of the Spark wallet.
- Spark
GetBalance RpcResponse - Response to the Spark
getBalanceRPC. - Spark
GetClaim Static Deposit Quote RpcInput - Gets a quote for claiming a static deposit.
- Spark
GetClaim Static Deposit Quote RpcInput Params - Parameters for the Spark
getClaimStaticDepositQuoteRPC. - Spark
GetClaim Static Deposit Quote RpcResponse - Response to the Spark
getClaimStaticDepositQuoteRPC. - Spark
GetClaim Static Deposit Quote RpcResponse Data - Data returned by the Spark
getClaimStaticDepositQuoteRPC. - Spark
GetStatic Deposit Address RpcInput - Gets a static deposit address for the Spark wallet.
- Spark
GetStatic Deposit Address RpcResponse - Response to the Spark
getStaticDepositAddressRPC. - Spark
GetStatic Deposit Address RpcResponse Data - Data returned by the Spark
getStaticDepositAddressRPC. - Spark
Lightning Fee - The fee for a Spark Lightning payment.
- Spark
Lightning Receive Request - A Spark Lightning receive request.
- Spark
Lightning Send Request - A Spark Lightning send request.
- Spark
PayLightning Invoice RpcInput - Pays a Lightning invoice from the Spark wallet.
- Spark
PayLightning Invoice RpcInput Params - Parameters for the Spark
payLightningInvoiceRPC. - Spark
PayLightning Invoice RpcResponse - Response to the Spark
payLightningInvoiceRPC. - Spark
Sign Message With Identity KeyRpc Input - Signs a message with the Spark identity key.
- Spark
Sign Message With Identity KeyRpc Input Params - Parameters for the Spark
signMessageWithIdentityKeyRPC. - Spark
Sign Message With Identity KeyRpc Response - Response to the Spark
signMessageWithIdentityKeyRPC. - Spark
Sign Message With Identity KeyRpc Response Data - Data returned by the Spark
signMessageWithIdentityKeyRPC. - Spark
Signing Keyshare - A Spark signing keyshare.
- Spark
Token Balance - Balance of a Spark token.
- Spark
Transfer - A Spark transfer.
- Spark
Transfer Leaf - A Spark transfer leaf.
- Spark
Transfer RpcInput - Transfers satoshis to a Spark address.
- Spark
Transfer RpcInput Params - Parameters for the Spark
transferRPC. - Spark
Transfer RpcResponse - Response to the Spark
transferRPC. - Spark
Transfer Tokens RpcInput - Transfers tokens to a Spark address.
- Spark
Transfer Tokens RpcInput Params - Parameters for the Spark
transferTokensRPC. - Spark
Transfer Tokens RpcResponse - Response to the Spark
transferTokensRPC. - Spark
Transfer Tokens RpcResponse Data - Data returned by the Spark
transferTokensRPC. - Spark
User Token Metadata - Metadata for a Spark user token.
- Spark
Wallet Leaf - A Spark wallet leaf node.
- Start
Verification From UrlResponse StartVerificationFromUrlResponse- Stripe
Consumer Wallet - A registered consumer wallet.
- Stripe
Crypto Customer Active - Active onramp session with customer verifications.
- Stripe
Crypto Customer Expired - Expired onramp session. Token refresh failed, re-authentication required.
- Stripe
Crypto Customer None - No onramp session. User must authenticate via Link.
- Stripe
Onramp Checkout Response - Checkout confirmation with client secret.
- Stripe
Payment Token - A saved payment token.
- Stripe
Quote - A refreshed quote.
- Stripe
Transaction Details - Transaction details from checkout.
- Stripe
Verification - A verification entry on a CryptoCustomer.
- Submit
User Verification From UrlBody Metadata SubmitUserVerificationFromUrlBodyMetadata- Submit
User Verification From UrlBody Metadata Address SubmitUserVerificationFromUrlBodyMetadataAddress- Submit
User Verification From UrlBody Metadata Identity SubmitUserVerificationFromUrlBodyMetadataIdentity- Submit
User Verification From UrlBody Metadata Identity Full Name SubmitUserVerificationFromUrlBodyMetadataIdentityFullName- Submit
User Verification From UrlBody Metadata Negative News SubmitUserVerificationFromUrlBodyMetadataNegativeNews- Submit
User Verification From UrlBody Metadata Pep SubmitUserVerificationFromUrlBodyMetadataPep- Submit
User Verification From UrlBody Metadata Sanctions SubmitUserVerificationFromUrlBodyMetadataSanctions- Submit
User Verification From UrlResponse SubmitUserVerificationFromUrlResponse- Submit
User Verification From UrlResponse Data SubmitUserVerificationFromUrlResponseData- Submit
User Verification From UrlResponse Data Result SubmitUserVerificationFromUrlResponseDataResult- Success
Response - A simple success response.
- SuiTransaction
Command Condition - SUI transaction command attributes, enables allowlisting specific command types. Allowed commands: ‘TransferObjects’, ‘SplitCoins’, ‘MergeCoins’. Only ‘eq’ and ‘in’ operators are supported.
- SuiTransfer
Objects Command Condition - SUI TransferObjects command attributes, including recipient and amount fields.
- SvmTransaction
Wallet Action Step - A wallet action step consisting of an SVM (Solana) transaction.
- Swap
Action Response - Response for a swap action.
- Swap
Destination - The output side of a swap execution request.
- Swap
Quote Destination - The output side of a swap quote request.
- Swap
Quote Request Body - Input for requesting a token swap quote.
- Swap
Quote Request Body Base Amount - Amount in base units (e.g., wei for ETH). Must be a non-negative integer string.
- Swap
Quote Response - Pricing data for a token swap.
- Swap
Request Body - Input for executing a token swap.
- Swap
Request Body Base Amount - Amount in base units (e.g., wei for ETH). Must be a non-negative integer string.
- Swap
Source - The input side of a swap request, including token and chain.
- System
Condition - System attributes, including current unix timestamp (in seconds).
- Telegram
Auth Config Schema - Configuration for Telegram authentication.
- Telegram
Auth Result - Auth result object returned by Telegram when a user authenticates using the login widget.
- Telegram
Authenticate Input - Input for authenticating with Telegram.
- Telegram
Authenticate Request Body - The request body for authenticating with Telegram.
- Telegram
Link Request Body - The request body for linking a Telegram account.
- Telegram
Unlink Input - Input for unlinking a Telegram account.
- Telegram
Unlink Request Body - The request body for unlinking a Telegram account.
- Telegram
WebApp Data - Auth result object returned by Telegram when a user authenticates using a mini app.
- Tempo
AaAuthorization - An AA authorization for Tempo transactions with P256/WebAuthn signatures.
- Tempo
Call - A single call within a Tempo batched transaction.
- Tempo
FeePayer Signature - A fee payer signature for sponsored Tempo transactions (secp256k1 only).
- Tempo
FeePayer SignatureY Parity Variant0 TempoFeePayerSignatureYParityVariant0- Tempo
FeePayer SignatureY Parity Variant1 TempoFeePayerSignatureYParityVariant1- Tempo
Transaction Condition - A Tempo (type 118) transaction-level field. Evaluated once per transaction (not per call).
- Test
Account - A test account for an app.
- Test
Accounts Response - Response for listing test accounts for an app.
- Token
Output - A Spark token output.
- Token
Transfer Destination - The destination address for a token transfer. Optionally specify a different asset or chain for cross-asset or cross-chain transfers.
- Total
FeeConfiguration Bps - Total fees assessed on a transfer, in BPS
- Totp
MfaMethod - A TOTP MFA method.
- Transaction
- A transaction from a Privy wallet.
- Transaction
Broadcasted Webhook Payload - Payload for the transaction.broadcasted webhook event.
- Transaction
Confirmed Webhook Payload - Payload for the transaction.confirmed webhook event.
- Transaction
Execution Reverted Webhook Payload - Payload for the transaction.execution_reverted webhook event.
- Transaction
Failed Webhook Payload - Payload for the transaction.failed webhook event.
- Transaction
List - A list of transactions.
- Transaction
Provider Error Webhook Payload - Payload for the transaction.provider_error webhook event.
- Transaction
Replaced Webhook Payload - Payload for the transaction.replaced webhook event.
- Transaction
Scanning Asset Diff - An asset diff representing assets entering/leaving a wallet.
- Transaction
Scanning Asset Info - Information about the moving asset in a transaction scan.
- Transaction
Scanning Asset Value - The value of an asset in a transaction scan result.
- Transaction
Scanning Calldata - Decoded calldata from a scanned transaction.
- Transaction
Scanning Exposure - An exposure representing assets approved to spend.
- Transaction
Scanning Metadata - Additional information for Blockaid to validate against.
- Transaction
Scanning Params - The parameters of the scanned transaction.
- Transaction
Scanning Request Body - The request body for scanning a transaction.
- Transaction
Scanning Response Body - The response from scanning a transaction.
- Transaction
Scanning RpcRequest - Raw RPC request to execute with the wallet.
- Transaction
Scanning Simulation Error Result - A failed simulation result from a transaction scan.
- Transaction
Scanning Simulation Success Result - A successful simulation result from a transaction scan.
- Transaction
Scanning Validation Error Result - A failed validation result from a transaction scan.
- Transaction
Scanning Validation Success Result - A successful validation result from a transaction scan.
- Transaction
Still Pending Webhook Payload - Payload for the transaction.still_pending webhook event.
- Transaction
Token Address Input - Token contract address (EVM: 0x-prefixed hex) or mint address (Solana: base58), used to filter wallet transactions.
- Transfer
Action Response - Response for a transfer action.
- Transfer
Farcaster Input - Input for transferring a Farcaster account.
- Transfer
Intent Request Details - Request details for a transfer intent.
- Transfer
Intent Request Details Url TransferIntentRequestDetailsUrl- Transfer
Intent Response - Response for a transfer intent
- Transfer
Intent Response Request Details - The original transfer request that would be sent to the wallet transfer endpoint
- Transfer
Quote Request Body - Request body for requesting a quote for a cross-asset or cross-chain (DADC) transfer.
- Transfer
Quote Response - Response containing a quote for a cross-asset or cross-chain (DADC) transfer.
- Transfer
Received Transaction Detail - Details for a received transfer transaction.
- Transfer
Request Body - Request body for initiating a sponsored token transfer from an embedded wallet.
- Transfer
Sent Transaction Detail - Details for a sent transfer transaction.
- Transfer
Siwe Input - Input for transferring a SIWE account.
- Transfer
Siwe Input Chain Id TransferSiweInputChainId- Transfer
Siwe Input Connector Type TransferSiweInputConnectorType- Transfer
Siwe Input Wallet Client Type TransferSiweInputWalletClientType- Transfer
Siws Input - Input for transferring a SIWS account.
- Transfer
Siws Input Connector Type TransferSiwsInputConnectorType- Transfer
Siws Input Wallet Client Type TransferSiwsInputWalletClientType- Transfer
Telegram Input - Input for transferring a Telegram account.
- Tron
Address - Tron address: base58check-encoded, starting with T, 34 characters.
- Tron
Caip2 - Tron CAIP-2 chain identifier (e.g. “tron:20191129”).
- Tron
Calldata Condition - Decoded calldata from a TRON TriggerSmartContract interaction.
- Tron
Transaction Condition - TRON transaction fields for TransferContract and TriggerSmartContract transaction types.
- Typed
Data Domain Input Params - The domain parameters for EIP-712 typed data signing.
- Typed
Data Type Field Input - A single field definition in an EIP-712 typed data type.
- Typed
Data Types Input Params - The type definitions for EIP-712 typed data signing.
- Unlink
Passkey Input - Input for unlinking a passkey credential.
- Unlink
User Linked Account Body UnlinkUserLinkedAccountBody- Unsigned
Standard Ethereum Transaction - An unsigned standard Ethereum transaction object. Supports EVM transaction types 0, 1, 2, and 4.
- Unsigned
Standard Ethereum Transaction Type Variant0 UnsignedStandardEthereumTransactionTypeVariant0- Unsigned
Standard Ethereum Transaction Type Variant1 UnsignedStandardEthereumTransactionTypeVariant1- Unsigned
Standard Ethereum Transaction Type Variant2 UnsignedStandardEthereumTransactionTypeVariant2- Unsigned
Standard Ethereum Transaction Type Variant3 UnsignedStandardEthereumTransactionTypeVariant3- Unsigned
Tempo Transaction - An unsigned Tempo transaction (type 118) with batched calls.
- Unsigned
Tempo Transaction Access List Item UnsignedTempoTransactionAccessListItem- Unsigned
Tempo Transaction Type UnsignedTempoTransactionType- Update
Account Account Id - ID of the account.
- Update
Account From Wallet IdsInput - Input for updating a digital asset account by adding existing wallets
with a
wallet_idsparameter. - Update
Account From Wallets Configuration Input - Input for updating a digital asset account with a
wallets_configurationspecification. - Update
Condition SetCondition SetId UpdateConditionSetConditionSetId- Update
Condition SetItems Condition SetId UpdateConditionSetItemsConditionSetId- Update
Condition SetRequest Body - Request body for updating a condition set. At least one field must be
provided.
ownerandowner_idare mutually exclusive. - Update
Condition SetRequest Body Name - Name to assign to condition set.
- Update
Organization Secret Signing KeyAccount Id UpdateOrganizationSecretSigningKeyAccountId- Update
Organization Secret Signing KeyInput - Request body for updating the signing public key on an organization secret.
- Update
Organization Secret Signing KeyInput Secret Id - The organization secret ID.
- Update
Policy Body UpdatePolicyBody- Update
Policy Body Name - Name to assign to policy.
- Update
Policy Policy Id UpdatePolicyPolicyId- Update
Rule Policy Id UpdateRulePolicyId- Update
Rule Rule Id UpdateRuleRuleId- Update
User Custom Metadata Body UpdateUserCustomMetadataBody- Update
User Fiat KycStatus Body Bridge Birth Date UpdateUserFiatKycStatusBodyBridgeBirthDate- Update
User Fiat KycStatus Body Bridge Documents Item UpdateUserFiatKycStatusBodyBridgeDocumentsItem- Update
User Fiat KycStatus Body Bridge Documents Item Description UpdateUserFiatKycStatusBodyBridgeDocumentsItemDescription- Update
User Fiat KycStatus Body Bridge Documents Item File UpdateUserFiatKycStatusBodyBridgeDocumentsItemFile- Update
User Fiat KycStatus Body Bridge Documents Item Purposes Item UpdateUserFiatKycStatusBodyBridgeDocumentsItemPurposesItem- Update
User Fiat KycStatus Body Bridge First Name UpdateUserFiatKycStatusBodyBridgeFirstName- Update
User Fiat KycStatus Body Bridge Identifying Information Item UpdateUserFiatKycStatusBodyBridgeIdentifyingInformationItem- Update
User Fiat KycStatus Body Bridge Identifying Information Item Issuing Country UpdateUserFiatKycStatusBodyBridgeIdentifyingInformationItemIssuingCountry- Update
User Fiat KycStatus Body Bridge KycScreen UpdateUserFiatKycStatusBodyBridgeKycScreen- Update
User Fiat KycStatus Body Bridge KycScreen Screened At UpdateUserFiatKycStatusBodyBridgeKycScreenScreenedAt- Update
User Fiat KycStatus Body Bridge Last Name UpdateUserFiatKycStatusBodyBridgeLastName- Update
User Fiat KycStatus Body Bridge Middle Name UpdateUserFiatKycStatusBodyBridgeMiddleName- Update
User Fiat KycStatus Body Bridge Nationality UpdateUserFiatKycStatusBodyBridgeNationality- Update
User Fiat KycStatus Body Bridge Ofac Screen UpdateUserFiatKycStatusBodyBridgeOfacScreen- Update
User Fiat KycStatus Body Bridge Ofac Screen Screened At UpdateUserFiatKycStatusBodyBridgeOfacScreenScreenedAt- Update
User Fiat KycStatus Body Bridge Phone UpdateUserFiatKycStatusBodyBridgePhone- Update
User Fiat KycStatus Body Bridge Residential Address UpdateUserFiatKycStatusBodyBridgeResidentialAddress- Update
User Fiat KycStatus Body Bridge Residential Address City UpdateUserFiatKycStatusBodyBridgeResidentialAddressCity- Update
User Fiat KycStatus Body Bridge Residential Address Country UpdateUserFiatKycStatusBodyBridgeResidentialAddressCountry- Update
User Fiat KycStatus Body Bridge Residential Address Postal Code UpdateUserFiatKycStatusBodyBridgeResidentialAddressPostalCode- Update
User Fiat KycStatus Body Bridge Residential Address Street Line1 UpdateUserFiatKycStatusBodyBridgeResidentialAddressStreetLine1- Update
User Fiat KycStatus Body Bridge Residential Address Street Line2 UpdateUserFiatKycStatusBodyBridgeResidentialAddressStreetLine2- Update
User Fiat KycStatus Body Bridge Residential Address Subdivision UpdateUserFiatKycStatusBodyBridgeResidentialAddressSubdivision- Update
User Fiat KycStatus Body Bridge Sandbox Birth Date UpdateUserFiatKycStatusBodyBridgeSandboxBirthDate- Update
User Fiat KycStatus Body Bridge Sandbox Documents Item UpdateUserFiatKycStatusBodyBridgeSandboxDocumentsItem- Update
User Fiat KycStatus Body Bridge Sandbox Documents Item Description UpdateUserFiatKycStatusBodyBridgeSandboxDocumentsItemDescription- Update
User Fiat KycStatus Body Bridge Sandbox Documents Item File UpdateUserFiatKycStatusBodyBridgeSandboxDocumentsItemFile- Update
User Fiat KycStatus Body Bridge Sandbox Documents Item Purposes Item UpdateUserFiatKycStatusBodyBridgeSandboxDocumentsItemPurposesItem- Update
User Fiat KycStatus Body Bridge Sandbox First Name UpdateUserFiatKycStatusBodyBridgeSandboxFirstName- Update
User Fiat KycStatus Body Bridge Sandbox Identifying Information Item UpdateUserFiatKycStatusBodyBridgeSandboxIdentifyingInformationItem- Update
User Fiat KycStatus Body Bridge Sandbox Identifying Information Item Issuing Country UpdateUserFiatKycStatusBodyBridgeSandboxIdentifyingInformationItemIssuingCountry- Update
User Fiat KycStatus Body Bridge Sandbox KycScreen UpdateUserFiatKycStatusBodyBridgeSandboxKycScreen- Update
User Fiat KycStatus Body Bridge Sandbox KycScreen Screened At UpdateUserFiatKycStatusBodyBridgeSandboxKycScreenScreenedAt- Update
User Fiat KycStatus Body Bridge Sandbox Last Name UpdateUserFiatKycStatusBodyBridgeSandboxLastName- Update
User Fiat KycStatus Body Bridge Sandbox Middle Name UpdateUserFiatKycStatusBodyBridgeSandboxMiddleName- Update
User Fiat KycStatus Body Bridge Sandbox Nationality UpdateUserFiatKycStatusBodyBridgeSandboxNationality- Update
User Fiat KycStatus Body Bridge Sandbox Ofac Screen UpdateUserFiatKycStatusBodyBridgeSandboxOfacScreen- Update
User Fiat KycStatus Body Bridge Sandbox Ofac Screen Screened At UpdateUserFiatKycStatusBodyBridgeSandboxOfacScreenScreenedAt- Update
User Fiat KycStatus Body Bridge Sandbox Phone UpdateUserFiatKycStatusBodyBridgeSandboxPhone- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddress- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address City UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressCity- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address Country UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressCountry- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address Postal Code UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressPostalCode- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address Street Line1 UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressStreetLine1- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address Street Line2 UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressStreetLine2- Update
User Fiat KycStatus Body Bridge Sandbox Residential Address Subdivision UpdateUserFiatKycStatusBodyBridgeSandboxResidentialAddressSubdivision- Update
User Fiat KycStatus Body Bridge Sandbox Signed Agreement Id UpdateUserFiatKycStatusBodyBridgeSandboxSignedAgreementId- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated First Name UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedFirstName- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Last Name UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedLastName- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Middle Name UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedMiddleName- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddress- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address City UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressCity- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address Country UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressCountry- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address Postal Code UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressPostalCode- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address Street Line1 UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressStreetLine1- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address Street Line2 UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressStreetLine2- Update
User Fiat KycStatus Body Bridge Sandbox Transliterated Residential Address Subdivision UpdateUserFiatKycStatusBodyBridgeSandboxTransliteratedResidentialAddressSubdivision- Update
User Fiat KycStatus Body Bridge Signed Agreement Id UpdateUserFiatKycStatusBodyBridgeSignedAgreementId- Update
User Fiat KycStatus Body Bridge Transliterated First Name UpdateUserFiatKycStatusBodyBridgeTransliteratedFirstName- Update
User Fiat KycStatus Body Bridge Transliterated Last Name UpdateUserFiatKycStatusBodyBridgeTransliteratedLastName- Update
User Fiat KycStatus Body Bridge Transliterated Middle Name UpdateUserFiatKycStatusBodyBridgeTransliteratedMiddleName- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddress- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address City UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressCity- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address Country UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressCountry- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address Postal Code UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressPostalCode- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address Street Line1 UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressStreetLine1- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address Street Line2 UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressStreetLine2- Update
User Fiat KycStatus Body Bridge Transliterated Residential Address Subdivision UpdateUserFiatKycStatusBodyBridgeTransliteratedResidentialAddressSubdivision- Update
User Instagram Username Body UpdateUserInstagramUsernameBody- Update
User Spotify Subject Body UpdateUserSpotifySubjectBody- Update
User Twitch Username Body UpdateUserTwitchUsernameBody- User
- A Privy user object.
- User
Authenticated Webhook Payload - Payload for the user.authenticated webhook event.
- User
Batch Create Input - The payload for batch creating users.
- User
Batch Create Input Users Item UserBatchCreateInputUsersItem- User
Created Webhook Payload - Payload for the user.created webhook event.
- User
Fiat Statuses Body UserFiatStatusesBody- User
Fiat Statuses Body TxHash UserFiatStatusesBodyTxHash- User
Fiat Statuses Response UserFiatStatusesResponse- User
Fiat Statuses Response Transactions Item Destination UserFiatStatusesResponseTransactionsItemDestination- User
Fiat Statuses Response Transactions Item Receipt UserFiatStatusesResponseTransactionsItemReceipt- User
Linked Account Webhook Payload - Payload for the user.linked_account webhook event.
- User
Operation Completed Webhook Payload - Payload for the user_operation.completed webhook event.
- User
Operation Input - An ERC-4337 user operation.
- User
Signing KeyBinding - A binding that scopes a user signing key to a specific bound value.
- User
Transferred Account Webhook Payload - Payload for the user.transferred_account webhook event.
- User
Transferred Account Webhook Payload From User UserTransferredAccountWebhookPayloadFromUser- User
Unlinked Account Webhook Payload - Payload for the user.unlinked_account webhook event.
- User
Updated Account Webhook Payload - Payload for the user.updated_account webhook event.
- User
Wallet Created Webhook Payload - Payload for the user.wallet_created webhook event.
- User
With Identity Token - The user object along their identity token.
- User
With Identity Token Identity Token UserWithIdentityTokenIdentityToken- Wallet
- A wallet managed by Privy’s wallet infrastructure.
- Wallet
Action Earn Deposit Created Webhook Payload - Payload for the wallet_action.earn_deposit.created webhook event.
- Wallet
Action Earn Deposit Failed Webhook Payload - Payload for the wallet_action.earn_deposit.failed webhook event.
- Wallet
Action Earn Deposit Rejected Webhook Payload - Payload for the wallet_action.earn_deposit.rejected webhook event.
- Wallet
Action Earn Deposit Succeeded Webhook Payload - Payload for the wallet_action.earn_deposit.succeeded webhook event.
- Wallet
Action Earn Incentive Claim Created Webhook Payload - Payload for the wallet_action.earn_incentive_claim.created webhook event.
- Wallet
Action Earn Incentive Claim Failed Webhook Payload - Payload for the wallet_action.earn_incentive_claim.failed webhook event.
- Wallet
Action Earn Incentive Claim Rejected Webhook Payload - Payload for the wallet_action.earn_incentive_claim.rejected webhook event.
- Wallet
Action Earn Incentive Claim Succeeded Webhook Payload - Payload for the wallet_action.earn_incentive_claim.succeeded webhook event.
- Wallet
Action Earn Withdraw Created Webhook Payload - Payload for the wallet_action.earn_withdraw.created webhook event.
- Wallet
Action Earn Withdraw Failed Webhook Payload - Payload for the wallet_action.earn_withdraw.failed webhook event.
- Wallet
Action Earn Withdraw Rejected Webhook Payload - Payload for the wallet_action.earn_withdraw.rejected webhook event.
- Wallet
Action Earn Withdraw Succeeded Webhook Payload - Payload for the wallet_action.earn_withdraw.succeeded webhook event.
- Wallet
Action Swap Created Webhook Payload - Payload for the wallet_action.swap.created webhook event.
- Wallet
Action Swap Failed Webhook Payload - Payload for the wallet_action.swap.failed webhook event.
- Wallet
Action Swap Rejected Webhook Payload - Payload for the wallet_action.swap.rejected webhook event.
- Wallet
Action Swap Succeeded Webhook Payload - Payload for the wallet_action.swap.succeeded webhook event.
- Wallet
Action Transfer Created Webhook Payload - Payload for the wallet_action.transfer.created webhook event.
- Wallet
Action Transfer Failed Webhook Payload - Payload for the wallet_action.transfer.failed webhook event.
- Wallet
Action Transfer Rejected Webhook Payload - Payload for the wallet_action.transfer.rejected webhook event.
- Wallet
Action Transfer Succeeded Webhook Payload - Payload for the wallet_action.transfer.succeeded webhook event.
- Wallet
Additional Signer - Additional signers for the wallet.
- Wallet
Additional Signer Item - A single additional signer on a wallet, with an optional policy override.
- Wallet
ApiRegister Authorization KeyInput - Input for registering or updating an application public signing key for API-based wallet actions.
- Wallet
ApiRevoke Authorization KeyInput - Input for revoking an application authorization key.
- Wallet
Authenticate Bound Encrypted Request Body - Request body for creating an encrypted, bound user signing key.
- Wallet
Authenticate Bound Unencrypted Request Body - Request body for creating an unencrypted, bound user signing key.
- Wallet
Authenticate Request Body - Request body for wallet authentication with HPKE-encrypted response.
- Wallet
Authorization Headers - Headers required to authorize wallet operations.
- Wallet
Batch Create Input - Request body for batch wallet creation.
- Wallet
Batch Create Response - Response for a batch wallet creation request.
- Wallet
Batch Item Input - Input for a single wallet in a batch creation request.
- Wallet
Batch Item Input Display Name - A human-readable label for the wallet.
- Wallet
Batch Item Input External Id - 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 after creation.
- Wallet
Batch Item Input Policy IdsItem WalletBatchItemInputPolicyIdsItem- Wallet
Create Wallets With Recovery Response - The response from creating wallets with an associated recovery user.
- Wallet
Creation Additional Signer Item - An additional signer configuration for a wallet.
- Wallet
Creation Additional Signer Item Override Policy IdsItem WalletCreationAdditionalSignerItemOverridePolicyIdsItem- Wallet
Creation Input - The fields on wallet creation that can be specified when creating a user-controlled embedded server wallet.
- Wallet
Creation Input Policy IdsItem WalletCreationInputPolicyIdsItem- Wallet
Custodian - Information about the custodian managing this wallet.
- Wallet
Export Request Body - Request body for exporting a wallet private key.
- Wallet
Export Response Body - Response body containing the encrypted wallet private key.
- Wallet
Funds Erc20 Asset - An ERC-20 token asset.
- Wallet
Funds Native Token Asset - A native token asset (e.g. ETH, SOL).
- Wallet
Funds SacAsset - A Stellar Asset Contract (SAC) asset.
- Wallet
Funds SplAsset - A Solana SPL token asset.
- Wallet
Import Init Response - Response from initializing a wallet import, containing the encryption public key.
- Wallet
Import Initialization Response WalletImportInitializationResponse- Wallet
Import Submission Request WalletImportSubmissionRequest- Wallet
Import Submission Request Display Name - A human-readable label for the wallet.
- Wallet
Import Submission Request External Id - 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 after creation.
- Wallet
Intent Response - Response for a wallet intent
- Wallet
Intent Response Request Details - The original wallet update request that would be sent to the wallet endpoint
- Wallet
Intent Response Request Details Body WalletIntentResponseRequestDetailsBody- Wallet
Intent Response Request Details Body Display Name WalletIntentResponseRequestDetailsBodyDisplayName- Wallet
Invite Input - Allowlist invite input for a wallet address.
- Wallet
Recovered Webhook Payload - Payload for the wallet.recovered webhook event.
- Wallet
Recovery Setup Webhook Payload - Payload for the wallet.recovery_setup webhook event.
- Wallet
Revoke Response - The response body from revoking a wallet delegation.
- Wallet
Transactions Cursor WalletTransactionsCursor- Wallet
Transactions Response WalletTransactionsResponse- Wallet
Transactions Response Transactions Item WalletTransactionsResponseTransactionsItem- Wallet
Update Request Body - Request body for updating a wallet.
ownerandowner_idare mutually exclusive. - Wallet
Update Request Body Display Name - A human-readable label for the wallet. Set to null to clear.
- Wallet
Update Request Body Policy IdsItem WalletUpdateRequestBodyPolicyIdsItem- With
Encryption Encrypted Authorization Key - The encrypted authorization key data.
- Withdraw
Funds Body WithdrawFundsBody- Withdraw
Funds Body Amount WithdrawFundsBodyAmount- Withdraw
Funds Body Asset WithdrawFundsBodyAsset- Withdraw
Funds Body Key WithdrawFundsBodyKey- Withdraw
Funds Response WithdrawFundsResponse- Withdraw
Funds Response Data WithdrawFundsResponseData- Withdraw
Funds Response Data Result WithdrawFundsResponseDataResult- Yield
Authorization Headers - Headers required to authorize yield operations.
- Yield
Claim Confirmed Webhook Payload - Payload for the yield.claim.confirmed webhook event.
- Yield
Claim Confirmed Webhook Payload Rewards Item YieldClaimConfirmedWebhookPayloadRewardsItem- Yield
Deposit Confirmed Webhook Payload - Payload for the yield.deposit.confirmed webhook event.
- Yield
Withdraw Confirmed Webhook Payload - Payload for the yield.withdraw.confirmed webhook event.
Enums§
- AbiSchema
Item State Mutability AbiSchemaItemStateMutability- AbiSchema
Item Type AbiSchemaItemType- Account
Balance Params Testnet Mode - When set to true, returns balances from testnet chains instead of mainnets.
- Action
Request Body Condition Field Source ActionRequestBodyConditionFieldSource- Address
- A blockchain wallet address (Ethereum or Solana).
- Aggregation
Condition Field Source AggregationConditionFieldSource- Aggregation
Method - The RPC method this aggregation applies to.
- Aggregation
Metric Function - The aggregation function to apply.
- Aggregation
Window - The time window configuration for an aggregation.
- Amount
Type - Whether the amount refers to the input token or output token.
- AppResponse
Data Classification - Indicates that this response contains only publicly accessible data, not a privileged resource
- AppResponse
Enabled Captcha Provider AppResponseEnabledCaptchaProvider- AppResponse
MfaMethods Item AppResponseMfaMethodsItem- Authenticate
Mode Option - Whether to allow sign-up during authentication.
- Authenticate
Siws Input Message Type AuthenticateSiwsInputMessageType- Authenticated
User Session Update Action - Instructs the client on how to handle tokens received
- Authorization
KeyRole - The role of an authorization key, controlling what actions it can authorize on a wallet.
- Base
Action Result Response Body BaseActionResultResponseBody- Bitcoin
Caip2 - Bitcoin CAIP-2 chain identifier (e.g. “bip122:000000000019d6689c085ae165831e93”).
- Bitcoin
Caip2 Variant0 BitcoinCaip2Variant0- Bridge
BrlFiat Virtual Account Deposit Instructions Asset BridgeBrlFiatVirtualAccountDepositInstructionsAsset- Bridge
BrlFiat Virtual Account Deposit Instructions Payment Rails Item BridgeBrlFiatVirtualAccountDepositInstructionsPaymentRailsItem- Bridge
Crypto Deposit Metadata Method BridgeCryptoDepositMetadataMethod- Bridge
Crypto Deposit Metadata Type BridgeCryptoDepositMetadataType- Bridge
Crypto Transfer Metadata Method BridgeCryptoTransferMetadataMethod- Bridge
Crypto Transfer Metadata Type BridgeCryptoTransferMetadataType- Bridge
Destination Asset - Supported destination stablecoin assets for fiat-to-crypto transfers.
- Bridge
EurFiat Virtual Account Deposit Instructions Asset BridgeEurFiatVirtualAccountDepositInstructionsAsset- Bridge
EurFiat Virtual Account Deposit Instructions Payment Rails Item BridgeEurFiatVirtualAccountDepositInstructionsPaymentRailsItem- Bridge
Fiat Customer Response Provider BridgeFiatCustomerResponseProvider- Bridge
Fiat Deposit Metadata Method BridgeFiatDepositMetadataMethod- Bridge
Fiat Deposit Metadata Type BridgeFiatDepositMetadataType- Bridge
Fiat Transfer Metadata Method BridgeFiatTransferMetadataMethod- Bridge
Fiat Transfer Metadata Type BridgeFiatTransferMetadataType- Bridge
Fiat Virtual Account Deposit Instructions - The deposit instructions for a virtual account.
- Bridge
Fiat Virtual Account Request Provider BridgeFiatVirtualAccountRequestProvider- Bridge
Fiat Virtual Account Response Provider BridgeFiatVirtualAccountResponseProvider- Bridge
GbpFiat Virtual Account Deposit Instructions Asset BridgeGbpFiatVirtualAccountDepositInstructionsAsset- Bridge
GbpFiat Virtual Account Deposit Instructions Payment Rails Item BridgeGbpFiatVirtualAccountDepositInstructionsPaymentRailsItem- Bridge
Metadata - Metadata about a Bridge transaction associated with a wallet event.
- Bridge
MxnFiat Virtual Account Deposit Instructions Asset BridgeMxnFiatVirtualAccountDepositInstructionsAsset- Bridge
MxnFiat Virtual Account Deposit Instructions Payment Rails Item BridgeMxnFiatVirtualAccountDepositInstructionsPaymentRailsItem- Bridge
Onramp Provider - Bridge provider variant — production or sandbox.
- Bridge
Refund Metadata Method BridgeRefundMetadataMethod- Bridge
Refund Metadata Type BridgeRefundMetadataType- Bridge
Sandbox Fiat Customer Response Provider BridgeSandboxFiatCustomerResponseProvider- Bridge
Sandbox Fiat Virtual Account Request Provider BridgeSandboxFiatVirtualAccountRequestProvider- Bridge
Sandbox Fiat Virtual Account Response Provider BridgeSandboxFiatVirtualAccountResponseProvider- Bridge
Source Asset - Supported source fiat currencies for virtual account deposits.
- Bridge
Static Memo Deposit Metadata Method BridgeStaticMemoDepositMetadataMethod- Bridge
Static Memo Deposit Metadata Type BridgeStaticMemoDepositMetadataType- Bridge
Transfer Refund Metadata Method BridgeTransferRefundMetadataMethod- Bridge
Transfer Refund Metadata Type BridgeTransferRefundMetadataType- Bridge
UsdFiat Virtual Account Deposit Instructions Asset BridgeUsdFiatVirtualAccountDepositInstructionsAsset- Bridge
UsdFiat Virtual Account Deposit Instructions Payment Rails Item BridgeUsdFiatVirtualAccountDepositInstructionsPaymentRailsItem- Coinbase
Blockchain - A blockchain supported by Coinbase on-ramp.
- Coinbase
Ethereum Asset - An Ethereum asset supported by Coinbase on-ramp.
- Coinbase
OnRamp Init Input - The input for initializing a Coinbase on-ramp session.
- Coinbase
OnRamp Status - Status of a Coinbase on-ramp session.
- Coinbase
Solana Asset - A Solana asset supported by Coinbase on-ramp.
- Condition
Operator - Operator to use for policy conditions.
- Condition
Value - Value to compare against in a policy condition. Can be a single string or an array of strings.
- Create
Account Input - Input for creating a digital asset account.
- Create
Kraken User Body Client Identifier CreateKrakenUserBodyClientIdentifier- Create
Kraken User Body Client Identifier Variant0 Type CreateKrakenUserBodyClientIdentifierVariant0Type- Create
Kraken User Body Client Identifier Variant1 Type CreateKrakenUserBodyClientIdentifierVariant1Type- Create
Kraken User Body Client Identifier Variant2 Type CreateKrakenUserBodyClientIdentifierVariant2Type- Create
Kraken User Body Client Identifier Variant3 Type CreateKrakenUserBodyClientIdentifierVariant3Type- Create
Kraken User Body Client Identifier Variant4 Type CreateKrakenUserBodyClientIdentifierVariant4Type- Create
Kraken User Body Client Identifier Variant5 Type CreateKrakenUserBodyClientIdentifierVariant5Type- Create
Kraken User Body Country OfBirth CreateKrakenUserBodyCountryOfBirth- Create
Kraken User Body Nationalities Item CreateKrakenUserBodyNationalitiesItem- Create
Kraken User Body Occupation CreateKrakenUserBodyOccupation- Create
Kraken User Body Residence Country CreateKrakenUserBodyResidenceCountry- Create
Kraken User Body TaxIds Item Issuing Country CreateKrakenUserBodyTaxIdsItemIssuingCountry- Create
Link Auth Intent Response Data CreateLinkAuthIntentResponseData- Create
Policy Body Version - Version of the policy. Currently, 1.0 is the only version.
- Create
User Fiat Account Body Account Checking OrSavings CreateUserFiatAccountBodyAccountCheckingOrSavings- Create
User Fiat Account Body Swift Category CreateUserFiatAccountBodySwiftCategory- Create
User Fiat Account Body Swift Purpose OfFunds Item CreateUserFiatAccountBodySwiftPurposeOfFundsItem- Create
User Fiat TosResponse CreateUserFiatTosResponse- Cross
AppConnections Response Data Classification - Indicates that this response contains only publicly accessible data, not a privileged resource
- Currency
Amount Currency - Currency code
- Currency
Asset - A currency asset type.
- Curve
Signing Chain Type - The wallet chain types that support curve-based signing.
- Curve
Type - The cryptographic curve type used by the wallet.
- Custodial
Wallet Chain Type - The chain type of the custodial wallet.
- Custodial
Wallet Provider - The provider of the custodial wallet.
- Custom
Metadata Value CustomMetadataValue- Custom
Token Transfer Source Asset Address - The token contract address (EVM) or mint address (Solana) of the asset to transfer.
- Developer
FeeRecipient DeveloperFeeRecipient- Developer
FeeType DeveloperFeeType- Device
Verify Action - The action to take on the device authorization request.
- Earn
Deposit Action Response Type EarnDepositActionResponseType- Earn
Incentive Claim Action Response Type EarnIncentiveClaimActionResponseType- Earn
Withdraw Action Response Type EarnWithdrawActionResponseType- Email
Domain Invite Input Type EmailDomainInviteInputType- Email
Invite Input Type EmailInviteInputType- Embedded
Wallet Create OnLogin - Whether to create embedded wallets on login.
- Embedded
Wallet Mode - The mode for embedded wallets.
- Embedded
Wallet Recovery Method - The method used to recover an embedded wallet account.
- Encrypted
Authorization KeyEncryption Type EncryptedAuthorizationKeyEncryptionType- Ethereum7702
Authorization Condition Field Ethereum7702AuthorizationConditionField- Ethereum7702
Authorization Condition Field Source Ethereum7702AuthorizationConditionFieldSource- Ethereum
Calldata Condition Field Source EthereumCalldataConditionFieldSource- Ethereum
Earn Provider - Supported earn provider protocols.
- Ethereum
Personal Sign RpcInput Chain Type EthereumPersonalSignRpcInputChainType- Ethereum
Personal Sign RpcInput Method EthereumPersonalSignRpcInputMethod- Ethereum
Personal Sign RpcInput Params Encoding EthereumPersonalSignRpcInputParamsEncoding- Ethereum
Personal Sign RpcResponse Data Encoding EthereumPersonalSignRpcResponseDataEncoding- Ethereum
Personal Sign RpcResponse Method EthereumPersonalSignRpcResponseMethod- Ethereum
RpcInput - Request body for Ethereum wallet RPC operations, discriminated by method.
- Ethereum
RpcResponse - Response body for Ethereum wallet RPC operations, discriminated by method.
- Ethereum
Secp256k1 Sign RpcInput Chain Type EthereumSecp256k1SignRpcInputChainType- Ethereum
Secp256k1 Sign RpcInput Method EthereumSecp256k1SignRpcInputMethod- Ethereum
Secp256k1 Sign RpcResponse Data Encoding EthereumSecp256k1SignRpcResponseDataEncoding- Ethereum
Secp256k1 Sign RpcResponse Method EthereumSecp256k1SignRpcResponseMethod- Ethereum
Send Calls RpcInput Chain Type EthereumSendCallsRpcInputChainType- Ethereum
Send Calls RpcInput Method EthereumSendCallsRpcInputMethod- Ethereum
Send Calls RpcResponse Method EthereumSendCallsRpcResponseMethod- Ethereum
Send Transaction RpcInput Chain Type EthereumSendTransactionRpcInputChainType- Ethereum
Send Transaction RpcInput Method EthereumSendTransactionRpcInputMethod- Ethereum
Send Transaction RpcResponse Method EthereumSendTransactionRpcResponseMethod- Ethereum
Sign7702 Authorization RpcInput Chain Type EthereumSign7702AuthorizationRpcInputChainType- Ethereum
Sign7702 Authorization RpcInput Method EthereumSign7702AuthorizationRpcInputMethod- Ethereum
Sign7702 Authorization RpcInput Params Executor EthereumSign7702AuthorizationRpcInputParamsExecutor- Ethereum
Sign7702 Authorization RpcResponse Method EthereumSign7702AuthorizationRpcResponseMethod- Ethereum
Sign Transaction RpcInput Chain Type EthereumSignTransactionRpcInputChainType- Ethereum
Sign Transaction RpcInput Method EthereumSignTransactionRpcInputMethod- Ethereum
Sign Transaction RpcResponse Data Encoding EthereumSignTransactionRpcResponseDataEncoding- Ethereum
Sign Transaction RpcResponse Method EthereumSignTransactionRpcResponseMethod- Ethereum
Sign Typed Data RpcInput Chain Type EthereumSignTypedDataRpcInputChainType- Ethereum
Sign Typed Data RpcInput Method EthereumSignTypedDataRpcInputMethod- Ethereum
Sign Typed Data RpcResponse Data Encoding EthereumSignTypedDataRpcResponseDataEncoding- Ethereum
Sign Typed Data RpcResponse Method EthereumSignTypedDataRpcResponseMethod- Ethereum
Sign User Operation RpcInput Chain Type EthereumSignUserOperationRpcInputChainType- Ethereum
Sign User Operation RpcInput Method EthereumSignUserOperationRpcInputMethod- Ethereum
Sign User Operation RpcResponse Data Encoding EthereumSignUserOperationRpcResponseDataEncoding- Ethereum
Sign User Operation RpcResponse Method EthereumSignUserOperationRpcResponseMethod- Ethereum
Transaction Condition Field EthereumTransactionConditionField- Ethereum
Transaction Condition Field Source EthereumTransactionConditionFieldSource- Ethereum
Typed Data Domain Condition Field EthereumTypedDataDomainConditionField- Ethereum
Typed Data Domain Condition Field Source EthereumTypedDataDomainConditionFieldSource- Ethereum
Typed Data Message Condition Field Source EthereumTypedDataMessageConditionFieldSource- Ethereum
Yield Claim Response Status - The current status of the claim transaction.
- Ethereum
Yield Provider - Supported yield/lending protocol providers.
- Ethereum
Yield Sweep Status - Status of a yield sweep.
- Ethereum
Yield Sweep Type - Type of yield sweep.
- EvmTransaction
Wallet Action Step Type EvmTransactionWalletActionStepType- EvmUser
Operation Wallet Action Step Entrypoint Version - The entrypoint version of the user operation.
- EvmUser
Operation Wallet Action Step Type EvmUserOperationWalletActionStepType- EvmWallet
Action Step Status - Status of an EVM step in a wallet action.
- Execute
Quote Response Data Result Status ExecuteQuoteResponseDataResultStatus- Export
Private KeyRpc Input Method ExportPrivateKeyRpcInputMethod- Export
Private KeyRpc Response Method ExportPrivateKeyRpcResponseMethod- Export
Seed Phrase RpcInput Method ExportSeedPhraseRpcInputMethod- Export
Seed Phrase RpcResponse Method ExportSeedPhraseRpcResponseMethod- Export
Type - The export type. ‘display’ is for showing the key to the user in the UI, ‘client’ is for exporting to the client application.
- Extended
Chain Type - The wallet chain types that are not first class chains.
- ExternalO
Auth Provider Id - The ID of an external OAuth provider.
- External
Transaction Wallet Action Step Status - Status of an external transaction step in a wallet action.
- External
Transaction Wallet Action Step Type ExternalTransactionWalletActionStepType- Farcaster
Connect Status Completed Response Body State FarcasterConnectStatusCompletedResponseBodyState- Farcaster
Connect Status Completed Response State FarcasterConnectStatusCompletedResponseState- Farcaster
Connect Status Pending Response Body State FarcasterConnectStatusPendingResponseBodyState- Farcaster
Connect Status Pending Response State FarcasterConnectStatusPendingResponseState- Farcaster
Signer Approved Status FarcasterSignerApprovedStatus- Farcaster
Signer Init Pending Approval Status FarcasterSignerInitPendingApprovalStatus- Farcaster
Signer Init Response Body - The response body from initiating a Farcaster signer connection.
- Farcaster
Signer Revoked Status FarcasterSignerRevokedStatus- Farcaster
Signer Status Pending Approval Status FarcasterSignerStatusPendingApprovalStatus- Farcaster
Signer Status Response Body - The response body from checking the status of a Farcaster signer connection.
- FeeLine
Item - An individual fee assessed on a transfer.
- Fiat
Currency - Supported fiat currencies.
- Fiat
Customer Response - The response for getting a native onramp provider customer.
- Fiat
Onramp Environment - Whether to use the sandbox or production environment for fiat onramp.
- Fiat
Onramp Provider - The fiat onramp provider to use.
- Fiat
Onramp Stripe SdkSession Response Type FiatOnrampStripeSdkSessionResponseType- Fiat
Onramp Transaction Status - Normalized fiat onramp transaction status.
- Fiat
Onramp UrlSession Response Type FiatOnrampUrlSessionResponseType- Fiat
Payment Rail - Supported fiat payment rails.
- Fiat
Virtual Account Request - The request input for creating virtual account.
- Fiat
Virtual Account Response - The response for creating virtual account.
- First
Class Chain Type - The wallet chain types that offer first class support.
- Funding
Method Enum - A funding method for on-ramp.
- Funds
Deposited Webhook Payload Type - The type of webhook event.
- Funds
Withdrawn Webhook Payload Type - The type of webhook event.
- GasSpend
Currency - Currency for gas spend values.
- GetAccount
Balance Testnet Mode - When set to true, returns balances from testnet chains instead of mainnets.
- GetFiat
Onramp UrlResponse - Provider session initialization — either a hosted URL or embedded SDK config.
- GetKraken
User Response Data Result Status GetKrakenUserResponseDataResultStatus- GetKraken
User Response Data Result Status Required Actions Item GetKrakenUserResponseDataResultStatusRequiredActionsItem- GetKraken
User Response Data Result Status Required Actions Item Details Type GetKrakenUserResponseDataResultStatusRequiredActionsItemDetailsType- GetKraken
User Response Data Result Status Required Actions Item Verification Type GetKrakenUserResponseDataResultStatusRequiredActionsItemVerificationType- GetKraken
User Response Data Result User Type GetKrakenUserResponseDataResultUserType- GetMaster
Account Portfolio Details Response Result Assets Item Class GetMasterAccountPortfolioDetailsResponseResultAssetsItemClass- GetMaster
Account Portfolio History Include Assets GetMasterAccountPortfolioHistoryIncludeAssets- GetMaster
Account Portfolio History Include Total Balance GetMasterAccountPortfolioHistoryIncludeTotalBalance- GetMaster
Account Portfolio History Include Total Pnl GetMasterAccountPortfolioHistoryIncludeTotalPnl- GetMaster
Account Portfolio History Interval GetMasterAccountPortfolioHistoryInterval- GetMaster
Account Portfolio Summary Include Current DayPnl GetMasterAccountPortfolioSummaryIncludeCurrentDayPnl- GetMaster
Account Portfolio Transactions RefIds Item Type GetMasterAccountPortfolioTransactionsRefIdsItemType- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetails- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant0 Trade Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant0TradeType- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant0 Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant0Type- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Failure Reason GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1FailureReason- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Receive Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1ReceiveAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Spend Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1SpendAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Trade Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1TradeType- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant1 Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant1Type- GetMaster
Account Portfolio Transactions Response Result Transactions Item Details Variant2 Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemDetailsVariant2Type- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Amount Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveAmountAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Balance Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveBalanceAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive FeeAsset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveFeeAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Amount Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedAmountAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted FeeAsset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedFeeAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Quoted Total Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveQuotedTotalAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Receive Total Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemReceiveTotalAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Amount Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendAmountAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Balance Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendBalanceAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend FeeAsset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendFeeAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Amount Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedAmountAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted FeeAsset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedFeeAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Quoted Total Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendQuotedTotalAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Spend Total Asset Class GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemSpendTotalAssetClass- GetMaster
Account Portfolio Transactions Response Result Transactions Item Status GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemStatus- GetMaster
Account Portfolio Transactions Response Result Transactions Item Type GetMasterAccountPortfolioTransactionsResponseResultTransactionsItemType- GetMaster
Account Portfolio Transactions Sorting GetMasterAccountPortfolioTransactionsSorting- GetMaster
Account Portfolio Transactions Statuses Item GetMasterAccountPortfolioTransactionsStatusesItem- GetMaster
Account Portfolio Transactions Types Item GetMasterAccountPortfolioTransactionsTypesItem- GetPortfolio
Details Response Data Result Assets Item Class GetPortfolioDetailsResponseDataResultAssetsItemClass- GetPortfolio
Summary Include Current DayPnl GetPortfolioSummaryIncludeCurrentDayPnl- GetPortfolio
Transactions RefIds Item Type GetPortfolioTransactionsRefIdsItemType- GetPortfolio
Transactions Response Data Result Transactions Item Details GetPortfolioTransactionsResponseDataResultTransactionsItemDetails- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant0 Trade Type GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant0TradeType- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant0 Type GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant0Type- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Failure Reason GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1FailureReason- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Receive Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1ReceiveAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Spend Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1SpendAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Trade Type GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1TradeType- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant1 Type GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant1Type- GetPortfolio
Transactions Response Data Result Transactions Item Details Variant2 Type GetPortfolioTransactionsResponseDataResultTransactionsItemDetailsVariant2Type- GetPortfolio
Transactions Response Data Result Transactions Item Receive Amount Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveAmountAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive Balance Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveBalanceAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive FeeAsset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveFeeAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Amount Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedAmountAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted FeeAsset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedFeeAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive Quoted Total Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveQuotedTotalAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Receive Total Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemReceiveTotalAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Amount Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendAmountAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Balance Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendBalanceAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend FeeAsset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendFeeAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Amount Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedAmountAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted FeeAsset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedFeeAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Quoted Total Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendQuotedTotalAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Spend Total Asset Class GetPortfolioTransactionsResponseDataResultTransactionsItemSpendTotalAssetClass- GetPortfolio
Transactions Response Data Result Transactions Item Status GetPortfolioTransactionsResponseDataResultTransactionsItemStatus- GetPortfolio
Transactions Response Data Result Transactions Item Type GetPortfolioTransactionsResponseDataResultTransactionsItemType- GetPortfolio
Transactions Sorting GetPortfolioTransactionsSorting- GetPortfolio
Transactions Statuses Item GetPortfolioTransactionsStatusesItem- GetPortfolio
Transactions Types Item GetPortfolioTransactionsTypesItem- GetProtfolio
History ForUser Include Assets GetProtfolioHistoryForUserIncludeAssets- GetProtfolio
History ForUser Include Total Balance GetProtfolioHistoryForUserIncludeTotalBalance- GetProtfolio
History ForUser Include Total Pnl GetProtfolioHistoryForUserIncludeTotalPnl- GetProtfolio
History ForUser Interval GetProtfolioHistoryForUserInterval- GetQuote
Response Data Result Quoted Receive Asset Class GetQuoteResponseDataResultQuotedReceiveAssetClass- GetQuote
Response Data Result Quoted Spend Asset Class GetQuoteResponseDataResultQuotedSpendAssetClass- GetQuote
Response Data Result Quoted Unit Price Asset Class GetQuoteResponseDataResultQuotedUnitPriceAssetClass- GetQuote
Response Data Result Quoted Unit Price Denomination Asset Class GetQuoteResponseDataResultQuotedUnitPriceDenominationAssetClass- GetQuote
Response Data Result Receive Asset Class GetQuoteResponseDataResultReceiveAssetClass- GetQuote
Response Data Result Spend Asset Class GetQuoteResponseDataResultSpendAssetClass- GetQuote
Response Data Result Status GetQuoteResponseDataResultStatus- GetQuote
Response Data Result Type GetQuoteResponseDataResultType- GetQuote
Response Data Result Unit Price Asset Class GetQuoteResponseDataResultUnitPriceAssetClass- GetQuote
Response Data Result Unit Price Denomination Asset Class GetQuoteResponseDataResultUnitPriceDenominationAssetClass- GetStripe
Crypto Customer Response Data GetStripeCryptoCustomerResponseData- GetUser
Fiat KycLink Body Endorsements Item GetUserFiatKycLinkBodyEndorsementsItem- GetUser
Fiat KycLink Body Type GetUserFiatKycLinkBodyType- GetUser
Fiat KycLink Response KycStatus GetUserFiatKycLinkResponseKycStatus- GetUser
Fiat KycLink Response TosStatus GetUserFiatKycLinkResponseTosStatus- GetWallet
Balance Asset - Named asset(s) to query (e.g.
eth,usdc). Use together withchainto scope the query. Cannot be used withtoken. - GetWallet
Balance Chain - Chain(s) to query named assets on (e.g.
base,ethereum). Use together withasset. Cannot be used withtoken. - GetWallet
Balance Chain Array Item GetWalletBalanceChainArrayItem- GetWallet
Balance Chain String GetWalletBalanceChainString- GetWallet
Balance Include Currency - If set, balances are converted to the specified fiat currency. Not
supported when
tokenis provided. - GetWallet
Balance Response Balances Item Asset GetWalletBalanceResponseBalancesItemAsset- GetWallet
Balance Response Balances Item Chain GetWalletBalanceResponseBalancesItemChain- GetWallet
Balance Token - The token contract address(es) to query in format “chain:address” (e.g.,
“base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913” or
“solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v”). Cannot be used
together with
asset/chainor withinclude_currency. - HdInit
Input Entropy Type - The entropy type of the wallet to import.
- HdSubmit
Input Entropy Type - The entropy type of the wallet to import.
- Hpke
Aead Algorithm - The AEAD algorithm used for HPKE encryption.
- Hpke
Encryption - The encryption type of the wallet to import. Currently only supports
HPKE. - ICloud
Client Type - The client type for iCloud recovery operations.
- Initiate
User Fiat KycBody InitiateUserFiatKycBody- Initiate
User Fiat KycBody Bridge KycScreen Result InitiateUserFiatKycBodyBridgeKycScreenResult- Initiate
User Fiat KycBody Bridge Ofac Screen Result InitiateUserFiatKycBodyBridgeOfacScreenResult- Initiate
User Fiat KycBody Bridge Sandbox KycScreen Result InitiateUserFiatKycBodyBridgeSandboxKycScreenResult- Initiate
User Fiat KycBody Bridge Sandbox Ofac Screen Result InitiateUserFiatKycBodyBridgeSandboxOfacScreenResult- Initiate
User Fiat KycBody Bridge Sandbox Type InitiateUserFiatKycBodyBridgeSandboxType- Initiate
User Fiat KycBody Bridge Type InitiateUserFiatKycBodyBridgeType- Intent
Authorization KeyQuorum Member - A leaf member (user or key) of a nested key quorum in an intent authorization.
- Intent
Authorization Member - A member of an intent authorization quorum. Can be a user, key, or nested key quorum.
- Intent
Authorized Webhook Payload Type - The type of webhook event.
- Intent
Binding Type IntentBindingType- Intent
Created Webhook Payload Type - The type of webhook event.
- Intent
Executed Webhook Payload Type - The type of webhook event.
- Intent
Failed Webhook Payload Type - The type of webhook event.
- Intent
Rejected Webhook Payload Type - The type of webhook event.
- Intent
Response - Response for an intent object
- Intent
Status - Current status of an intent.
- Intent
Type - Type of intent.
- KeyQuorum
Intent Response Intent Type KeyQuorumIntentResponseIntentType- KeyQuorum
Intent Response Request Details Method KeyQuorumIntentResponseRequestDetailsMethod- Kraken
Embed Custom Order Action Type KrakenEmbedCustomOrderActionType- Kraken
Embed Custom Order Amount Asset Class KrakenEmbedCustomOrderAmountAssetClass- Kraken
Embed Custom Order Cancelled Webhook Payload Type - The type of webhook event.
- Kraken
Embed Custom Order Executed Webhook Payload Type - The type of webhook event.
- Kraken
Embed Custom Order Execution Failed Webhook Payload Type - The type of webhook event.
- Kraken
Embed Custom Order Occurrence Status KrakenEmbedCustomOrderOccurrenceStatus- Kraken
Embed Custom Order Occurrence Trigger Type KrakenEmbedCustomOrderOccurrenceTriggerType- Kraken
Embed Custom Order Status Status KrakenEmbedCustomOrderStatusStatus- Kraken
Embed Custom Order Trigger Condition KrakenEmbedCustomOrderTriggerCondition- Kraken
Embed Custom Order Trigger Type KrakenEmbedCustomOrderTriggerType- Kraken
Embed GetAsset List Query Params Schema Filter Platform Statuses Item KrakenEmbedGetAssetListQueryParamsSchemaFilterPlatformStatusesItem- Kraken
Embed GetAsset List Query Params Schema Filter Platform Statuses Item Variant0 KrakenEmbedGetAssetListQueryParamsSchemaFilterPlatformStatusesItemVariant0- Kraken
Embed GetAsset List Query Params Schema Sort KrakenEmbedGetAssetListQueryParamsSchemaSort- Kraken
Embed GetPortfolio Summary Query Params Include Current DayPnl KrakenEmbedGetPortfolioSummaryQueryParamsIncludeCurrentDayPnl- Kraken
Embed GetPortfolio Summary Response Data Result Current DayPnl KrakenEmbedGetPortfolioSummaryResponseDataResultCurrentDayPnl- Kraken
Embed GetPortfolio Transactions Query Params Schema RefIds Item Type KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaRefIdsItemType- Kraken
Embed GetPortfolio Transactions Query Params Schema Sorting KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaSorting- Kraken
Embed GetPortfolio Transactions Query Params Schema Statuses Item KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaStatusesItem- Kraken
Embed GetPortfolio Transactions Query Params Schema Types Item KrakenEmbedGetPortfolioTransactionsQueryParamsSchemaTypesItem- Kraken
Embed List Custom Orders Query Params Statuses KrakenEmbedListCustomOrdersQueryParamsStatuses- Kraken
Embed List Custom Orders Query Params Statuses Array Item KrakenEmbedListCustomOrdersQueryParamsStatusesArrayItem- Kraken
Embed Quote Cancelled Webhook Payload Type - The type of webhook event.
- Kraken
Embed Quote Executed Webhook Payload Type - The type of webhook event.
- Kraken
Embed Quote Execution Failed Webhook Payload Type - The type of webhook event.
- Kraken
Embed Start Address Metadata Address Country KrakenEmbedStartAddressMetadataAddressCountry- Kraken
Embed Start Address Metadata Document Type KrakenEmbedStartAddressMetadataDocumentType- Kraken
Embed Start Address Verification UrlInput Type KrakenEmbedStartAddressVerificationUrlInputType- Kraken
Embed Start Identity Metadata Document Type KrakenEmbedStartIdentityMetadataDocumentType- Kraken
Embed Start Identity Metadata Issuing Country KrakenEmbedStartIdentityMetadataIssuingCountry- Kraken
Embed Start Identity Metadata Nationality KrakenEmbedStartIdentityMetadataNationality- Kraken
Embed Start Identity Verification UrlInput Type KrakenEmbedStartIdentityVerificationUrlInputType- Kraken
Embed Start Liveness Verification UrlInput Type KrakenEmbedStartLivenessVerificationUrlInputType- Kraken
Embed Start Verification Debug Outcome KrakenEmbedStartVerificationDebugOutcome- Kraken
Embed Start Verification UrlInput - Discriminated union of all start verification URL input types.
- Kraken
Embed User Closed Webhook Payload Type - The type of webhook event.
- Kraken
Embed User Disabled Webhook Payload Type - The type of webhook event.
- Kraken
Embed User Verified Webhook Payload Type - The type of webhook event.
- Link
Auth Intent Created Status LinkAuthIntentCreatedStatus- Link
Auth Intent NoAccount Status LinkAuthIntentNoAccountStatus- Linked
Account - A linked account for the user.
- Linked
Account Apple Input Type LinkedAccountAppleInputType- Linked
Account Apple Oauth Type LinkedAccountAppleOauthType- Linked
Account Authorization KeyType LinkedAccountAuthorizationKeyType- Linked
Account Base Wallet Chain Type LinkedAccountBaseWalletChainType- Linked
Account Base Wallet Type LinkedAccountBaseWalletType- Linked
Account Bitcoin Segwit Embedded Wallet Chain Type LinkedAccountBitcoinSegwitEmbeddedWalletChainType- Linked
Account Bitcoin Segwit Embedded Wallet Connector Type LinkedAccountBitcoinSegwitEmbeddedWalletConnectorType- Linked
Account Bitcoin Segwit Embedded Wallet Type LinkedAccountBitcoinSegwitEmbeddedWalletType- Linked
Account Bitcoin Segwit Embedded Wallet Wallet Client LinkedAccountBitcoinSegwitEmbeddedWalletWalletClient- Linked
Account Bitcoin Segwit Embedded Wallet Wallet Client Type LinkedAccountBitcoinSegwitEmbeddedWalletWalletClientType- Linked
Account Bitcoin Taproot Embedded Wallet Chain Type LinkedAccountBitcoinTaprootEmbeddedWalletChainType- Linked
Account Bitcoin Taproot Embedded Wallet Connector Type LinkedAccountBitcoinTaprootEmbeddedWalletConnectorType- Linked
Account Bitcoin Taproot Embedded Wallet Type LinkedAccountBitcoinTaprootEmbeddedWalletType- Linked
Account Bitcoin Taproot Embedded Wallet Wallet Client LinkedAccountBitcoinTaprootEmbeddedWalletWalletClient- Linked
Account Bitcoin Taproot Embedded Wallet Wallet Client Type LinkedAccountBitcoinTaprootEmbeddedWalletWalletClientType- Linked
Account Cross AppType LinkedAccountCrossAppType- Linked
Account Curve Signing Embedded Wallet Connector Type LinkedAccountCurveSigningEmbeddedWalletConnectorType- Linked
Account Curve Signing Embedded Wallet Type LinkedAccountCurveSigningEmbeddedWalletType- Linked
Account Curve Signing Embedded Wallet Wallet Client LinkedAccountCurveSigningEmbeddedWalletWalletClient- Linked
Account Curve Signing Embedded Wallet Wallet Client Type LinkedAccountCurveSigningEmbeddedWalletWalletClientType- Linked
Account Custom JwtInput Type LinkedAccountCustomJwtInputType- Linked
Account Custom JwtType LinkedAccountCustomJwtType- Linked
Account Discord Input Type LinkedAccountDiscordInputType- Linked
Account Discord Oauth Type LinkedAccountDiscordOauthType- Linked
Account Email Input Type LinkedAccountEmailInputType- Linked
Account Email Type LinkedAccountEmailType- Linked
Account Embedded Wallet - A linked embedded wallet account across all supported chain types.
- Linked
Account Embedded Wallet With Id - An embedded wallet account with an ID.
- Linked
Account Embedded Wallet With IdVariant0 Chain Type LinkedAccountEmbeddedWalletWithIdVariant0ChainType- Linked
Account Embedded Wallet With IdVariant0 Connector Type LinkedAccountEmbeddedWalletWithIdVariant0ConnectorType- Linked
Account Embedded Wallet With IdVariant0 Recovery Method LinkedAccountEmbeddedWalletWithIdVariant0RecoveryMethod- Linked
Account Embedded Wallet With IdVariant0 Type LinkedAccountEmbeddedWalletWithIdVariant0Type- Linked
Account Embedded Wallet With IdVariant0 Wallet Client LinkedAccountEmbeddedWalletWithIdVariant0WalletClient- Linked
Account Embedded Wallet With IdVariant0 Wallet Client Type LinkedAccountEmbeddedWalletWithIdVariant0WalletClientType- Linked
Account Embedded Wallet With IdVariant1 Chain Type LinkedAccountEmbeddedWalletWithIdVariant1ChainType- Linked
Account Embedded Wallet With IdVariant1 Connector Type LinkedAccountEmbeddedWalletWithIdVariant1ConnectorType- Linked
Account Embedded Wallet With IdVariant1 Recovery Method LinkedAccountEmbeddedWalletWithIdVariant1RecoveryMethod- Linked
Account Embedded Wallet With IdVariant1 Type LinkedAccountEmbeddedWalletWithIdVariant1Type- Linked
Account Embedded Wallet With IdVariant1 Wallet Client LinkedAccountEmbeddedWalletWithIdVariant1WalletClient- Linked
Account Embedded Wallet With IdVariant1 Wallet Client Type LinkedAccountEmbeddedWalletWithIdVariant1WalletClientType- Linked
Account Embedded Wallet With IdVariant2 Chain Type LinkedAccountEmbeddedWalletWithIdVariant2ChainType- Linked
Account Embedded Wallet With IdVariant2 Connector Type LinkedAccountEmbeddedWalletWithIdVariant2ConnectorType- Linked
Account Embedded Wallet With IdVariant2 Recovery Method LinkedAccountEmbeddedWalletWithIdVariant2RecoveryMethod- Linked
Account Embedded Wallet With IdVariant2 Type LinkedAccountEmbeddedWalletWithIdVariant2Type- Linked
Account Embedded Wallet With IdVariant2 Wallet Client LinkedAccountEmbeddedWalletWithIdVariant2WalletClient- Linked
Account Embedded Wallet With IdVariant2 Wallet Client Type LinkedAccountEmbeddedWalletWithIdVariant2WalletClientType- Linked
Account Embedded Wallet With IdVariant3 Chain Type LinkedAccountEmbeddedWalletWithIdVariant3ChainType- Linked
Account Embedded Wallet With IdVariant3 Connector Type LinkedAccountEmbeddedWalletWithIdVariant3ConnectorType- Linked
Account Embedded Wallet With IdVariant3 Recovery Method LinkedAccountEmbeddedWalletWithIdVariant3RecoveryMethod- Linked
Account Embedded Wallet With IdVariant3 Type LinkedAccountEmbeddedWalletWithIdVariant3Type- Linked
Account Embedded Wallet With IdVariant3 Wallet Client LinkedAccountEmbeddedWalletWithIdVariant3WalletClient- Linked
Account Embedded Wallet With IdVariant3 Wallet Client Type LinkedAccountEmbeddedWalletWithIdVariant3WalletClientType- Linked
Account Embedded Wallet With IdVariant4 Connector Type LinkedAccountEmbeddedWalletWithIdVariant4ConnectorType- Linked
Account Embedded Wallet With IdVariant4 Recovery Method LinkedAccountEmbeddedWalletWithIdVariant4RecoveryMethod- Linked
Account Embedded Wallet With IdVariant4 Type LinkedAccountEmbeddedWalletWithIdVariant4Type- Linked
Account Embedded Wallet With IdVariant4 Wallet Client LinkedAccountEmbeddedWalletWithIdVariant4WalletClient- Linked
Account Embedded Wallet With IdVariant4 Wallet Client Type LinkedAccountEmbeddedWalletWithIdVariant4WalletClientType- Linked
Account Ethereum Chain Type LinkedAccountEthereumChainType- Linked
Account Ethereum Embedded Wallet Chain Type LinkedAccountEthereumEmbeddedWalletChainType- Linked
Account Ethereum Embedded Wallet Connector Type LinkedAccountEthereumEmbeddedWalletConnectorType- Linked
Account Ethereum Embedded Wallet Type LinkedAccountEthereumEmbeddedWalletType- Linked
Account Ethereum Embedded Wallet Wallet Client LinkedAccountEthereumEmbeddedWalletWalletClient- Linked
Account Ethereum Embedded Wallet Wallet Client Type LinkedAccountEthereumEmbeddedWalletWalletClientType- Linked
Account Ethereum Type LinkedAccountEthereumType- Linked
Account Ethereum Wallet Client LinkedAccountEthereumWalletClient- Linked
Account Farcaster Input Type LinkedAccountFarcasterInputType- Linked
Account Farcaster Type LinkedAccountFarcasterType- Linked
Account Github Input Type LinkedAccountGithubInputType- Linked
Account Github Oauth Type LinkedAccountGithubOauthType- Linked
Account Google Input Type LinkedAccountGoogleInputType- Linked
Account Google Oauth Type LinkedAccountGoogleOauthType- Linked
Account Input - The input for adding a linked account to a user.
- Linked
Account Instagram Input Type LinkedAccountInstagramInputType- Linked
Account Instagram Oauth Type LinkedAccountInstagramOauthType- Linked
Account Line Input Type LinkedAccountLineInputType- Linked
Account Line Oauth Type LinkedAccountLineOauthType- Linked
Account Linked InInput Type LinkedAccountLinkedInInputType- Linked
Account Linked InOauth Type LinkedAccountLinkedInOauthType- Linked
Account Passkey Input Credential Device Type LinkedAccountPasskeyInputCredentialDeviceType- Linked
Account Passkey Input Type LinkedAccountPasskeyInputType- Linked
Account Passkey Type LinkedAccountPasskeyType- Linked
Account Phone Input Type LinkedAccountPhoneInputType- Linked
Account Phone Type LinkedAccountPhoneType- Linked
Account Smart Wallet Type LinkedAccountSmartWalletType- Linked
Account Solana Chain Type LinkedAccountSolanaChainType- Linked
Account Solana Embedded Wallet Chain Type LinkedAccountSolanaEmbeddedWalletChainType- Linked
Account Solana Embedded Wallet Connector Type LinkedAccountSolanaEmbeddedWalletConnectorType- Linked
Account Solana Embedded Wallet Type LinkedAccountSolanaEmbeddedWalletType- Linked
Account Solana Embedded Wallet Wallet Client LinkedAccountSolanaEmbeddedWalletWalletClient- Linked
Account Solana Embedded Wallet Wallet Client Type LinkedAccountSolanaEmbeddedWalletWalletClientType- Linked
Account Solana Type LinkedAccountSolanaType- Linked
Account Solana Wallet Client LinkedAccountSolanaWalletClient- Linked
Account Spotify Input Type LinkedAccountSpotifyInputType- Linked
Account Spotify Oauth Type LinkedAccountSpotifyOauthType- Linked
Account Telegram Input Type LinkedAccountTelegramInputType- Linked
Account Telegram Type LinkedAccountTelegramType- Linked
Account Tiktok Input Type LinkedAccountTiktokInputType- Linked
Account Tiktok Oauth Type LinkedAccountTiktokOauthType- Linked
Account Twitch Input Type LinkedAccountTwitchInputType- Linked
Account Twitch Oauth Type LinkedAccountTwitchOauthType- Linked
Account Twitter Input Type LinkedAccountTwitterInputType- Linked
Account Twitter Oauth Type LinkedAccountTwitterOauthType- Linked
Account Type - The possible types of linked accounts.
- Linked
Account Type Variant0 LinkedAccountTypeVariant0- Linked
Account Type Variant1 LinkedAccountTypeVariant1- Linked
Account Type Variant2 LinkedAccountTypeVariant2- Linked
Account Type Variant3 LinkedAccountTypeVariant3- Linked
Account Type Variant4 LinkedAccountTypeVariant4- Linked
Account Type Variant5 LinkedAccountTypeVariant5- Linked
Account Type Variant6 LinkedAccountTypeVariant6- Linked
Account Type Variant7 LinkedAccountTypeVariant7- Linked
Account Type Variant8 LinkedAccountTypeVariant8- Linked
Account Type Variant9 LinkedAccountTypeVariant9- Linked
Account Type Variant10 LinkedAccountTypeVariant10- Linked
Account Type Variant11 LinkedAccountTypeVariant11- Linked
Account Type Variant12 LinkedAccountTypeVariant12- Linked
Account Type Variant13 LinkedAccountTypeVariant13- Linked
Account Type Variant14 LinkedAccountTypeVariant14- Linked
Account Type Variant16 LinkedAccountTypeVariant16- Linked
Account Type Variant17 LinkedAccountTypeVariant17- Linked
Account Type Variant18 LinkedAccountTypeVariant18- Linked
Account Type Variant19 LinkedAccountTypeVariant19- Linked
Account Type Variant20 LinkedAccountTypeVariant20- Linked
Account Type Variant21 LinkedAccountTypeVariant21- Linked
Account Wallet Input Address LinkedAccountWalletInputAddress- Linked
Account Wallet Input Chain Type LinkedAccountWalletInputChainType- Linked
Account Wallet Input Type LinkedAccountWalletInputType- Linked
MfaMethod - A multi-factor authentication method linked to the user.
- List
Assets Filter Platform Statuses Item ListAssetsFilterPlatformStatusesItem- List
Assets Filter Platform Statuses Item Variant0 ListAssetsFilterPlatformStatusesItemVariant0- List
Assets Response Data Result Assets Item Platform Status ListAssetsResponseDataResultAssetsItemPlatformStatus- List
Assets Response Data Result Assets Item Platform Status Variant0 ListAssetsResponseDataResultAssetsItemPlatformStatusVariant0- List
Assets Response Data Result Assets Item User Status ListAssetsResponseDataResultAssetsItemUserStatus- List
Assets Response Data Result Assets Item User Status Variant0 ListAssetsResponseDataResultAssetsItemUserStatusVariant0- List
Assets Sort ListAssetsSort- List
Intents Current User HasSigned ListIntentsCurrentUserHasSigned- List
Intents Sort By ListIntentsSortBy- Look
UpUser ByWallet Address Body Address LookUpUserByWalletAddressBodyAddress- MfaDisabled
Webhook Payload Method - The MFA method that was disabled.
- MfaDisabled
Webhook Payload Type - The type of webhook event.
- MfaEnabled
Webhook Payload Method - The MFA method that was enabled.
- MfaEnabled
Webhook Payload Type - The type of webhook event.
- MfaSms
Init Enroll Input Action MfaSmsInitEnrollInputAction- MfaSms
Init Request Body - The request body for initiating a SMS MFA flow.
- MfaSms
Init Verify Input Action MfaSmsInitVerifyInputAction- Moonpay
Currency Code - A Moonpay currency code for an Ethereum-compatible chain asset.
- Moonpay
OnRamp Sign Input - The input for signing a Moonpay on-ramp.
- Moonpay
Payment Method - A payment method supported by Moonpay on-ramp.
- Moonpay
Solana Currency Code - A Moonpay currency code for a Solana asset.
- Moonpay
UiTheme - The theme for the Moonpay on-ramp widget.
- OAuth
Code Type - The type of OAuth authorization code.
- OAuth
Grant Grant Type - The OAuth grant type that created this grant.
- OAuth
Provider Id - The ID of an OAuth provider.
- OAuth
Token Authorization Code Request Body Grant Type OAuthTokenAuthorizationCodeRequestBodyGrantType- OAuth
Token Device Code Pending Error Error - The error code indicating why the token request failed.
- OAuth
Token Device Code Request Body Grant Type OAuthTokenDeviceCodeRequestBodyGrantType- OAuth
Token Grant Type - The OAuth grant type for the token request.
- OAuth
Token Refresh Token Request Body Grant Type OAuthTokenRefreshTokenRequestBodyGrantType- OAuth
Token Request Body - Request body for the OAuth token endpoint, discriminated by grant_type.
- OAuth
Token Success Response Token Type - The type of token issued.
- Onramp
Asset - Supported crypto assets for onramp and offramp.
- Onramp
Chain - Supported blockchain chains for onramp and offramp.
- Onramp
KycStatus - Status of the KYC verification process.
- Onramp
Provider - Valid set of onramp providers
- Onramp
Transfer Status - Status of an onramp or offramp transfer.
- Owner
Input - The owner of the resource, specified as a Privy user ID, a P-256 public key, or null to remove the current owner.
- Passkey
Authenticator Enrollment Response Type PasskeyAuthenticatorEnrollmentResponseType- Passkey
Authenticator Verify Response Type PasskeyAuthenticatorVerifyResponseType- Passkey
MfaMethod Type PasskeyMfaMethodType- Passkey
PubKey Cred Param Type PasskeyPubKeyCredParamType- Phone
Invite Input Type PhoneInviteInputType- Policy
Action - The action to take when a policy rule matches.
- Policy
Condition - A condition that must be true for the rule action to be applied.
- Policy
Intent Request Details Method PolicyIntentRequestDetailsMethod- Policy
Intent Response Intent Type PolicyIntentResponseIntentType- Policy
Intent Response Request Details Method PolicyIntentResponseRequestDetailsMethod- Policy
Method - Method the rule applies to.
- Policy
Version - Version of the policy. Currently, 1.0 is the only version.
- Private
KeyExport Webhook Payload Export Source PrivateKeyExportWebhookPayloadExportSource- Private
KeyExport Webhook Payload Type - The type of webhook event.
- Private
KeyInit Input Entropy Type PrivateKeyInitInputEntropyType- Private
KeySubmit Input Entropy Type PrivateKeySubmitInputEntropyType- Privy
FeeRecipient PrivyFeeRecipient- Privy
FeeType PrivyFeeType- Quantity
- A quantity value that can be either a hex string starting with ‘0x’ or a non-negative integer.
- RawSign
Bytes Encoding - Encoding scheme for bytes in the
raw_signRPC. - RawSign
Bytes Hash Function - Hash function for bytes in the
raw_signRPC. - RawSign
Input Params - Parameters for the
raw_signRPC. - RawSign
Response Data Encoding RawSignResponseDataEncoding- RawSign
Response Method RawSignResponseMethod- Recipient
Public Key - The recipient public key for HPKE encryption, in PEM or DER (base64-encoded) format.
- Recovery
Type - The type of recovery mechanism used for wallet recovery.
- Relayer
FeeRecipient RelayerFeeRecipient- Relayer
FeeType RelayerFeeType- Request
Quote Body Amount Asset Class RequestQuoteBodyAmountAssetClass- Request
Quote Body Type RequestQuoteBodyType- Request
Quote Response Data Result Quoted Receive Asset Class RequestQuoteResponseDataResultQuotedReceiveAssetClass- Request
Quote Response Data Result Quoted Spend Asset Class RequestQuoteResponseDataResultQuotedSpendAssetClass- Request
Quote Response Data Result Quoted Unit Price Asset Class RequestQuoteResponseDataResultQuotedUnitPriceAssetClass- Request
Quote Response Data Result Quoted Unit Price Denomination Asset Class RequestQuoteResponseDataResultQuotedUnitPriceDenominationAssetClass- Request
Quote Response Data Result Receive Asset Class RequestQuoteResponseDataResultReceiveAssetClass- Request
Quote Response Data Result Spend Asset Class RequestQuoteResponseDataResultSpendAssetClass- Request
Quote Response Data Result Status RequestQuoteResponseDataResultStatus- Request
Quote Response Data Result Type RequestQuoteResponseDataResultType- Request
Quote Response Data Result Unit Price Asset Class RequestQuoteResponseDataResultUnitPriceAssetClass- Request
Quote Response Data Result Unit Price Denomination Asset Class RequestQuoteResponseDataResultUnitPriceDenominationAssetClass- RpcIntent
Request Details Method RpcIntentRequestDetailsMethod- RpcIntent
Response Intent Type RpcIntentResponseIntentType- RpcIntent
Response Request Details Method RpcIntentResponseRequestDetailsMethod- Rule
Delete Intent Response Intent Type RuleDeleteIntentResponseIntentType- Rule
Intent Create Request Details Method RuleIntentCreateRequestDetailsMethod- Rule
Intent Delete Request Details Method RuleIntentDeleteRequestDetailsMethod- Rule
Intent Request Details - The original rule request. Method is POST (create), PATCH (update), or DELETE (delete)
- Rule
Intent Response Intent Type RuleIntentResponseIntentType- Rule
Intent Update Request Details Method RuleIntentUpdateRequestDetailsMethod- Rule
Mutate Intent Response Intent Type RuleMutateIntentResponseIntentType- Search
Users Body SearchUsersBody- Search
Users Body Variant1 Wallet Addresses Item SearchUsersBodyVariant1WalletAddressesItem- Seed
Phrase Export Webhook Payload Export Source SeedPhraseExportWebhookPayloadExportSource- Seed
Phrase Export Webhook Payload Type - The type of webhook event.
- Signing
Algorithm - The signing algorithm used by the wallet.
- Siws
Authenticate Request Body Message Type SiwsAuthenticateRequestBodyMessageType- Siws
Input Message Type SiwsInputMessageType- Siws
Link Request Body Message Type SiwsLinkRequestBodyMessageType- Smart
Wallet Configuration - The configuration object for smart wallets.
- Smart
Wallet Configuration Input - The input configuration object for smart wallets.
- Smart
Wallet Type - The supported smart wallet providers.
- SmsMfa
Method Type SmsMfaMethodType- Solana
Program Instruction Condition Field SolanaProgramInstructionConditionField- Solana
Program Instruction Condition Field Source SolanaProgramInstructionConditionFieldSource- Solana
RpcInput - Request body for Solana wallet RPC operations, discriminated by method.
- Solana
RpcResponse - Response body for Solana wallet RPC operations, discriminated by method.
- Solana
Sign AndSend Transaction RpcInput Chain Type SolanaSignAndSendTransactionRpcInputChainType- Solana
Sign AndSend Transaction RpcInput Method SolanaSignAndSendTransactionRpcInputMethod- Solana
Sign AndSend Transaction RpcInput Params Encoding SolanaSignAndSendTransactionRpcInputParamsEncoding- Solana
Sign AndSend Transaction RpcResponse Method SolanaSignAndSendTransactionRpcResponseMethod- Solana
Sign Message RpcInput Chain Type SolanaSignMessageRpcInputChainType- Solana
Sign Message RpcInput Method SolanaSignMessageRpcInputMethod- Solana
Sign Message RpcInput Params Encoding SolanaSignMessageRpcInputParamsEncoding- Solana
Sign Message RpcResponse Data Encoding SolanaSignMessageRpcResponseDataEncoding- Solana
Sign Message RpcResponse Method SolanaSignMessageRpcResponseMethod- Solana
Sign Transaction RpcInput Chain Type SolanaSignTransactionRpcInputChainType- Solana
Sign Transaction RpcInput Method SolanaSignTransactionRpcInputMethod- Solana
Sign Transaction RpcInput Params Encoding SolanaSignTransactionRpcInputParamsEncoding- Solana
Sign Transaction RpcResponse Data Encoding SolanaSignTransactionRpcResponseDataEncoding- Solana
Sign Transaction RpcResponse Method SolanaSignTransactionRpcResponseMethod- Solana
System Program Instruction Condition Field SolanaSystemProgramInstructionConditionField- Solana
System Program Instruction Condition Field Source SolanaSystemProgramInstructionConditionFieldSource- Solana
Token Program Instruction Condition Field SolanaTokenProgramInstructionConditionField- Solana
Token Program Instruction Condition Field Source SolanaTokenProgramInstructionConditionFieldSource- Solana
Wallet Derivation Strategy - The derivation strategy used for Solana wallets.
- Spark
Claim Static Deposit RpcInput Method SparkClaimStaticDepositRpcInputMethod- Spark
Claim Static Deposit RpcResponse Method SparkClaimStaticDepositRpcResponseMethod- Spark
Create Lightning Invoice RpcInput Method SparkCreateLightningInvoiceRpcInputMethod- Spark
Create Lightning Invoice RpcResponse Method SparkCreateLightningInvoiceRpcResponseMethod- Spark
GetBalance RpcInput Method SparkGetBalanceRpcInputMethod- Spark
GetBalance RpcResponse Method SparkGetBalanceRpcResponseMethod- Spark
GetClaim Static Deposit Quote RpcInput Method SparkGetClaimStaticDepositQuoteRpcInputMethod- Spark
GetClaim Static Deposit Quote RpcResponse Method SparkGetClaimStaticDepositQuoteRpcResponseMethod- Spark
GetStatic Deposit Address RpcInput Method SparkGetStaticDepositAddressRpcInputMethod- Spark
GetStatic Deposit Address RpcResponse Method SparkGetStaticDepositAddressRpcResponseMethod- Spark
Network - The Spark network.
- Spark
Output Selection Strategy - Strategy for selecting outputs in a Spark token transfer.
- Spark
PayLightning Invoice RpcInput Method SparkPayLightningInvoiceRpcInputMethod- Spark
PayLightning Invoice RpcResponse Data SparkPayLightningInvoiceRpcResponseData- Spark
PayLightning Invoice RpcResponse Method SparkPayLightningInvoiceRpcResponseMethod- Spark
RpcInput - Request body for Spark wallet RPC operations, discriminated by method.
- Spark
RpcResponse - Response body for Spark wallet RPC operations, discriminated by method.
- Spark
Sign Message With Identity KeyRpc Input Method SparkSignMessageWithIdentityKeyRpcInputMethod- Spark
Sign Message With Identity KeyRpc Response Method SparkSignMessageWithIdentityKeyRpcResponseMethod- Spark
Transfer RpcInput Method SparkTransferRpcInputMethod- Spark
Transfer RpcResponse Method SparkTransferRpcResponseMethod- Spark
Transfer Tokens RpcInput Method SparkTransferTokensRpcInputMethod- Spark
Transfer Tokens RpcResponse Method SparkTransferTokensRpcResponseMethod- Stripe
Crypto Customer Active Status StripeCryptoCustomerActiveStatus- Stripe
Crypto Customer Expired Status StripeCryptoCustomerExpiredStatus- Stripe
Crypto Customer None Status StripeCryptoCustomerNoneStatus- Stripe
Onramp Session Status - The state of the user’s Stripe onramp session.
- Submit
User Verification From UrlBody SubmitUserVerificationFromUrlBody- Submit
User Verification From UrlBody Metadata Address Country SubmitUserVerificationFromUrlBodyMetadataAddressCountry- Submit
User Verification From UrlBody Metadata Country SubmitUserVerificationFromUrlBodyMetadataCountry- Submit
User Verification From UrlBody Metadata Document Type SubmitUserVerificationFromUrlBodyMetadataDocumentType- Submit
User Verification From UrlBody Metadata Issuing Country SubmitUserVerificationFromUrlBodyMetadataIssuingCountry- Submit
User Verification From UrlBody Metadata Nationality SubmitUserVerificationFromUrlBodyMetadataNationality- Submit
User Verification From UrlBody Metadata Negative News Status SubmitUserVerificationFromUrlBodyMetadataNegativeNewsStatus- Submit
User Verification From UrlBody Metadata PepStatus SubmitUserVerificationFromUrlBodyMetadataPepStatus- Submit
User Verification From UrlBody Metadata Sanctions Status SubmitUserVerificationFromUrlBodyMetadataSanctionsStatus- Submit
User Verification From UrlBody Metadata Selfie Type SubmitUserVerificationFromUrlBodyMetadataSelfieType- Submit
User Verification From UrlBody Metadata TaxId Type SubmitUserVerificationFromUrlBodyMetadataTaxIdType- SuiCommand
Name - SUI transaction commands allowlist for raw_sign endpoint policy evaluation
- SuiTransaction
Command Condition Field SuiTransactionCommandConditionField- SuiTransaction
Command Condition Field Source SuiTransactionCommandConditionFieldSource- SuiTransaction
Command Condition Value - Command name(s) to match. Must be one of: ‘TransferObjects’, ‘SplitCoins’, ‘MergeCoins’
- SuiTransaction
Command Operator - Operator to use for SUI transaction command conditions. Only ‘eq’ and ‘in’ are supported for command names.
- SuiTransfer
Objects Command Condition Field Source SuiTransferObjectsCommandConditionFieldSource- SuiTransfer
Objects Command Field - Supported fields for SUI TransferObjects command conditions. Only ‘recipient’ and ‘amount’ are supported.
- SvmTransaction
Wallet Action Step Type SvmTransactionWalletActionStepType- SvmWallet
Action Step Status - Status of an SVM step in a wallet action.
- Swap
Action Response Type SwapActionResponseType- System
Condition Field SystemConditionField- System
Condition Field Source SystemConditionFieldSource- Tempo
FeePayer SignatureY Parity TempoFeePayerSignatureYParity- Tempo
Transaction Condition Field - Tempo (type 118) transaction-level fields that can be referenced in a policy condition.
- Tempo
Transaction Condition Field Source TempoTransactionConditionFieldSource- Token
Transfer Destination Address - Recipient address (hex for EVM, base58 for Solana, base58check for Tron)
- Token
Transfer Source - The source asset, amount, and chain for a token transfer. Specify either
asset(named) orasset_address(custom), not both. - Total
FeeConfiguration BpsType - Discriminator: total fee specified in BPS.
- Totp
MfaMethod Type TotpMfaMethodType- Transaction
Broadcasted Webhook Payload Type - The type of webhook event.
- Transaction
Confirmed Webhook Payload Type - The type of webhook event.
- Transaction
Detail - Details of a wallet transaction, varying by transaction type.
- Transaction
Execution Reverted Webhook Payload Type - The type of webhook event.
- Transaction
Failed Webhook Payload Type - The type of webhook event.
- Transaction
Provider Error Webhook Payload Type - The type of webhook event.
- Transaction
Replaced Webhook Payload Type - The type of webhook event.
- Transaction
Scanning Simulation Error Result Status TransactionScanningSimulationErrorResultStatus- Transaction
Scanning Simulation Result - The simulation result from a transaction scan.
- Transaction
Scanning Simulation Success Result Status TransactionScanningSimulationSuccessResultStatus- Transaction
Scanning Validation Error Result Status TransactionScanningValidationErrorResultStatus- Transaction
Scanning Validation Result - The validation result from a transaction scan.
- Transaction
Scanning Validation Success Result Status TransactionScanningValidationSuccessResultStatus- Transaction
Status TransactionStatus- Transaction
Still Pending Webhook Payload Type - The type of webhook event.
- Transfer
Action Response Type TransferActionResponseType- Transfer
Intent Request Details Method TransferIntentRequestDetailsMethod- Transfer
Intent Response Intent Type TransferIntentResponseIntentType- Transfer
Intent Response Request Details Method TransferIntentResponseRequestDetailsMethod- Transfer
Received Transaction Detail Asset TransferReceivedTransactionDetailAsset- Transfer
Received Transaction Detail Chain TransferReceivedTransactionDetailChain- Transfer
Received Transaction Detail Type TransferReceivedTransactionDetailType- Transfer
Sent Transaction Detail Asset TransferSentTransactionDetailAsset- Transfer
Sent Transaction Detail Chain TransferSentTransactionDetailChain- Transfer
Sent Transaction Detail Type TransferSentTransactionDetailType- Tron
Calldata Condition Field Source TronCalldataConditionFieldSource- Tron
Transaction Condition Field - Supported TRON transaction fields in format “TransactionType.field_name”
- Tron
Transaction Condition Field Source TronTransactionConditionFieldSource- Unsigned
Ethereum Transaction - An unsigned Ethereum transaction object. Supports standard EVM transaction types (0, 1, 2, 4) and Tempo transactions (type 118).
- Unsigned
Standard Ethereum Transaction Type UnsignedStandardEthereumTransactionType- Update
Account Input - Input for updating a digital asset account.
- Update
User Fiat KycStatus Body UpdateUserFiatKycStatusBody- Update
User Fiat KycStatus Body Bridge KycScreen Result UpdateUserFiatKycStatusBodyBridgeKycScreenResult- Update
User Fiat KycStatus Body Bridge Ofac Screen Result UpdateUserFiatKycStatusBodyBridgeOfacScreenResult- Update
User Fiat KycStatus Body Bridge Sandbox KycScreen Result UpdateUserFiatKycStatusBodyBridgeSandboxKycScreenResult- Update
User Fiat KycStatus Body Bridge Sandbox Ofac Screen Result UpdateUserFiatKycStatusBodyBridgeSandboxOfacScreenResult- Update
User Fiat KycStatus Body Bridge Sandbox Type UpdateUserFiatKycStatusBodyBridgeSandboxType- Update
User Fiat KycStatus Body Bridge Type UpdateUserFiatKycStatusBodyBridgeType- User
Authenticated Webhook Payload Type - The type of webhook event.
- User
Created Webhook Payload Type - The type of webhook event.
- User
Fiat Statuses Response Transactions Item UserFiatStatusesResponseTransactionsItem- User
Invite Input - Input for adding or removing an allowlist entry. Discriminated by type.
- User
Linked Account Webhook Payload Type - The type of webhook event.
- User
Operation Completed Webhook Payload Type - The type of webhook event.
- User
Owned Recovery Option - A user-owned recovery option for embedded wallets.
- User
Transferred Account Webhook Payload Type - The type of webhook event.
- User
Unlinked Account Webhook Payload Type - The type of webhook event.
- User
Updated Account Webhook Payload Type - The type of webhook event.
- User
Wallet Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Deposit Created Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Deposit Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Deposit Failed Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Deposit Failed Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Deposit Rejected Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Deposit Rejected Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Deposit Succeeded Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Deposit Succeeded Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Incentive Claim Created Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Incentive Claim Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Incentive Claim Failed Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Incentive Claim Failed Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Incentive Claim Rejected Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Incentive Claim Rejected Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Incentive Claim Succeeded Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Incentive Claim Succeeded Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Withdraw Created Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Withdraw Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Withdraw Failed Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Withdraw Failed Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Withdraw Rejected Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Withdraw Rejected Webhook Payload Type - The type of webhook event.
- Wallet
Action Earn Withdraw Succeeded Webhook Payload Status - The status of the wallet action.
- Wallet
Action Earn Withdraw Succeeded Webhook Payload Type - The type of webhook event.
- Wallet
Action Response - Response for a wallet action, discriminated on type.
- Wallet
Action Status - Status of a wallet action.
- Wallet
Action Step - A step within a wallet action, representing a single onchain action.
- Wallet
Action Step Type - Type of a wallet action step.
- Wallet
Action Swap Created Webhook Payload Status - The status of the wallet action.
- Wallet
Action Swap Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Swap Failed Webhook Payload Status - The status of the wallet action.
- Wallet
Action Swap Failed Webhook Payload Type - The type of webhook event.
- Wallet
Action Swap Rejected Webhook Payload Status - The status of the wallet action.
- Wallet
Action Swap Rejected Webhook Payload Type - The type of webhook event.
- Wallet
Action Swap Succeeded Webhook Payload Status - The status of the wallet action.
- Wallet
Action Swap Succeeded Webhook Payload Type - The type of webhook event.
- Wallet
Action Transfer Created Webhook Payload Status - The status of the wallet action.
- Wallet
Action Transfer Created Webhook Payload Type - The type of webhook event.
- Wallet
Action Transfer Failed Webhook Payload Status - The status of the wallet action.
- Wallet
Action Transfer Failed Webhook Payload Type - The type of webhook event.
- Wallet
Action Transfer Rejected Webhook Payload Status - The status of the wallet action.
- Wallet
Action Transfer Rejected Webhook Payload Type - The type of webhook event.
- Wallet
Action Transfer Succeeded Webhook Payload Status - The status of the wallet action.
- Wallet
Action Transfer Succeeded Webhook Payload Type - The type of webhook event.
- Wallet
Action Type - Type of wallet action
- Wallet
Asset - A named asset supported across all chains.
- Wallet
Authenticate Bound Encrypted Request Body Encryption Type WalletAuthenticateBoundEncryptedRequestBodyEncryptionType- Wallet
Authenticate Bound Request Body - Request body for creating a user signing key scoped to specific bindings. The returned USK can only authorize the bound values and cannot sign other RPC requests.
- Wallet
Authenticate Intents Response - The response from authenticating a wallet with intent bindings, containing an authorization key, wallet data, and the bindings the key is scoped to.
- Wallet
Authenticate Request Body Encryption Type - The encryption type for the authentication response. Currently only supports HPKE.
- Wallet
Authenticate With JwtResponse - The response from authenticating a wallet, containing an authorization key and wallet data.
- Wallet
Batch Create Result - A single result from a batch wallet creation operation.
- Wallet
Chain Type - The wallet chain types.
- Wallet
Entropy Type - The entropy type of the wallet.
- Wallet
Ethereum Asset - A named asset on Ethereum-compatible chains.
- Wallet
Funds Asset - An asset involved in a wallet transfer.
- Wallet
Funds Erc20 Asset Type WalletFundsErc20AssetType- Wallet
Funds Native Token Asset Type WalletFundsNativeTokenAssetType- Wallet
Funds SacAsset Type WalletFundsSacAssetType- Wallet
Funds SplAsset Type WalletFundsSplAssetType- Wallet
Import Init Body WalletImportInitBody- Wallet
Import Submission Request Wallet WalletImportSubmissionRequestWallet- Wallet
Import Supported Chains - The chain type of the wallet to import. Currently supports
ethereumandsolana. - Wallet
Import Supported Entropy Types - The entropy type of the wallet to import. Supports
private-keyfor raw private keys andhdfor HD wallet seed phrases. - Wallet
Intent Response Intent Type WalletIntentResponseIntentType- Wallet
Intent Response Request Details Method WalletIntentResponseRequestDetailsMethod- Wallet
Invite Input Type WalletInviteInputType- Wallet
Invite Input Value WalletInviteInputValue- Wallet
Recovered Webhook Payload Type - The type of webhook event.
- Wallet
Recovery Setup Webhook Payload Method - The recovery method that was set up.
- Wallet
Recovery Setup Webhook Payload Type - The type of webhook event.
- Wallet
RpcRequest Body - Request body for wallet RPC operations, discriminated by method.
- Wallet
RpcResponse - Response body for wallet RPC operations, discriminated by method.
- Wallet
Solana Asset - A named asset on Solana.
- Wallet
Transactions Asset - Exactly one of
assetortokenis required. Cannot be used together withtoken. - Wallet
Transactions Chain WalletTransactionsChain- Wallet
Transactions Response Transactions Item Details WalletTransactionsResponseTransactionsItemDetails- Wallet
Transactions Response Transactions Item Details Variant0 Asset WalletTransactionsResponseTransactionsItemDetailsVariant0Asset- Wallet
Transactions Response Transactions Item Details Variant0 Asset Variant0 WalletTransactionsResponseTransactionsItemDetailsVariant0AssetVariant0- Wallet
Transactions Response Transactions Item Details Variant0 Asset Variant0 String WalletTransactionsResponseTransactionsItemDetailsVariant0AssetVariant0String- Wallet
Transactions Response Transactions Item Details Variant0 Asset Variant1 WalletTransactionsResponseTransactionsItemDetailsVariant0AssetVariant1- Wallet
Transactions Response Transactions Item Details Variant0 Asset Variant2 WalletTransactionsResponseTransactionsItemDetailsVariant0AssetVariant2- Wallet
Transactions Response Transactions Item Details Variant0 Asset Variant1 String WalletTransactionsResponseTransactionsItemDetailsVariant0AssetVariant1String- Wallet
Transactions Response Transactions Item Details Variant0 Chain WalletTransactionsResponseTransactionsItemDetailsVariant0Chain- Wallet
Transactions Response Transactions Item Details Variant0 Type WalletTransactionsResponseTransactionsItemDetailsVariant0Type- Wallet
Transactions Response Transactions Item Details Variant1 Asset WalletTransactionsResponseTransactionsItemDetailsVariant1Asset- Wallet
Transactions Response Transactions Item Details Variant1 Asset Variant0 WalletTransactionsResponseTransactionsItemDetailsVariant1AssetVariant0- Wallet
Transactions Response Transactions Item Details Variant1 Asset Variant0 String WalletTransactionsResponseTransactionsItemDetailsVariant1AssetVariant0String- Wallet
Transactions Response Transactions Item Details Variant1 Asset Variant1 WalletTransactionsResponseTransactionsItemDetailsVariant1AssetVariant1- Wallet
Transactions Response Transactions Item Details Variant1 Asset Variant2 WalletTransactionsResponseTransactionsItemDetailsVariant1AssetVariant2- Wallet
Transactions Response Transactions Item Details Variant1 Asset Variant1 String WalletTransactionsResponseTransactionsItemDetailsVariant1AssetVariant1String- Wallet
Transactions Response Transactions Item Details Variant1 Chain WalletTransactionsResponseTransactionsItemDetailsVariant1Chain- Wallet
Transactions Response Transactions Item Details Variant1 Type WalletTransactionsResponseTransactionsItemDetailsVariant1Type- Wallet
Transactions Response Transactions Item Status WalletTransactionsResponseTransactionsItemStatus- Wallet
Transactions Token - Exactly one of
tokenorassetis required. Cannot be used together withasset. - Webhook
Payload - Union of all webhook payload schemas.
- With
Encryption Encrypted Authorization KeyEncryption Type - The encryption type used. Currently only supports HPKE.
- Yield
Claim Confirmed Webhook Payload Type - The type of webhook event.
- Yield
Deposit Confirmed Webhook Payload Type - The type of webhook event.
- Yield
Withdraw Confirmed Webhook Payload Type - The type of webhook event.