# Vortex ## Docs - [General overview](https://api-docs.vortexfinance.co/general-overview-1020197m0.md): - [Vortex Ramp Integration Guide](https://api-docs.vortexfinance.co/vortex-ramp-integration-guide-1031617m0.md): - [Vortex SDK](https://api-docs.vortexfinance.co/vortex-sdk-1289458m0.md): - [Sandbox Environment](https://api-docs.vortexfinance.co/sandbox-environment-1698468m0.md): - Vortex Widget [Widget parameters](https://api-docs.vortexfinance.co/widget-parameters-1607353m0.md): - Account Management > Brazil [Brazilian KYC Process Overview](https://api-docs.vortexfinance.co/brazilian-kyc-process-overview-1034234m0.md): - Account Management > Europe [Coming soon...](https://api-docs.vortexfinance.co/coming-soon-1071976m0.md): - Webhooks [Overview](https://api-docs.vortexfinance.co/overview-1647467m0.md): - Public Key [Overview](https://api-docs.vortexfinance.co/overview-1648582m0.md): ## API Docs - Quotes [Get existing quote](https://api-docs.vortexfinance.co/get-existing-quote-16995799e0.md): Get a quote by ID. - Quotes [Create a new quote](https://api-docs.vortexfinance.co/create-a-new-quote-16994441e0.md): Generates a quote for a specified ramp transaction, detailing input and output amounts, fees, and expiration. - Quotes [Create a quote for the best network](https://api-docs.vortexfinance.co/create-a-quote-for-the-best-network-25012363e0.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. - Vortex Widget [Generate a widget URL (with quote refresh)](https://api-docs.vortexfinance.co/generate-a-widget-url-with-quote-refresh-21452254e0.md): You can call this endpoint to get a widget URL where the widget app will keep refreshing the quote with your specified direction, amount, and currencies. - Vortex Widget [Generating widget URL (for existing quote)](https://api-docs.vortexfinance.co/generating-widget-url-for-existing-quote-22803511e0.md): You can call this endpoint to get a widget URL ready with a quote you provide. You need to pass the `quoteId` parameter to the body, and optionally supply the `callbackUrl`, `walletAddressLocked` and `externalSessionId`. The quote will not automatically refresh and if it expires, the user needs to close the window and start over. - Ramp [Get ramp status](https://api-docs.vortexfinance.co/get-ramp-status-17091313e0.md): Fetches an updated ramp process. - Ramp [Get ramp history for wallet address](https://api-docs.vortexfinance.co/get-ramp-history-for-wallet-address-25789950e0.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. - Ramp [Register new ramp process](https://api-docs.vortexfinance.co/register-new-ramp-process-16993985e0.md): Initiates a new on-ramp or off-ramp process by providing quote details, signing accounts, and additional data. - Ramp [Update ramp process](https://api-docs.vortexfinance.co/update-ramp-process-19064414e0.md): Submits presigned transactions and additional data to an existing ramp process before starting it. - Ramp [Start ramp process ](https://api-docs.vortexfinance.co/start-ramp-process-16996027e0.md): Starts a ramp process. - Account Management > Brazil [Get user's remaining transaction limits](https://api-docs.vortexfinance.co/get-users-remaining-transaction-limits-17058160e0.md): - Account Management > Brazil [Get user information](https://api-docs.vortexfinance.co/get-user-information-17058159e0.md): Fetches a user's subaccount information. The response contains only the EVM wallet address and KYC level. - Account Management > Brazil [Get status of the last ramp event for a user](https://api-docs.vortexfinance.co/get-status-of-the-last-ramp-event-for-a-user-17058161e0.md): - Account Management > Brazil [Create user or retry KYC](https://api-docs.vortexfinance.co/create-user-or-retry-kyc-17058162e0.md): `companyName`, `startDate` and `cnpj` are only required when taxIdType is `CNPJ` - Account Management > Brazil [Get user's KYC status](https://api-docs.vortexfinance.co/get-users-kyc-status-17058163e0.md): - Account Management > Brazil [Start KYC level 2 process for a user](https://api-docs.vortexfinance.co/start-kyc-level-2-process-for-a-user-17058164e0.md): Requests document upload URLs for KYC level 2 verification. - Webhooks [Register Webhook](https://api-docs.vortexfinance.co/register-webhook-22047615e0.md): Register a new webhook to receive event notifications. - Webhooks [Delete Webhook](https://api-docs.vortexfinance.co/delete-webhook-22048225e0.md): Remove a webhook subscription. - Public Key [Public Key](https://api-docs.vortexfinance.co/public-key-22350420e0.md): - [Supported Payment Methods](https://api-docs.vortexfinance.co/supported-payment-methods-17829559e0.md): Retrieve all available payment methods, filtered by type or fiat. - [Supported Cryptocurrencies](https://api-docs.vortexfinance.co/supported-cryptocurrencies-17843883e0.md): Retrieve all supported cryptocurrencies, filtered by network. - [Supported Countries](https://api-docs.vortexfinance.co/supported-countries-23310478e0.md): - [Supported Fiat Currencies](https://api-docs.vortexfinance.co/supported-fiat-currencies-23310500e0.md): ## Schemas - Schemas [CleanupPhase](https://api-docs.vortexfinance.co/cleanupphase-6807872d0.md): - Schemas [StartRampRequest](https://api-docs.vortexfinance.co/startramprequest-8022378d0.md): - Schemas [RampDirection](https://api-docs.vortexfinance.co/rampdirection-8663998d0.md): - Schemas [GetWidgetUrlLocked](https://api-docs.vortexfinance.co/getwidgeturllocked-9868580d0.md): - Schemas [CountryCode](https://api-docs.vortexfinance.co/countrycode-10169616d0.md): - Schemas [PaymentMethod](https://api-docs.vortexfinance.co/paymentmethod-10209695d0.md): - Schemas [SimpleStatus](https://api-docs.vortexfinance.co/simplestatus-10209702d0.md): - Schemas [FiatToken](https://api-docs.vortexfinance.co/fiattoken-10222242d0.md): - Schemas [OnChainToken](https://api-docs.vortexfinance.co/onchaintoken-10222252d0.md): - Schemas [GetWidgetUrlRefresh](https://api-docs.vortexfinance.co/getwidgeturlrefresh-10229064d0.md): - Schemas [CreateBestQuoteRequest](https://api-docs.vortexfinance.co/createbestquoterequest-11328069d0.md): - Schemas [GetRampHistoryTransaction](https://api-docs.vortexfinance.co/getramphistorytransaction-11738211d0.md): - Schemas [GetRampHistoryResponse](https://api-docs.vortexfinance.co/getramphistoryresponse-11739039d0.md): - Schemas [RegisterRampRequest](https://api-docs.vortexfinance.co/registerramprequest-6807820d0.md): - Schemas [CreateQuoteRequest](https://api-docs.vortexfinance.co/createquoterequest-6808148d0.md): - Schemas [UpdateRampRequest](https://api-docs.vortexfinance.co/updateramprequest-6808895d0.md): - Schemas [BrlaErrorResponse](https://api-docs.vortexfinance.co/brlaerrorresponse-6837642d0.md): - Schemas [AccountMeta](https://api-docs.vortexfinance.co/accountmeta-6807821d0.md): - Schemas [QuoteResponse](https://api-docs.vortexfinance.co/quoteresponse-6808149d0.md): - Schemas [PresignedTx](https://api-docs.vortexfinance.co/presignedtx-6808896d0.md): - Schemas [GetUserResponse](https://api-docs.vortexfinance.co/getuserresponse-6837643d0.md): - Schemas [Networks](https://api-docs.vortexfinance.co/networks-6807822d0.md): - Schemas [RampCurrency](https://api-docs.vortexfinance.co/rampcurrency-6808150d0.md): - Schemas [PaymentData](https://api-docs.vortexfinance.co/paymentdata-6807823d0.md): - Schemas [GetKycStatusResponse](https://api-docs.vortexfinance.co/getkycstatusresponse-6837645d0.md): - Schemas [RampProcess](https://api-docs.vortexfinance.co/rampprocess-6807824d0.md): - Schemas [ValidatePixKeyResponse](https://api-docs.vortexfinance.co/validatepixkeyresponse-6837646d0.md): - Schemas [RampPhase](https://api-docs.vortexfinance.co/rampphase-6807825d0.md): - Schemas [GetUserRemainingLimitResponse](https://api-docs.vortexfinance.co/getuserremaininglimitresponse-6837647d0.md): - Schemas [DestinationType](https://api-docs.vortexfinance.co/destinationtype-6807826d0.md): - Schemas [TriggerOfframpRequest](https://api-docs.vortexfinance.co/triggerofframprequest-6837648d0.md): - Schemas [UnsignedTx](https://api-docs.vortexfinance.co/unsignedtx-6807827d0.md): - Schemas [TriggerOfframpResponse](https://api-docs.vortexfinance.co/triggerofframpresponse-6837649d0.md): - Schemas [ErrorResponse](https://api-docs.vortexfinance.co/errorresponse-6807828d0.md): - Schemas [BrlaAddress](https://api-docs.vortexfinance.co/brlaaddress-6837650d0.md): - Schemas [TaxIdType](https://api-docs.vortexfinance.co/taxidtype-6837651d0.md): - Schemas [CreateSubaccountRequest](https://api-docs.vortexfinance.co/createsubaccountrequest-6837652d0.md): - Schemas [CreateSubaccountResponse](https://api-docs.vortexfinance.co/createsubaccountresponse-6837653d0.md): - Schemas [KYCDocType](https://api-docs.vortexfinance.co/kycdoctype-6837654d0.md): - Schemas [KYCDataUploadFileFiles](https://api-docs.vortexfinance.co/kycdatauploadfilefiles-6837655d0.md): - Schemas [StartKYC2Request](https://api-docs.vortexfinance.co/startkyc2request-6837656d0.md): - Schemas [StartKYC2Response](https://api-docs.vortexfinance.co/startkyc2response-6837657d0.md):