> ## Documentation Index
> Fetch the complete documentation index at: https://docs.byzantine.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# Get vault upgrade payload (Base -> Ethereum)

> Returns two raw payloads to sign with one passkey prompt: a withdraw from the Base vault
and a deposit on the destination Ethereum vault. The destination vault address is
derived from a static mapping on the source vault address.



## OpenAPI

````yaml /api-reference/openapi-integrator.json post /v1/query/get-vault-upgrade-payload-passkey
openapi: 3.0.3
info:
  title: Byzantine Integrator API
  description: Byzantine REST API for integrators.
  license:
    name: ''
  version: 0.2.0
servers:
  - url: https://sandbox.api.byzantine.fi
    description: Sandbox
security: []
tags:
  - name: API health
    description: Check API status.
  - name: Customer management
    description: Endpoints to create, update, and retrieve customer information.
  - name: Account management
    description: Endpoints to manage accounts, bank accounts, invitations, and user roles.
  - name: Products
    description: Endpoints to get data about products and vaults.
  - name: Transactions
    description: Endpoints to create and manage transactions.
  - name: OTP authentication
    description: Endpoints to initialize and manage user authentication with OTP.
  - name: Webhooks
    description: Integrator-managed outbound webhook subscriptions and delivery history.
paths:
  /v1/query/get-vault-upgrade-payload-passkey:
    post:
      tags:
        - Transactions
      summary: Get vault upgrade payload (Base -> Ethereum)
      description: >-
        Returns two raw payloads to sign with one passkey prompt: a withdraw
        from the Base vault

        and a deposit on the destination Ethereum vault. The destination vault
        address is

        derived from a static mapping on the source vault address.
      operationId: get_vault_upgrade_payload_passkey
      parameters:
        - name: X-Pubkey
          in: header
          description: >-
            Integrator's ECDSA public key (P-256 curve, compressed SEC1 format).
            Example:
            0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd
          required: true
          schema:
            type: string
        - name: X-Timestamp
          in: header
          description: >-
            Unix timestamp in seconds (UTC). Must be within tolerance window (1
            minute) to prevent replay attacks. Example: 1760375826
          required: true
          schema:
            type: string
        - name: X-Signature
          in: header
          description: >-
            ECDSA signature (DER-encoded, hex with 0x prefix). Signs the
            message: {timestamp}{METHOD}{path_and_query}{json_body}. Example:
            0x3045022100...
          required: true
          schema:
            type: string
      requestBody:
        description: >-
          Request body containing the account ID and source vault address (on
          Base).
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VaultUpgradeRequestBody'
        required: true
      responses:
        '200':
          description: Payloads to sign created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultUpgradePayloadResponse'
        '400':
          description: >-
            Invalid request (unmapped vault, zero shares, async vault, pending
            upgrade, ...)
        '401':
          description: >-
            Unauthorized (account not belonging to integrator or not
            Atlas-delegated)
        '500':
          description: Internal server error
      security:
        - integrator_auth: []
components:
  schemas:
    VaultUpgradeRequestBody:
      type: object
      description: Request body for initiating a vault upgrade (Base -> Ethereum)
      required:
        - accountId
        - sourceVaultAddr
      properties:
        accountId:
          $ref: '#/components/schemas/Uuid'
        sourceVaultAddr:
          type: string
          description: The address of the source vault on Base (8453)
          example: '0x061b3aff8e21a9d194ce43cEfc20A0eFf122Ec69'
    VaultUpgradePayloadResponse:
      type: object
      description: >-
        Response containing the two raw payloads to sign (withdraw from Base and
        deposit on Ethereum) in one passkey prompt.
      required:
        - bodyToSign
        - transactionId
        - sourceAmount
        - destinationAmount
        - destinationVaultAddr
      properties:
        bodyToSign:
          $ref: '#/components/schemas/SignRawPayloadsRequest'
        transactionId:
          $ref: '#/components/schemas/Uuid'
        sourceAmount:
          $ref: '#/components/schemas/Decimal'
        destinationAmount:
          $ref: '#/components/schemas/Decimal'
        destinationVaultAddr:
          type: string
          description: The destination vault address on Ethereum.
          example: '0x2F99e35Ea811F3cC230B26dfF817604B5D4B6e38'
    Uuid:
      type: string
      format: uuid
      description: A UUID string
      example: 550e8400-e29b-41d4-a716-446655440000
    SignRawPayloadsRequest:
      type: object
      description: >-
        The object that needs to be signed by the end user to make a batch of
        transactions.
      required:
        - type
        - timestampMs
        - organizationId
        - parameters
      properties:
        type:
          type: string
          description: Defaults to `ACTIVITY_TYPE_SIGN_RAW_PAYLOADS`.
          example: ACTIVITY_TYPE_SIGN_RAW_PAYLOADS
        timestampMs:
          type: string
          description: UNIX timestamp of the creation of the transaction.
        organizationId:
          type: string
          description: The account ID making the transaction.
        parameters:
          $ref: '#/components/schemas/SignRawPayloadsParams'
    Decimal:
      type: string
      description: A high-precision decimal number represented as a string
      example: '123.456789'
    SignRawPayloadsParams:
      type: object
      description: >-
        The parameters object containing the specific intent data for this batch
        of transactions.
      required:
        - signWith
        - payloads
        - encoding
        - hashFunction
      properties:
        signWith:
          type: string
          description: >-
            A Wallet account address, Private Key address, or Private Key
            identifier.
        payloads:
          type: array
          items:
            type: string
          description: An array of raw unsigned payloads to be signed.
        encoding:
          type: string
          description: >-
            How the payload is encoded: `PAYLOAD_ENCODING_HEXADECIMAL` or
            `PAYLOAD_ENCODING_EIP7702_AUTHORIZATION`
          example: PAYLOAD_ENCODING_HEXADECIMAL
        hashFunction:
          type: string
          description: >-
            Rather Turnkey should hash the message or not: `HASH_FUNCTION_NO_OP`
            or `HASH_FUNCTION_KECCAK256`
          example: HASH_FUNCTION_NO_OP
  securitySchemes:
    integrator_auth:
      type: apiKey
      in: header
      name: X-Pubkey, X-Timestamp, X-Signature

````