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

    Documentation

    1.1.0
    Cross-border payments gateway built on the Pendulum blockchain.
    Scope: 25 paths verified against apps/api/src/api/routes/v1/.
    Auth principals:
    X-API-Key: sk_<live|test>_... — partner SDK key (server-side).
    X-Public-Key: pk_<live|test>_... — partner public key (browser; attribution only).
    Authorization: Bearer <Supabase JWT> — first-party user session.
    All /v1/brla/* endpoints accept Supabase Bearer only; partner sk_/pk_ keys are not accepted on BRLA routes.
    Webhook signing: RSA-PSS 2048 / SHA-256. Fetch the signing key from GET /v1/public-key.
    Next
    Overview
    Built with