# Vortex ## Docs - [Root](https://api-docs.vortexfinance.co/3764829f0.md): - Root [Overview](https://api-docs.vortexfinance.co/overview.md): - Root [Quick Start With The SDK](https://api-docs.vortexfinance.co/quick-start-with-the-sdk.md): - Root [Authentication And Partner Keys](https://api-docs.vortexfinance.co/authentication-and-partner-keys.md): - Root [Ramp Lifecycle](https://api-docs.vortexfinance.co/ramp-lifecycle.md): - Root [Ephemeral Key Custody](https://api-docs.vortexfinance.co/ephemeral-key-custody.md): - Root [Quotes And Pricing](https://api-docs.vortexfinance.co/quotes-and-pricing.md): - Root [Webhooks](https://api-docs.vortexfinance.co/webhooks.md): - Root [Widget Integration](https://api-docs.vortexfinance.co/widget-integration.md): - Root [BRL / KYC notes](https://api-docs.vortexfinance.co/brl-kyc-notes.md): - Root [Sandbox](https://api-docs.vortexfinance.co/sandbox.md): - Root [Production Checklist](https://api-docs.vortexfinance.co/production-checklist.md): - Root [AI Agent Integration](https://api-docs.vortexfinance.co/ai-agent-integration.md): - [Root](https://api-docs.vortexfinance.co/8605581f0.md): ## API Docs - Root > Vortex Widget [Create widget session](https://api-docs.vortexfinance.co/36049240e0.md): Creates a hosted Vortex Widget session and returns the URL to open for the user. - Root > Quotes [Create a quote for the best network](https://api-docs.vortexfinance.co/36049233e0.md): Generates a new quote for the network that yields the highest output amount for the given parameters. This endpoint compares the output for a given input amount over all supported networks and returns the 'best' quote, defined as the one with the highest output. - Root > Quotes [Create a new quote](https://api-docs.vortexfinance.co/36049231e0.md): Generates a quote for a specified ramp transaction, detailing input and output amounts, fees, and expiration. - Root > Quotes [Get existing quote](https://api-docs.vortexfinance.co/36049232e0.md): Get a quote by ID. - Root > Ramp [Get ramp status](https://api-docs.vortexfinance.co/36049234e0.md): Fetches an updated ramp process. - Root > Ramp [Get ramp error logs](https://api-docs.vortexfinance.co/36049235e0.md): Returns the chronological error log for a ramp. - Root > Ramp [Get ramp history for wallet address](https://api-docs.vortexfinance.co/36049236e0.md): Fetches the transaction history for a given wallet address. The response returns the last 20 items by default. This can be adjusted by using the `limit` and `offset` query parameters. - Root > Ramp [Register new ramp process](https://api-docs.vortexfinance.co/36049237e0.md): Initiates a new on-ramp or off-ramp process by providing quote details, signing accounts, and additional data. - Root > Ramp [Start ramp process ](https://api-docs.vortexfinance.co/36049238e0.md): Starts a ramp process. - Root > Ramp [Update ramp process](https://api-docs.vortexfinance.co/36049239e0.md): Submits presigned transactions and additional data to an existing ramp process before starting it. - Root > Reference Data [Supported Countries](https://api-docs.vortexfinance.co/36049241e0.md): - Root > Reference Data [Supported Cryptocurrencies](https://api-docs.vortexfinance.co/36049242e0.md): Retrieve all supported cryptocurrencies, filtered by network. - Root > Reference Data [Supported Fiat Currencies](https://api-docs.vortexfinance.co/36049243e0.md): - Root > Reference Data [Supported Payment Methods](https://api-docs.vortexfinance.co/36049244e0.md): Retrieve all available payment methods, filtered by type or fiat. - Root > Public Key [Public Key](https://api-docs.vortexfinance.co/36049230e0.md): - Root > Webhooks [Register Webhook](https://api-docs.vortexfinance.co/36049245e0.md): Register a new webhook to receive event notifications. - Root > Webhooks [Delete Webhook](https://api-docs.vortexfinance.co/36049246e0.md): Remove a webhook subscription. - Root > Account Management [Create user or retry KYC](https://api-docs.vortexfinance.co/36049222e0.md): `companyName`, `startDate` and `cnpj` are only required when taxIdType is `CNPJ` - Root > Account Management [Get user's KYC status](https://api-docs.vortexfinance.co/36049223e0.md): - Root > Account Management [Get selfie liveness URL](https://api-docs.vortexfinance.co/36049224e0.md): Returns the Avenia selfie/liveness-check URL for the subaccount associated with this tax ID. - Root > Account Management [Get KYC document upload URLs](https://api-docs.vortexfinance.co/36049225e0.md): Returns presigned upload URLs for the user's ID document and selfie. Only `ID` and `DRIVERS-LICENSE` are accepted for `documentType` (passport not supported here). - Root > Account Management [Get user information](https://api-docs.vortexfinance.co/36049226e0.md): Fetches a user's subaccount information. The response contains only the EVM wallet address and KYC level. - Root > Account Management [Get user's remaining transaction limits](https://api-docs.vortexfinance.co/36049227e0.md): - Root > Account Management [Submit KYC level 1 data](https://api-docs.vortexfinance.co/36049228e0.md): Submits the user's KYC level 1 payload to Avenia after documents have been uploaded via `/v1/brla/getUploadUrls`. Includes a built-in 5-second delay to allow upstream document propagation. - Root > Account Management [Validate Pix key](https://api-docs.vortexfinance.co/36049229e0.md): Checks whether a Pix key exists and is valid. The key value itself is intentionally not echoed back in the response for security. ## Schemas - Root [AccountMeta](https://api-docs.vortexfinance.co/15069480d0.md): - Root [CreateBestQuoteRequest](https://api-docs.vortexfinance.co/15069490d0.md): - Root [AveniaDocumentType](https://api-docs.vortexfinance.co/15069481d0.md): - Root [Networks](https://api-docs.vortexfinance.co/15069510d0.md): - Root [AveniaKYCDataUploadRequest](https://api-docs.vortexfinance.co/15069482d0.md): - Root [AveniaKYCDataUploadResponse](https://api-docs.vortexfinance.co/15069483d0.md): - Root [BrlaAddress](https://api-docs.vortexfinance.co/15069484d0.md): - Root [BrlaErrorResponse](https://api-docs.vortexfinance.co/15069485d0.md): - Root [BrlaGetSelfieLivenessUrlResponse](https://api-docs.vortexfinance.co/15069486d0.md): - Root [BrlaValidatePixKeyResponse](https://api-docs.vortexfinance.co/15069487d0.md): - Root [CleanupPhase](https://api-docs.vortexfinance.co/15069488d0.md): - Root [CountryCode](https://api-docs.vortexfinance.co/15069489d0.md): - Root [CreateQuoteRequest](https://api-docs.vortexfinance.co/15069491d0.md): - Root [CreateSubaccountRequest](https://api-docs.vortexfinance.co/15069492d0.md): - Root [CreateSubaccountResponse](https://api-docs.vortexfinance.co/15069493d0.md): - Root [DestinationType](https://api-docs.vortexfinance.co/15069494d0.md): - Root [DocumentUploadEntry](https://api-docs.vortexfinance.co/15069495d0.md): - Root [ErrorResponse](https://api-docs.vortexfinance.co/15069496d0.md): - Root [FiatToken](https://api-docs.vortexfinance.co/15069497d0.md): - Root [GetKycStatusResponse](https://api-docs.vortexfinance.co/15069498d0.md): - Root [GetRampErrorLogsResponse](https://api-docs.vortexfinance.co/15069499d0.md): - Root [GetRampHistoryResponse](https://api-docs.vortexfinance.co/15069500d0.md): - Root [GetRampHistoryTransaction](https://api-docs.vortexfinance.co/15069501d0.md): - Root [GetUserRemainingLimitResponse](https://api-docs.vortexfinance.co/15069502d0.md): - Root [GetUserResponse](https://api-docs.vortexfinance.co/15069503d0.md): - Root [GetWidgetUrlLocked](https://api-docs.vortexfinance.co/15069504d0.md): - Root [GetWidgetUrlRefresh](https://api-docs.vortexfinance.co/15069505d0.md): - Root [KYCDataUploadFileFiles](https://api-docs.vortexfinance.co/15069506d0.md): - Root [KYCDocType](https://api-docs.vortexfinance.co/15069507d0.md): - Root [KycLevel1Payload](https://api-docs.vortexfinance.co/15069508d0.md): - Root [KycLevel1Response](https://api-docs.vortexfinance.co/15069509d0.md): - Root [OnChainToken](https://api-docs.vortexfinance.co/15069511d0.md): - Root [PaymentData](https://api-docs.vortexfinance.co/15069512d0.md): - Root [PaymentMethod](https://api-docs.vortexfinance.co/15069513d0.md): - Root [PresignedTx](https://api-docs.vortexfinance.co/15069514d0.md): - Root [QuoteResponse](https://api-docs.vortexfinance.co/15069515d0.md): - Root [RampCurrency](https://api-docs.vortexfinance.co/15069516d0.md): - Root [RampDirection](https://api-docs.vortexfinance.co/15069517d0.md): - Root [RampErrorLog](https://api-docs.vortexfinance.co/15069518d0.md): - Root [RampPhase](https://api-docs.vortexfinance.co/15069519d0.md): - Root [RampProcess](https://api-docs.vortexfinance.co/15069520d0.md): - Root [RegisterRampRequest](https://api-docs.vortexfinance.co/15069521d0.md): - Root [SimpleStatus](https://api-docs.vortexfinance.co/15069522d0.md): - Root [StartKYC2Request](https://api-docs.vortexfinance.co/15069523d0.md): - Root [StartKYC2Response](https://api-docs.vortexfinance.co/15069524d0.md): - Root [StartRampRequest](https://api-docs.vortexfinance.co/15069525d0.md): - Root [TaxIdType](https://api-docs.vortexfinance.co/15069526d0.md): - Root [TriggerOfframpRequest](https://api-docs.vortexfinance.co/15069527d0.md): - Root [TriggerOfframpResponse](https://api-docs.vortexfinance.co/15069528d0.md): - Root [UnsignedTx](https://api-docs.vortexfinance.co/15069529d0.md): - Root [UpdateRampRequest](https://api-docs.vortexfinance.co/15069530d0.md): - Root [ValidatePixKeyResponse](https://api-docs.vortexfinance.co/15069531d0.md):