Copy Page
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 new quote
Get existing quote
Create a quote for the best network
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
AveniaDocumentType
AveniaKYCDataUploadRequest
AveniaKYCDataUploadResponse
BrlaAddress
BrlaErrorResponse
BrlaGetSelfieLivenessUrlResponse
BrlaValidatePixKeyResponse
CleanupPhase
CountryCode
CreateBestQuoteRequest
CreateQuoteRequest
CreateSubaccountRequest
CreateSubaccountResponse
DestinationType
DocumentUploadEntry
ErrorResponse
FiatToken
GetKycStatusResponse
GetRampErrorLogsResponse
GetRampHistoryResponse
GetRampHistoryTransaction
GetUserRemainingLimitResponse
GetUserResponse
GetWidgetUrlLocked
GetWidgetUrlRefresh
KYCDataUploadFileFiles
KYCDocType
KycLevel1Payload
KycLevel1Response
Networks
OnChainToken
PaymentData
PaymentMethod
PresignedTx
QuoteResponse
RampCurrency
RampDirection
RampErrorLog
RampPhase
RampProcess
RegisterRampRequest
SimpleStatus
StartKYC2Request
StartKYC2Response
StartRampRequest
TaxIdType
TriggerOfframpRequest
TriggerOfframpResponse
UnsignedTx
UpdateRampRequest
ValidatePixKeyResponse
DestinationType
Copy Page
Represents either a blockchain network or a traditional payment method.
"assethub"