Vortex
    • Overview
    • Vortex SDK
    • Quick Start With The SDK
    • Ramp Lifecycle
    • Ephemeral Key Custody
    • Authentication And Partner Keys
    • Sandbox
    • BRL / KYC notes
    • Production Checklist
    • Quotes
      • Quotes And Pricing
      • Get existing quote
        GET
      • Create a new quote
        POST
      • Create a quote for the best network
        POST
    • Vortex Widget
      • Widget parameters
      • Widget Integration
      • Generating widget URL (for existing quote)
        POST
      • Generating widget URL (for existing quote)
        POST
    • Ramp
      • Get ramp status
        GET
      • Get ramp history for wallet address
        GET
      • Register new ramp process
        POST
      • Update ramp process
        POST
      • Start ramp process
        POST
      • Get ramp error logs
        GET
    • Account Management
      • Brazil
        • Brazilian KYC Process Overview
        • Get status of the last ramp event for a user
        • Start KYC level 2 process for a user
      • Europe
        • Coming soon...
      • Get user's remaining transaction limits
        GET
      • Get KYC document upload URLs
        POST
      • Get user information
        GET
      • Create user or retry KYC
        POST
      • Submit KYC level 1 data
        POST
      • Get selfie liveness URL
        GET
      • Get user's KYC status
        GET
      • Validate Pix key
        GET
    • Webhooks
      • Overview
      • Webhooks
      • Register Webhook
      • Delete Webhook
    • Public Key
      • Overview
      • Public Key
    • Reference Data
      • Supported Payment Methods
      • Supported Cryptocurrencies
      • Supported Countries
      • Supported Fiat Currencies
    • Schemas
      • Schemas
      • StartKYC2Response
      • GetKycStatusResponse
      • ValidatePixKeyResponse
      • GetUserRemainingLimitResponse
      • TriggerOfframpRequest
      • TriggerOfframpResponse
      • BrlaAddress
      • TaxIdType
      • CreateSubaccountRequest
      • CreateSubaccountResponse
      • KYCDocType
      • KYCDataUploadFileFiles
      • StartKYC2Request
      • GetUserResponse
      • StartRampRequest
      • RampDirection
      • GetWidgetUrlLocked
      • CountryCode
      • PaymentMethod
      • SimpleStatus
      • FiatToken
      • OnChainToken
      • GetWidgetUrlRefresh
      • CreateBestQuoteRequest
      • GetRampHistoryTransaction
      • GetRampHistoryResponse
      • BrlaErrorResponse
      • RegisterRampRequest
      • AccountMeta
      • Networks
      • PaymentData
      • RampProcess
      • RampPhase
      • DestinationType
      • UnsignedTx
      • CleanupPhase
      • CreateQuoteRequest
      • QuoteResponse
      • RampCurrency
      • UpdateRampRequest
      • PresignedTx
      • ErrorResponse
      • RampErrorLog
      • GetRampErrorLogsResponse
      • BrlaValidatePixKeyResponse
      • BrlaGetSelfieLivenessUrlResponse
      • AveniaDocumentType
      • AveniaKYCDataUploadRequest
      • DocumentUploadEntry
      • AveniaKYCDataUploadResponse
      • KycLevel1Payload
      • KycLevel1Response

    Overview

    Vortex is a cross-chain ramping platform for moving between fiat currencies and crypto assets. It supports buy and sell flows across payment rails such as PIX and blockchain networks such as Base, Polygon, Pendulum, Stellar, Moonbeam, AssetHub, and Hydration.
    These docs are intended for partner developers integrating Vortex into an application, backend, wallet, checkout flow, or operations dashboard. The endpoint reference documents the raw API surface, while the guide pages explain the recommended integration sequence and the responsibilities that sit on the API client side.
    For most integrations, Vortex recommends using @vortexfi/sdk instead of calling the ramp endpoints directly. The SDK wraps the quote and ramp lifecycle, creates fresh ephemeral accounts, signs required transactions, submits ramp updates, and can store local backups of ephemeral secrets. Direct API integrations are possible, but they must implement those responsibilities themselves.
    SDK environment: The current SDK release runs in Node.js only. Browser support is not enabled.
    SEPA flows: SEPA on/off-ramp paths are stubbed in the SDK (registerRamp throws "not implemented yet" for SEPA quotes). BRL flows via PIX are the supported SDK path today.
    Vortex does not custody user private keys. During a ramp, temporary blockchain accounts called ephemeral accounts may hold funds in transit. Their public addresses are sent to Vortex, but their secret keys stay with the SDK or API client. This design keeps the signing boundary outside the Vortex API, but it also means the client must store the ephemeral secrets securely until the ramp has completed and any recovery window has passed.

    Recommended Integration Paths#

    Use the SDK when your application can run a trusted Node.js environment and wants Vortex to handle transaction signing and ramp update mechanics.
    Use the Widget when you want a hosted checkout experience and do not want to build the full user-facing ramp flow yourself.
    Use the raw API directly only when you need custom orchestration and are prepared to handle ephemeral key custody, signing, backups, ramp updates, and recovery flows yourself.
    Modified at 2026-05-16 09:50:54
    Next
    Vortex SDK
    Built with