> ## Documentation Index > Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt > Use this file to discover all available pages before exploring further. # Add Recovery Method > Add a recovery method to a wallet. ## OpenAPI ````yaml api-reference/_open-api/WalletsV1Alpha2.json POST /2025-06-09/wallets/{walletLocator}/recovery-methods openapi: 3.1.0 info: contact: email: support@crossmint.com name: Crossmint Support url: https://www.crossmint.com description: Crossmint Wallets API title: Crossmint Wallets API version: 1.0.0 servers: - description: Staging environment (testnets) url: https://staging.crossmint.com/api - description: Production environment (mainnets) url: https://www.crossmint.com/api security: [] tags: [] paths: /2025-06-09/wallets/{walletLocator}/recovery-methods: post: summary: Add Recovery Method description: Add a recovery method to a wallet. operationId: wallets.recoveryMethods.create parameters: - description: >- A wallet locator can be of the format: - `` - `email::[:][:alias:]` (walletType defaults to 'smart') - `userId::[:][:alias:]` (white label user example) - `phoneNumber::[:][:alias:]` - `twitter::[:][:alias:]` - `x::[:][:alias:]` - `me:[:][:alias:]` (Use when calling from the client side with a client API key) - `chainType[:]:alias:` in: path name: walletLocator required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddRecoveryMethodsV2025DTOClass' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/AddRecoveryMethodsResponseV2025DTOClass' description: The recovery method transaction has been created. security: - apiKey: [] components: schemas: AddRecoveryMethodsV2025DTOClass: anyOf: - description: Parameters for adding EVM recovery methods properties: approver: description: The recovery method that authorizes this operation. examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string chain: description: >- The chain where the recovery method will be registered. Accepts the smart-wallet-enabled EVM chains. enum: - abstract - abstract-testnet - apechain - arbitrum - arbitrum-sepolia - arbitrumnova - arc - arc-testnet - avalanche - avalanche-fuji - base - base-sepolia - bsc - celo - celo-sepolia - curtis - ethereum - ethereum-sepolia - flow - flow-testnet - mantle - mantle-sepolia - optimism - optimism-sepolia - polygon - polygon-amoy - robinhood-chain - robinhood-chain-testnet - scroll - scroll-sepolia - sei-atlantic-2-testnet - sei-pacific-1 - shape - story - story-testnet - tempo - tempo-testnet - zora - zora-sepolia recoveryMethods: anyOf: - description: >- A signer locator that can be either a of format '' for external wallet type signers or ':' examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string - oneOf: - description: >- A custodial signer provided by Crossmint and backed by our secure infrastructure. Contact sales (https://www.crossmint.com/contact/sales) for access. examples: - type: api-key properties: type: const: api-key description: Identifier for API key signer type type: string required: - type title: API Key Signer type: object - description: A device signer that can be used as a delegated signer examples: - name: my-device publicKey: x: decimal_string_x 'y': decimal_string_y type: device properties: name: description: Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: description: The x coordinate of the p256 public key type: string 'y': description: The y coordinate of the p256 public key type: string required: - x - 'y' type: object type: const: device description: Identifier for device signer type type: string required: - publicKey - type title: Device Signer type: object - description: A server-managed blockchain signer examples: - address: '0x1234567890123456789012345678901234567890' type: server properties: address: description: The blockchain address of the server signer type: string type: const: server description: Identifier for server signer type type: string required: - address - type title: Server Signer type: object - description: >- An email-based signer that can be used to sign transactions properties: email: description: The email address for the signer type: string type: const: email description: Identifier for email signer type type: string required: - email - type title: Email Signer type: object - description: An external wallet that can be used to sign transactions examples: - address: '0x1234567890123456789012345678901234567890' type: external-wallet properties: address: description: The blockchain address of the external wallet type: string type: const: external-wallet description: Identifier for external wallet signer type type: string required: - address - type title: External Wallet Signer type: object - description: >- An phone-based signer that can be used to sign transactions examples: - phone: '+1234567890' type: phone properties: phone: description: The phone number for the signer in E164 format type: string type: const: phone description: Identifier for phone signer type type: string required: - phone - type title: Phone Signer type: object - description: >- Configuration for a WebAuthn/Passkey signer that uses public key credentials for authentication examples: - id: cWtP7gmZbd98HbKUuGXx5Q name: hgranger publicKey: x: >- 38035223810536273945556366218149112558607829411547667975304293530457502824247 'y': >- 91117823763706733837104303008228095481082989039135234750508288790583476078729 type: passkey properties: id: description: >- Credential ID from the WebAuthn registration response, as unpadded base64url minLength: 1 pattern: ^[A-Za-z0-9_-]+$ type: string name: description: Human-readable name for the passkey type: string publicKey: description: >- The public key coordinates from the WebAuthn credential properties: x: description: >- X coordinate of the public key as a decimal string type: string 'y': description: >- Y coordinate of the public key as a decimal string type: string required: - x - 'y' type: object type: const: passkey description: Identifier for the Passkey signer type type: string required: - id - name - publicKey - type title: Passkey Signer type: object description: The recovery method to add. required: - approver - chain - recoveryMethods title: EVM type: object - description: Parameters for adding Solana recovery methods properties: approver: description: The recovery method that authorizes this operation. examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string recoveryMethods: anyOf: - description: >- A signer locator that can be either a of format '' for external wallet type signers or ':' examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string - oneOf: - description: >- A custodial signer provided by Crossmint and backed by our secure infrastructure. Contact sales (https://www.crossmint.com/contact/sales) for access. examples: - type: api-key properties: type: const: api-key description: Identifier for API key signer type type: string required: - type title: API Key Signer type: object - description: A device signer that can be used as a delegated signer examples: - name: my-device publicKey: x: decimal_string_x 'y': decimal_string_y type: device properties: name: description: Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: description: The x coordinate of the p256 public key type: string 'y': description: The y coordinate of the p256 public key type: string required: - x - 'y' type: object type: const: device description: Identifier for device signer type type: string required: - publicKey - type title: Device Signer type: object - description: A server-managed blockchain signer examples: - address: '0x1234567890123456789012345678901234567890' type: server properties: address: description: The blockchain address of the server signer type: string type: const: server description: Identifier for server signer type type: string required: - address - type title: Server Signer type: object - description: >- An email-based signer that can be used to sign transactions properties: email: description: The email address for the signer type: string type: const: email description: Identifier for email signer type type: string required: - email - type title: Email Signer type: object - description: An external wallet that can be used to sign transactions examples: - address: '0x1234567890123456789012345678901234567890' type: external-wallet properties: address: description: The blockchain address of the external wallet type: string type: const: external-wallet description: Identifier for external wallet signer type type: string required: - address - type title: External Wallet Signer type: object - description: >- An phone-based signer that can be used to sign transactions examples: - phone: '+1234567890' type: phone properties: phone: description: The phone number for the signer in E164 format type: string type: const: phone description: Identifier for phone signer type type: string required: - phone - type title: Phone Signer type: object - description: >- Configuration for a WebAuthn/Passkey signer that uses public key credentials for authentication examples: - id: cWtP7gmZbd98HbKUuGXx5Q name: hgranger publicKey: x: >- 38035223810536273945556366218149112558607829411547667975304293530457502824247 'y': >- 91117823763706733837104303008228095481082989039135234750508288790583476078729 type: passkey properties: id: description: >- Credential ID from the WebAuthn registration response, as unpadded base64url minLength: 1 pattern: ^[A-Za-z0-9_-]+$ type: string name: description: Human-readable name for the passkey type: string publicKey: description: >- The public key coordinates from the WebAuthn credential properties: x: description: >- X coordinate of the public key as a decimal string type: string 'y': description: >- Y coordinate of the public key as a decimal string type: string required: - x - 'y' type: object type: const: passkey description: Identifier for the Passkey signer type type: string required: - id - name - publicKey - type title: Passkey Signer type: object description: The recovery method to add. required: - approver - recoveryMethods title: Solana type: object - description: Parameters for adding Stellar recovery methods properties: approver: description: The recovery method that authorizes this operation. examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string recoveryMethods: anyOf: - description: >- A signer locator that can be either a of format '' for external wallet type signers or ':' examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string - oneOf: - description: >- A custodial signer provided by Crossmint and backed by our secure infrastructure. Contact sales (https://www.crossmint.com/contact/sales) for access. examples: - type: api-key properties: type: const: api-key description: Identifier for API key signer type type: string required: - type title: API Key Signer type: object - description: A device signer that can be used as a delegated signer examples: - name: my-device publicKey: x: decimal_string_x 'y': decimal_string_y type: device properties: name: description: Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: description: The x coordinate of the p256 public key type: string 'y': description: The y coordinate of the p256 public key type: string required: - x - 'y' type: object type: const: device description: Identifier for device signer type type: string required: - publicKey - type title: Device Signer type: object - description: A server-managed blockchain signer examples: - address: '0x1234567890123456789012345678901234567890' type: server properties: address: description: The blockchain address of the server signer type: string type: const: server description: Identifier for server signer type type: string required: - address - type title: Server Signer type: object - description: >- An email-based signer that can be used to sign transactions properties: email: description: The email address for the signer type: string type: const: email description: Identifier for email signer type type: string required: - email - type title: Email Signer type: object - description: An external wallet that can be used to sign transactions examples: - address: '0x1234567890123456789012345678901234567890' type: external-wallet properties: address: description: The blockchain address of the external wallet type: string type: const: external-wallet description: Identifier for external wallet signer type type: string required: - address - type title: External Wallet Signer type: object - description: >- An phone-based signer that can be used to sign transactions examples: - phone: '+1234567890' type: phone properties: phone: description: The phone number for the signer in E164 format type: string type: const: phone description: Identifier for phone signer type type: string required: - phone - type title: Phone Signer type: object - description: >- Configuration for a WebAuthn/Passkey signer that uses public key credentials for authentication examples: - id: cWtP7gmZbd98HbKUuGXx5Q name: hgranger publicKey: x: >- 38035223810536273945556366218149112558607829411547667975304293530457502824247 'y': >- 91117823763706733837104303008228095481082989039135234750508288790583476078729 type: passkey properties: id: description: >- Credential ID from the WebAuthn registration response, as unpadded base64url minLength: 1 pattern: ^[A-Za-z0-9_-]+$ type: string name: description: Human-readable name for the passkey type: string publicKey: description: >- The public key coordinates from the WebAuthn credential properties: x: description: >- X coordinate of the public key as a decimal string type: string 'y': description: >- Y coordinate of the public key as a decimal string type: string required: - x - 'y' type: object type: const: passkey description: Identifier for the Passkey signer type type: string required: - id - name - publicKey - type title: Passkey Signer type: object description: The recovery method to add. required: - approver - recoveryMethods title: Stellar type: object AddRecoveryMethodsResponseV2025DTOClass: properties: recoveryMethods: description: The recovery method being added, with its resolved locator. oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object tx: anyOf: - properties: approvals: description: >- Complete approval data including requirements, pending and submitted signatures properties: pending: description: List of pending signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that needs to be signed type: string signer: description: The full signer object that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array required: description: Number of required approvals for the transaction type: number submitted: description: Record of all submitted signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that was signed type: string metadata: description: >- Additional metadata about the signature submission properties: deviceInfo: type: string ipAddress: type: string userAgent: type: string type: object signature: description: The cryptographic signature type: string signer: description: >- The full signer object who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the signature was submitted required: - message - signature - signer - submittedAt type: object type: array required: - pending - submitted type: object chainType: description: The blockchain type of the wallet enum: - aptos - evm - solana - stellar - sui type: string completedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction reached finality createdAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction was created error: $ref: '#/components/schemas/WalletsV1Alpha2TransactionError' description: Error message if the transaction fails after submission fees: description: >- Transaction fee information including actual transaction fees, billed amounts, and billing status properties: actual: {} billed: properties: usd: type: number required: - usd type: object billing: properties: status: enum: - failed - pending - settled type: string required: - status type: object estimate: {} mode: enum: - project - user-fungible - user-native type: string required: - mode type: object id: description: Unique identifier for the transaction type: string onChain: description: Transaction data specific to EVM MPC wallets properties: call: properties: data: description: The encoded calldata for this transaction to: description: The recipient address for this transaction call type: string required: - data - to type: object explorerLink: type: string txId: description: A hex string type: string required: - call title: EVM MPC wallet transaction data type: object params: properties: call: anyOf: - additionalProperties: false properties: abi: description: The ABI for the function to call items: {} type: array address: description: The recipient address for this transaction call type: string args: description: The arguments to pass to the function items: {} type: array functionName: description: The name of the function to call type: string required: - abi - address - args - functionName type: object - additionalProperties: false properties: data: description: The encoded calldata for this transaction to: description: The recipient address for this transaction call type: string required: - data - to type: object description: The transaction call to execute chain: description: The chain on which the transaction will be executed enum: - abstract - abstract-testnet - apechain - arbitrum - arbitrum-sepolia - arbitrumnova - arc - arc-testnet - astar-zkevm - avalanche - avalanche-fuji - base - base-goerli - base-sepolia - bsc - bsc-testnet - celo - celo-sepolia - chiliz - chiliz-spicy-testnet - coti - coti-testnet - curtis - ethereum - ethereum-goerli - ethereum-sepolia - flow - flow-testnet - hedera - hedera-testnet - hypersonic-testnet - lightlink - lightlink-pegasus - mantle - mantle-sepolia - mode - mode-sepolia - optimism - optimism-goerli - optimism-sepolia - plume - plume-testnet - polygon - polygon-amoy - polygon-mumbai - rari - rari-testnet - robinhood-chain - robinhood-chain-testnet - scroll - scroll-sepolia - sei-atlantic-2-testnet - sei-pacific-1 - shape - shape-sepolia - skale-nebula - skale-nebula-testnet - soneium - soneium-minato-testnet - space - space-testnet - story - story-testnet - tempo - tempo-testnet - u2u-nebulas - u2u-solaris - verify-testnet - viction - viction-testnet - world-chain - world-chain-sepolia - xai - xai-sepolia-testnet - zenchain-testnet - zkatana - zkyoto - zora - zora-goerli - zora-sepolia type: string required: - call - chain type: object sendParams: properties: params: description: The parameters for the send token transaction properties: amount: description: The amount of the token to send type: string recipient: description: The recipient locator for the token type: string recipientAddress: description: The recipient address for the token type: string required: - recipient - recipientAddress type: object token: description: The token locator that's being sent type: string required: - params - token type: object status: description: Current status of the transaction enum: - awaiting-approval - failed - pending - success type: string walletType: description: The wallet type (smart or mpc) enum: - mpc - smart type: string required: - chainType - createdAt - id - onChain - params - status - walletType title: EVM MPC Wallet type: object - properties: approvals: description: >- Complete approval data including requirements, pending and submitted signatures properties: pending: description: List of pending signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that needs to be signed type: string signer: description: The full signer object that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array required: description: Number of required approvals for the transaction type: number submitted: description: Record of all submitted signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that was signed type: string metadata: description: >- Additional metadata about the signature submission properties: deviceInfo: type: string ipAddress: type: string userAgent: type: string type: object signature: description: The cryptographic signature type: string signer: description: >- The full signer object who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the signature was submitted required: - message - signature - signer - submittedAt type: object type: array required: - pending - submitted type: object chainType: description: The blockchain type of the wallet enum: - aptos - evm - solana - stellar - sui type: string completedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction reached finality createdAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction was created error: $ref: '#/components/schemas/WalletsV1Alpha2TransactionError' description: Error message if the transaction fails after submission fees: description: >- Transaction fee information including actual transaction fees, billed amounts, and billing status properties: actual: {} billed: properties: usd: type: number required: - usd type: object billing: properties: status: enum: - failed - pending - settled type: string required: - status type: object estimate: {} mode: enum: - project - user-fungible - user-native type: string required: - mode type: object id: description: Unique identifier for the transaction type: string onChain: description: Transaction data specific to EVM smart wallets properties: explorerLink: type: string proxiedTxId: description: A hex string type: string txId: description: A hex string type: string userOperation: properties: callData: description: A hex string type: string callGasLimit: description: A hex string type: string factory: description: A hex string type: string factoryData: description: A hex string type: string maxFeePerGas: description: A hex string type: string maxPriorityFeePerGas: description: A hex string type: string nonce: description: A hex string type: string paymaster: description: A hex string type: string paymasterData: description: A hex string type: string paymasterPostOpGasLimit: description: A hex string type: string paymasterVerificationGasLimit: description: A hex string type: string preVerificationGas: description: A hex string type: string sender: description: A hex string type: string signature: description: A hex string type: string verificationGasLimit: description: A hex string type: string required: - callData - callGasLimit - maxFeePerGas - maxPriorityFeePerGas - nonce - preVerificationGas - sender - signature - verificationGasLimit type: object userOperationHash: description: A hex string type: string required: - userOperation - userOperationHash title: EVM smart wallet transaction data type: object params: properties: calls: description: Array of transaction calls to execute items: anyOf: - description: >- Parameters for a transaction to execute a contract function properties: abi: description: The ABI for the function to call items: {} type: array address: description: >- The recipient address for this transaction call type: string args: description: The arguments to pass to the function items: {} type: array functionName: description: The name of the function to call type: string value: default: '0' description: The amount of native token to send in wei type: string required: - abi - address - args - functionName title: EVM contract call transaction parameters type: object - description: >- Parameters for a transaction to send a direct calldata transaction properties: data: description: The encoded calldata for this transaction to: description: >- The recipient address for this transaction call type: string value: description: The amount of native token to send in wei type: string required: - data - to - value title: EVM direct calldata transaction parameters type: object - description: >- Parameters for a transaction to send a serialized EVM transaction properties: transaction: description: Serialized EVM transaction required: - transaction title: EVM serialized transaction parameters type: object description: Transaction data to execute minItems: 1 type: array chain: description: The chain on which the transaction will be executed enum: - abstract - abstract-testnet - apechain - arbitrum - arbitrum-sepolia - arbitrumnova - arc - arc-testnet - avalanche - avalanche-fuji - base - base-sepolia - bsc - celo - celo-sepolia - curtis - ethereum - ethereum-sepolia - flow - flow-testnet - mantle - mantle-sepolia - optimism - optimism-sepolia - polygon - polygon-amoy - robinhood-chain - robinhood-chain-testnet - scroll - scroll-sepolia - sei-atlantic-2-testnet - sei-pacific-1 - shape - story - story-testnet - tempo - tempo-testnet - zora - zora-sepolia signer: description: The full signer object who will submit this transaction oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - calls - chain type: object sendParams: properties: params: description: The parameters for the send token transaction properties: amount: description: The amount of the token to send type: string recipient: description: The recipient locator for the token type: string recipientAddress: description: The recipient address for the token type: string required: - recipient - recipientAddress type: object token: description: The token locator that's being sent type: string required: - params - token type: object status: description: Current status of the transaction enum: - awaiting-approval - failed - pending - success type: string walletType: description: The wallet type (smart or mpc) enum: - mpc - smart type: string required: - chainType - createdAt - id - onChain - params - status - walletType title: EVM Smart Wallet type: object - properties: approvals: description: >- Complete approval data including requirements, pending and submitted signatures properties: pending: description: List of pending signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that needs to be signed type: string signer: description: The full signer object that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array required: description: Number of required approvals for the transaction type: number submitted: description: Record of all submitted signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that was signed type: string metadata: description: >- Additional metadata about the signature submission properties: deviceInfo: type: string ipAddress: type: string userAgent: type: string type: object signature: description: The cryptographic signature type: string signer: description: >- The full signer object who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the signature was submitted required: - message - signature - signer - submittedAt type: object type: array required: - pending - submitted type: object chainType: description: The blockchain type of the wallet enum: - aptos - evm - solana - stellar - sui type: string completedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction reached finality createdAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction was created error: $ref: '#/components/schemas/WalletsV1Alpha2TransactionError' description: Error message if the transaction fails after submission fees: description: >- Transaction fee information including actual transaction fees, billed amounts, and billing status properties: actual: {} billed: properties: usd: type: number required: - usd type: object billing: properties: status: enum: - failed - pending - settled type: string required: - status type: object estimate: {} mode: enum: - project - user-fungible - user-native type: string required: - mode type: object id: description: Unique identifier for the transaction type: string onChain: properties: expiration: description: The expiration of the transaction type: number explorerLink: description: Optional link to view the transaction in an explorer type: string ledger: description: The ledger number where the transaction was included type: number proxiedTxId: description: For regulated transfers, the delivery transaction hash type: string result: description: The Transaction Result in XDR format transaction: description: The Stellar Transaction Envelope properties: method: type: string tx: type: string required: - method - tx title: Stellar on-chain transaction type: object txId: description: The transaction hash type: string required: - expiration - transaction title: Stellar on-chain data type: object params: properties: signer: description: >- The locator for the signer who will submit this transaction. Defaults to the admin signer. examples: - passkey:cWtP7gmZbd98HbKUuGXx5Q - api-key:123456789 - >- external-wallet:0x1234567890123456789012345678901234567890 - server:0x1234567890123456789012345678901234567890 - email:test@example.com - phone:+1234567890 - device:BIVmCqMz8QJB+se2kJEpGQ... - quorum:123e4567-e89b-12d3-a456-426614174000 title: Signer Locator type: string transaction: description: Stellar transaction to execute oneOf: - description: >- Completes a pending wallet upgrade by migrating on-chain signer data to the new contract version. Must be called after upgrade-wallet. examples: - type: migrate-wallet properties: type: const: migrate-wallet description: The type of transaction to execute type: string required: - type title: Stellar migrate wallet transaction type: object - description: >- Parameters for a transaction to execute a smart contract function examples: - args: amount: '1000000000000000000' from: >- GB3KQJ6N2YIE62YVO67X7W5TQK6Q5ZZ4P2LUVK2U6AU26CJQ626J to: >- GB3KQJ6N2YIE62YVO67X7W5TQK6Q5ZZ4P2LUVK2U6AU26CJQ626J contractId: >- GB3KQJ6N2YIE62YVO67X7W5TQK6Q5ZZ4P2LUVK2U6AU26CJQ626J method: transfer type: contract-call properties: args: additionalProperties: {} description: The arguments to pass to the function propertyNames: type: string type: object contractId: description: The recipient address for this transaction call examples: - >- GB3KQJ6N2YIE62YVO67X7W5TQK6Q5ZZ4P2LUVK2U6AU26CJQ626J type: string memo: description: The memo for the transaction examples: - type: text value: Hello, world! oneOf: - properties: type: const: hash type: string value: type: string required: - type - value type: object - properties: type: const: id type: string value: type: string required: - type - value type: object - properties: type: const: text type: string value: maxLength: 28 type: string required: - type - value type: object method: description: The name of the function to call type: string type: const: contract-call description: The type of transaction to execute type: string required: - args - contractId - method - type title: Stellar contract call transaction parameters type: object - description: >- Upgrades the wallet's on-chain contract to a new version. The wallet will be locked until a migrate-wallet transaction completes the upgrade. examples: - type: upgrade-wallet properties: type: const: upgrade-wallet description: The type of transaction to execute type: string required: - type title: Stellar upgrade wallet transaction type: object required: - transaction type: object sendParams: properties: params: description: The parameters for the send token transaction properties: amount: description: The amount of the token to send type: string recipient: description: The recipient locator for the token type: string recipientAddress: description: The recipient address for the token type: string required: - recipient - recipientAddress type: object token: description: The token locator that's being sent type: string required: - params - token type: object status: description: Current status of the transaction enum: - awaiting-approval - failed - pending - success type: string walletType: description: The wallet type (smart or mpc) enum: - mpc - smart type: string required: - chainType - createdAt - id - onChain - params - status - walletType title: Stellar Smart Wallet type: object - properties: approvals: description: >- Complete approval data including requirements, pending and submitted signatures properties: pending: description: List of pending signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that needs to be signed type: string signer: description: The full signer object that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array required: description: Number of required approvals for the transaction type: number submitted: description: Record of all submitted signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that was signed type: string metadata: description: >- Additional metadata about the signature submission properties: deviceInfo: type: string ipAddress: type: string userAgent: type: string type: object signature: description: The cryptographic signature type: string signer: description: >- The full signer object who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the signature was submitted required: - message - signature - signer - submittedAt type: object type: array required: - pending - submitted type: object chainType: description: The blockchain type of the wallet enum: - aptos - evm - solana - stellar - sui type: string completedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction reached finality createdAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction was created error: $ref: '#/components/schemas/WalletsV1Alpha2TransactionError' description: Error message if the transaction fails after submission fees: description: >- Transaction fee information including actual transaction fees, billed amounts, and billing status properties: actual: {} billed: properties: usd: type: number required: - usd type: object billing: properties: status: enum: - failed - pending - settled type: string required: - status type: object estimate: {} mode: enum: - project - user-fungible - user-native type: string required: - mode type: object id: description: Unique identifier for the transaction type: string onChain: properties: explorerLink: type: string lastValidBlockHeight: type: number proxiedTxId: type: string transaction: type: string txId: type: string required: - transaction type: object params: properties: feeConfig: anyOf: - properties: amount: description: The amount of the fee type: string feePayer: const: crossmint type: string required: - amount - feePayer type: object - properties: amount: description: The amount of the fee type: string feePayer: description: The address that will pay for the transaction type: string token: description: The token to use for the fee enum: - sol - usdc - usdt type: string required: - amount - feePayer - token type: object requiredSigners: description: >- Optional array of additional full signer objects required for the transaction items: description: Full signer object oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object type: array signer: anyOf: - description: Full signer object oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object - description: >- Reference to an m-of-n quorum signer. The quorum is a composite — its members and their per-member progress are carried in the entry's `quorumApprovals`, not here. properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object description: >- The full signer object who will submit this transaction. Defaults to the admin signer. transaction: description: Base58 encoded serialized Solana transaction type: string required: - feeConfig - transaction type: object sendParams: properties: params: description: The parameters for the send token transaction properties: amount: description: The amount of the token to send type: string recipient: description: The recipient locator for the token type: string recipientAddress: description: The recipient address for the token type: string required: - recipient - recipientAddress type: object token: description: The token locator that's being sent type: string required: - params - token type: object status: description: Current status of the transaction enum: - awaiting-approval - failed - pending - success type: string walletType: description: The wallet type (smart or mpc) enum: - mpc - smart type: string required: - chainType - createdAt - id - onChain - params - status - walletType title: Solana Smart Wallet type: object - properties: approvals: description: >- Complete approval data including requirements, pending and submitted signatures properties: pending: description: List of pending signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that needs to be signed type: string signer: description: The full signer object that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array required: description: Number of required approvals for the transaction type: number submitted: description: Record of all submitted signatures items: anyOf: - description: >- Approval entry for a quorum (multisig) admin signer properties: quorumApprovals: description: Per-member progress of an m-of-n quorum signer properties: pending: description: Quorum members that have not yet submitted items: properties: message: description: >- The message that this member needs to sign type: string signer: description: >- The full signer object of the quorum member that's pending approval oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object required: - message - signer type: object type: array remaining: description: >- Number of member approvals still outstanding to reach the threshold type: number submitted: description: Quorum members that have already submitted items: properties: message: description: The message that this member signed type: string signature: description: The cryptographic signature type: string signer: description: >- The full signer object of the quorum member who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the member signature was submitted required: - message - signature - signer - submittedAt type: object type: array threshold: description: >- Number of member approvals required to satisfy the quorum type: number required: - pending - remaining - submitted - threshold type: object signer: description: >- The quorum signer this approval entry belongs to properties: locator: description: >- The derived `quorum:` locator of the quorum signer type: string type: const: quorum type: string required: - locator - type title: Quorum Signer Reference type: object required: - quorumApprovals - signer type: object - properties: message: description: The message that was signed type: string metadata: description: >- Additional metadata about the signature submission properties: deviceInfo: type: string ipAddress: type: string userAgent: type: string type: object signature: description: The cryptographic signature type: string signer: description: >- The full signer object who submitted this signature oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: >- The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object submittedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: When the signature was submitted required: - message - signature - signer - submittedAt type: object type: array required: - pending - submitted type: object chainType: description: The blockchain type of the wallet enum: - aptos - evm - solana - stellar - sui type: string completedAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction reached finality createdAt: anyOf: - description: ISO 8601 formatted timestamp type: number - type: string description: ISO timestamp when the transaction was created error: $ref: '#/components/schemas/WalletsV1Alpha2TransactionError' description: Error message if the transaction fails after submission fees: description: >- Transaction fee information including actual transaction fees, billed amounts, and billing status properties: actual: {} billed: properties: usd: type: number required: - usd type: object billing: properties: status: enum: - failed - pending - settled type: string required: - status type: object estimate: {} mode: enum: - project - user-fungible - user-native type: string required: - mode type: object id: description: Unique identifier for the transaction type: string onChain: properties: explorerLink: type: string lastValidBlockHeight: type: number proxiedTxId: type: string transaction: type: string txId: type: string required: - transaction type: object params: properties: requiredSigners: description: >- Optional array of additional full signer objects required for the transaction items: description: Full signer object oneOf: - description: Full API Key signer object properties: address: description: The address of the api key type: string locator: description: The locator of the api key signer type: string type: const: api-key type: string required: - address - locator - type title: API Key Signer type: object - description: Full Device signer object properties: locator: description: The locator of the device signer type: string name: description: >- Optional human-readable name for the device signer type: string publicKey: description: The p256 public key of the device signer properties: x: type: string 'y': type: string required: - x - 'y' type: object type: const: device type: string required: - locator - publicKey - type title: Device Signer type: object - description: Full External Wallet signer object properties: address: description: The address of the external wallet type: string locator: description: The locator of the external wallet signer type: string type: const: external-wallet type: string required: - address - locator - type title: External Wallet Signer type: object - description: Full Passkey signer object properties: id: description: The ID of the passkey type: string locator: description: The locator of the passkey signer type: string type: const: passkey type: string required: - id - locator - type title: Passkey Signer type: object - properties: address: type: string locator: type: string type: const: server type: string required: - address - locator - type type: object - properties: email: format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ type: string locator: type: string type: const: email type: string required: - email - locator - type type: object - properties: locator: type: string phone: type: string type: const: phone type: string required: - locator - phone - type type: object type: array transaction: description: Base58 encoded serialized Solana transaction type: string required: - transaction type: object sendParams: properties: params: description: The parameters for the send token transaction properties: amount: description: The amount of the token to send type: string recipient: description: The recipient locator for the token type: string recipientAddress: description: The recipient address for the token type: string required: - recipient - recipientAddress type: object token: description: The token locator that's being sent type: string required: - params - token type: object status: description: Current status of the transaction enum: - awaiting-approval - failed - pending - success type: string walletType: description: The wallet type (smart or mpc) enum: - mpc - smart type: string required: - chainType - createdAt - id - onChain - params - status - walletType title: Solana MPC Wallet type: object description: >- Complete transaction response including status, signing requirements, and wallet type specific data required: - recoveryMethods - tx type: object WalletsV1Alpha2TransactionError: anyOf: - properties: logs: {} message: type: string reason: const: program_error type: string revertData: additionalProperties: {} propertyNames: type: string type: object required: - message - reason type: object - properties: message: type: string reason: anyOf: - const: build_failed type: string - const: failed_to_land_on_chain type: string - const: sanctioned_wallet_address type: string - const: unknown type: string revertData: additionalProperties: {} propertyNames: type: string type: object required: - message - reason type: object - properties: message: type: string reason: const: execution_reverted type: string revert: $ref: '#/components/schemas/WalletsV1Alpha2TransactionRevert' revertData: additionalProperties: {} propertyNames: type: string type: object required: - message - reason type: object WalletsV1Alpha2TransactionRevert: properties: debug: description: Structured debugging information for the revert examples: - blockNumber: '38104211' call: args: - name: to type: address value: '0x9999999999999999999999999999999999999999' - name: amount type: uint256 value: '1000000' function: transfer(address,uint256) index: 1 to: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' value: '0' chain: base details: available: '500000' code: insufficient_erc20_balance required: '1000000' symbol: USDC token: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913' message: Wallet holds 0.5 USDC but the transfer requires 1 USDC retryable: true revert: args: - type: address value: '0x1234567890abcdef1234567890abcdef1234abcd' - type: uint256 value: '500000' - type: uint256 value: '1000000' name: ERC20InsufficientBalance selector: '0xe450d38c' signature: ERC20InsufficientBalance(address,uint256,uint256) properties: blockNumber: description: >- Block the failure was observed at; replay with eth_call / debug_traceCall pattern: ^\d+$ type: string call: description: >- The call in the batch that reverted; absent when the failure cannot be attributed to a call properties: args: items: properties: name: description: >- Parameter name; only set when the ABI came from the request type: string type: description: Solidity type, e.g. `address` or `uint256` type: string value: description: Decoded value; bigints as decimal strings type: string required: - type - value type: object type: array function: description: Function signature, e.g. `transfer(address,uint256)` type: string index: description: Index of the call within the transaction's batch maximum: 9007199254740991 minimum: -9007199254740991 type: integer to: description: An EVM address string type: string value: description: Native value sent with the call, in wei pattern: ^\d+$ type: string required: - args - index - to - value type: object chain: type: string details: description: >- Classified root cause. Branch on `code`: `insufficient_*` and `out_of_gas` are fixable by the caller, `account_abstraction` is an EntryPoint rejection (see `entryPointCode`), `contract_revert` is a decoded revert with no further classification (see `revert`), `unknown` means no revert data was available oneOf: - properties: available: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string code: const: insufficient_erc20_allowance type: string required: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string spender: description: Address that needs the approval type: string symbol: type: string token: description: An EVM address string type: string required: - available - code - required - spender - token type: object - properties: available: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string code: const: insufficient_erc20_balance type: string required: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string symbol: type: string token: description: An EVM address string type: string required: - available - code - required - token type: object - properties: available: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string code: const: insufficient_native_balance type: string required: description: Wei needed to cover value plus gas pattern: ^\d+$ type: string required: - available - code - required type: object - properties: code: const: account_abstraction type: string entryPointCode: description: ERC-4337 EntryPoint code, e.g. `AA21` type: string entryPointMessage: description: EntryPoint's own message, e.g. `didn't pay prefund` type: string required: - code - entryPointCode - entryPointMessage type: object - properties: code: const: contract_revert type: string required: - code type: object - properties: code: const: out_of_gas type: string gasLimit: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string gasUsed: description: Unsigned integer encoded as a decimal string pattern: ^\d+$ type: string required: - code - gasLimit type: object - properties: code: const: unknown type: string required: - code type: object message: description: Human-readable summary of `details` type: string retryable: description: >- True when the same transaction can succeed after the caller fixes state (funds, allowance, gas) type: boolean revert: description: >- Raw revert as returned by the chain, decoded when the error is known properties: args: description: Positional decoded error arguments; empty when undecoded items: properties: name: description: >- Parameter name; only set when the ABI came from the request type: string type: description: Solidity type, e.g. `address` or `uint256` type: string value: description: Decoded value; bigints as decimal strings type: string required: - type - value type: object type: array name: type: string selector: description: >- 4-byte error selector; absent when the revert carried no data pattern: ^0x[0-9a-fA-F]{8}$ type: string signature: type: string required: - args type: object required: - blockNumber - chain - details - message - retryable - revert type: object explorerLink: type: string reason: type: string reasonData: anyOf: - additionalProperties: {} propertyNames: type: string type: object - type: string simulationLink: description: >- Deprecated: no longer populated. Kept for backwards compatibility with previously failed transactions. type: string type: anyOf: - const: contract_call type: string - const: wallet_authorization type: string - const: wallet_deployment type: string required: - reason - type type: object securitySchemes: apiKey: description: API key required for authentication in: header name: X-API-KEY type: apiKey ````