Copy Page
Vortex
Documentation
Overview
Quick Start With The SDK
Authentication And API Keys
Ramp Lifecycle
Ephemeral Key Custody
Quotes And Pricing
Webhooks
Widget Integration
Fiat Corridors
Sandbox
Production Checklist
KYB Deep Link
Managed Profiles
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
Get authenticated user ramp history
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
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
List fiat accounts
Create a fiat account
Delete a fiat account
Get user ramp limits
Get sanitized ramp eligibility
Authentication
List the user's API keys
Create a user-linked API key pair
Revoke an API key
Request an email OTP
Verify an email OTP
List API credentials
Create an API credential
Revoke an API credential
KYC and KYB
Get KYB attempt status
Create KYB document
Get KYB document
Submit API-driven KYB
Start hosted KYB
Create KYB UBO
Import an individual KYC token
Record an initial KYC attempt
Get customer status
Create a business customer
Create an individual customer
Find KYB submission details
Get a KYB redirect link
Get a KYC redirect link
Get KYC or KYB status
Mark a redirect finished
Mark a redirect opened
Retry KYC or KYB
Send a KYB submission
Send a KYC submission
Upload a KYB file
Submit KYB information
Upload a related-person KYB file
Upload a KYC file
Submit KYC information
Select active customer entity
Discover KYC or KYB requirements
Get aggregate onboarding status
Managed Profiles
List managed profiles
Create a managed profile
Delete a managed profile
Get a managed profile
List a managed profile's API credentials
Create a managed profile API credential
Revoke a managed profile API credential
Schemas
AccountMeta
AveniaDocumentType
ApiCredential
AveniaKYCDataUploadRequest
ApiCredentialErrorResponse
AveniaKYCDataUploadResponse
ApiCredentialManagedSelectorErrorResponse
BrlaAddress
ApiValidationErrorResponse
BrlaErrorResponse
BrAddress
BrlaGetSelfieLivenessUrlResponse
BrDocumentType
BrlaValidatePixKeyResponse
BrErrorResponse
CleanupPhase
BrGetSelfieLivenessUrlResponse
CountryCode
BrImportKycTokenErrorResponse
CreateBestQuoteRequest
BrImportKycTokenRequest
CreateQuoteRequest
BrImportKycTokenResponse
BrKYCDataUploadRequest
BrKYCDataUploadResponse
DestinationType
BrKybAttemptStatusResponse
DocumentUploadEntry
BrKybDocumentRequest
ErrorResponse
BrKybDocumentResponse
FiatToken
BrKybDocumentUploadResponse
BrKybHostedResponse
GetRampErrorLogsResponse
BrKybLevel1Payload
GetRampHistoryResponse
BrManagedBadRequestResponse
BrUboControlRole
BrUboPayload
BrUboResponse
GetWidgetUrlLocked
BrValidatePixKeyResponse
GetWidgetUrlRefresh
KYCDataUploadFileFiles
KYCDocType
CreateApiCredentialRequest
KycLevel1Payload
CreateApiCredentialResponse
KycLevel1Response
ListUserApiKeysResponse
CreateManagedProfileRequest
Networks
CreateSubaccountRequest
OnChainToken
CreateSubaccountResponse
PaymentData
PaymentMethod
PresignedTx
QuoteResponse
DomesticAddFiatAccountRequest
RampCurrency
DomesticCountry
RampDirection
DomesticCountryAndCustomerTypeRequest
RampErrorLog
DomesticCountryRequest
RampPhase
DomesticCreateCustomerRequest
RampProcess
DomesticCreateCustomerResponse
RegisterRampRequest
DomesticCreateFiatAccountResponse
SimpleStatus
DomesticCustomerType
StartKYC2Request
DomesticErrorResponse
StartKYC2Response
DomesticFiatAccount
StartRampRequest
DomesticFiatAccountType
TaxIdType
DomesticKybBusinessSummary
TriggerOfframpRequest
DomesticKybDetailsResponse
TriggerOfframpResponse
DomesticKybFileUploadRequest
UnsignedTx
DomesticKybRelatedPerson
DomesticKybRelatedPersonFileUploadRequest
UserApiKeyErrorResponse
DomesticKycFileUploadRequest
UserApiKeyPairResponse
DomesticKycStatusResponse
ValidatePixKeyResponse
DomesticManagedBadRequestResponse
DomesticRedirectLinkResponse
DomesticRedirectNotificationRequest
DomesticRelatedPersonFileUploadRequest
DomesticRetryRequest
DomesticRetryResponse
DomesticSendSubmissionRequest
DomesticStatus
DomesticStatusResponse
DomesticSubmissionResponse
DomesticSubmitKybInformationRequest
DomesticSubmitKycInformationRequest
DomesticSuccessResponse
DomesticValidationBadRequestResponse
ErrorManagedSelectorResponse
FlatErrorResponse
FlatManagedSelectorErrorResponse
GetKycStatusResponse
GetRampHistoryTransaction
GetUserLimitsRequest
GetUserLimitsResponse
GetUserRemainingLimitResponse
GetUserResponse
KybAttemptStatusResponse
KybLevel1Response
ListApiCredentialsResponse
ListManagedProfilesResponse
MalformedJsonErrorResponse
ManagedProfile
ManagedProfileErrorResponse
ManagedProfilePagination
ManagedProfileResponse
ManagedSelectorErrorResponse
OnboardingApiErrorResponse
OnboardingDocumentRequirement
OnboardingRequirementStep
OnboardingRequirementsErrorResponse
OnboardingRequirementsResponse
OnboardingStatusErrorResponse
OnboardingStatusResponse
PayloadTooLargeErrorResponse
RampInfoResponse
RecordInitialKycAttemptRequest
SelectActiveCustomerEntityRequest
SelectActiveCustomerEntityResponse
SubmitInformationResponse
SubmitKybInformationRequest
SubmitKycInformationRequest
SuccessResponse
UpdateRampRequest
UserLimit
UserLimitPeriod
BrKybDocumentRequest
Copy Page
{
"documentType"
:
"ID"
,
"isDoubleSided"
:
true
}