Getting Started with the Rio API

This page will help you get started with Rio API

Welcome to Rio!

You're on your way to integrating a great on / off solution .

About Rio

Rio is a virtual asset on and off ramp platform.

Types of users

There are two types of users that can place orders on Rio: individual and business users. Individual users are creating orders for themselves and not their business or a third party. These users can only purchase through the Rio checkout UI and do not have access to the Rio API.

Business users are creating orders for their business or one of their customers. These users can purchase through the Rio checkout UI or the Rio API (after requesting access).

Note: If you are a business and want to place orders on behalf of your customers, you have to be granted the special role of broker. This is relatively simple and can be done after creating your business account and contacting support at [email protected]

Getting started

To begin using the Rio API, you must first create a business account. To do so, go to the Rio checkout component , open the hamburger menu on the top right, and click Login or Signup. Then, follow the instructions to create your business account.

Once your account has been created, you will need to generate your API keys. To do so, please contact [email protected].

Authentication

To authenticate requests through the API, you will need to pass a valid API key in your request headers as an "x-api-key" field.

For example, this a request to create a business user using API key authentication:

curl --request POST \
  --url https://www.riotransfer.co/api/users \
  --header 'Content-Type: application/json ' \
  --header 'x-api-key:YOUR_API_KEY' \
  --data '{
  "type": "business",
  "companyName": "Acme Inc",
  "legalRepresentative": "John Doe",
  "email": "[email protected]",
  "phoneNumber": "+525561665454",
  "language": "en",
  "street1": "10 Newark St",
  "street2": "Unit 5",
  "city": "Queretaro",
  "state": "Queretaro",
  "country": "MX",
  "brokerId": "63ef91b3ed2e4207cb530f65"
  "postalCode": "76100",
}'

💬 We're here to help!

If you have any issues, contact [email protected] with a description of your problem and we will get back to you as soon as possible.

We're excited you're here! :blue-heart: