API Reference

Auth

Get auth

Updates an auth object. If called with just the phoneVerifiedJWT, must provide the security answer and can only update the password.

Update auth

Creates an API key associated to the auth object

Create api key

Delete api key

Addresses

Runs a background check on a wallet address and saves it for future use

Register a new address

Get addresses

Users

Create a new user

Updates the user associated with the api key or access token

Update current user

This endpoint will return the user associated with the JWT or API key if no query params are passed. If they are passed, it will return a list of user's that the current user has access to that match the query.

Get a user account(s)

Get a user by id

Update user by id

This is only necesarry for business users

Upload a certificate of incorporation file

This optional file is a KYC report created by an IDV vendor

Upload a kyc report file

This is the Constancia de Situacion Fiscal if the user is Mexican or the Ficha RUC if the user is Peruvian

Upload a csf file

This is can be an electricity bill, a phone bill, a gas bill, or a water bi..

Upload a proof of address file

Gets the external onboarding links for the user from our US partner

Get us onboarding links

Registers a new phone number that can access the account. If no user ID is passed, the phone number is added to the user associated with the API key.

Add an authorized phone number

Deletes a phone number that has access to the account. If no user ID is passed, the phone number is deleted from the user associated with the API key.

Delete an authorized phone number

Orders

Get orders

Create a new order

If an ID is passed, it cancels the order. If none is passed, it cancels all active orders for the user.

Cancel order(s)

Get an order

Get chained orders

Create a chained order

Get a chained order

If an ID is passed, it cancels the chained order. If none is passed, it cancels all active chained orders for the user.

Cancel chained order(s)

Bank Payments

Gets the details of a bank payment associated to an order

Get a bank payment

Although most payments are processed automatically, this endpoint gives users the ability to specify that a payment was made.

Verify a bank transfer payment

Bank Payouts

Creates a bank payout for an order. Only one per order.

Create a bank payout

Get the bank payout associated to an order

Get bank payout

Quotes

Create a quote

Get a quote

Creates a quote for an on ramp and then an off ramp

Create a chained quote

Get a chained quote

Get a users current platform fee in mexico based on their last 14 day volume

Bank Accounts

Create a non-us bank account

Get a list of non-us bank accounts

Get a user's non-us bank accounts

Update a non-us bank account

Deletes a non-us bank account

Get a users us bank accounts

Us Bank Accounts

Creates a Plaid link to create US bank account

Get plaid link

Exchange plaid public token

Creates a US bank account manually when using Plaid is not an option

Create a us bank account (manually)

Invoices

Gets an invoice issued by Rio either by its ID or the associated order ID

Get invoice

Creates and returns a KYC verification link

Get kyc verification link

Payment Methods

Get available payment methods

Get available payout methods

Wallet

Get user's asset balance

Webhooks

Registers a webhook with for given event type and user. If user is a broker, will also receive events for its broker customers.

Register webhook

Rio API

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets">The Rio API section provides access to the API Reference endpoint of the Rio platform. This API allows you to retrieve information and interact with various features of the Rio platform. The API Reference endpoint serves as a central hub for accessing comprehensive documentation and resources related to the Rio API. By utilizing the Rio API, you can seamlessly integrate and leverage the functionality of the Rio platform within your own applications. Whether you are a developer looking to build custom integrations or a non-technical user seeking to understand the capabilities of the Rio platform, the Rio API section offers a straightforward and comprehensive guide to facilitate API integration.</p>

The Rio API section provides access to the API Reference endpoint of the Rio platform. This API allows you to retrieve information and interact with various features of the Rio platform. The API Reference endpoint serves as a central hub for accessing comprehensive documentation and resources related to the Rio API. By utilizing the Rio API, you can seamlessly integrate and leverage the functionality of the Rio platform within your own applications. Whether you are a developer looking to build custom integrations or a non-technical user seeking to understand the capabilities of the Rio platform, the Rio API section offers a straightforward and comprehensive guide to facilitate API integration.

API endpoint: Auth

The Auth API endpoint provides functionalities for authenticating Rio users. This API allows you to securely authenticate users and manage their access to Rio's features and resources. With the Auth API, you can easily implement user authentication and authorization in your application.

By using the Auth API, you can validate user credentials, such as username and password, to ensure only authorized users have access to Rio. This helps to safeguard sensitive user data and prevent unauthorized access to Rio's resources.

Additionally, the Auth API supports various authentication methods, including OAuth, token-based authentication, and multi-factor authentication. You can choose the authentication method that best suits your application's requirements and security needs.

With the flexibility provided by the Auth API, you can seamlessly integrate Rio's authentication system into your application, providing a secure and streamlined user experience. Whether you are building a web application, mobile app, or any other type of software that interacts with Rio, the Auth API makes the process of authenticating users straightforward and efficient.

Please refer to the detailed documentation for the Auth API section to learn more about the available endpoints, request parameters, and response formats. The documentation will guide you through the process of integrating the Auth API into your application and provide examples to help you get started quickly.

This API endpoint allows you to retrieve the authentication details for a specific user. By providing the unique identifier (ID) of the authentication object, you can retrieve information such as the phone number, password, security question and answer (hashed), list of previously used passwords (hashed), list of API keys (hashed), and whether the authentication is disabled. This endpoint is useful for applications that require user authentication and need access to these details for further processing or verification.

The API key used for authentication and authorization.

x-api-key

The unique identifier for the authentication.

The phone number registered with the authentication.

phoneNumber

The password registered with the authentication.

password

The security question registered with the authentication.

securityQuestion

The answer to the security question provided during authentication. It is stored in a hashed format for security purposes.

securityAnswer

A list of previously used passwords associated with the authentication. Each password is stored in a hashed format for security purposes.

previousPasswords

A list of API keys registered to this authentication. Each API key is stored in a hashed format for security purposes.

apiKeys

Indicates whether the authentication is currently disabled or enabled.

isDisabled

The patch /api/auth/{id} endpoint allows you to update an auth object in the Rio API. This endpoint is used for making changes to the authentication information associated with a user account.

When calling this endpoint, you can update the password of the auth object by providing the phoneVerifiedJWT along with the security answer. It is important to note that if you choose to update the password using this method, you must also provide the corresponding security question for verification purposes.

This API endpoint is designed to make the integration process straightforward. It allows you to easily update the authentication details for a user account, ensuring that the information is accurate and up to date.

To use this endpoint, you need to provide the necessary parameters through the request body. These parameters include the phoneNumber, password, securityQuestion, and securityAnswer.

By leveraging the patch /api/auth/{id} endpoint, you can seamlessly modify the authentication information associated with a user account within the Rio API.

The phone number associated with the authentication.

The password associated with the authentication.

The security question used to verify and update the password.

The answer to the security question used for authentication.

Auth update successfull

This API endpoint allows you to create an API key that is associated with the specified auth object. The API key can be given an optional label for easy identification. Once created, the API key will be returned with a status code of 201. The response will include the API key value and label. This functionality simplifies the process of generating and managing API keys for your applications.

An optional label that can be assigned to the API key for easy identification and organization.

label

The header parameter used to securely transmit the API key value in the HTTP request. This parameter ensures that the API key is properly authenticated and authorized for access to the specified endpoint.

The value of the generated API key, which is a unique identifier used for authorization and authentication purposes.

value


The delete /api/auth/{authId}/api-key/{id} API endpoint allows you to delete an API key associated with a specific authentication ID. This functionality is useful when you no longer need a particular API key and want to remove it from your system.

By making a request to this endpoint, you can effectively delete the API key identified by its unique ID (provided as a path parameter). This action permanently removes the API key from the system, ensuring that it can no longer be used for authentication purposes.

Deleting an API key is a straightforward process, and it can be utilized in various scenarios, such as when an API key has expired, or when a user no longer requires access to specific API functionalities. This endpoint facilitates the removal of unnecessary API keys, helping you maintain a clean and secure authentication system.

To delete an API key, you need to include the ID of the key you wish to remove as a path parameter. Additionally, make sure to include the x-api-key header with a valid API key that has the necessary permissions for performing this action.

Please note that once an API key is deleted, it cannot be restored. Therefore, exercise caution when using this endpoint to avoid accidental removal of important API keys.

The unique identifier of the API key that needs to be deleted.

API key deleted

The Rio API provides a comprehensive set of APIs for managing wallet addresses. With these APIs, you can easily retrieve, create, update, and delete addresses associated with user wallets. Whether you are building a financial application, an e-commerce platform, or simply need to track user addresses, the Addresses API is the solution for you. It offers a seamless integration experience, allowing you to streamline your operations and provide a smooth user experience. Additionally, the Rio API pr

The Users API section provides functionality for managing users in the Rio API. This API allows you to perform various operations related to user management, such as creating new users, retrieving user information, updating user details, and deleting users. With the Users API, you can easily handle user accounts within your application. Whether you need to register new users, retrieve specific user information, update user profiles, or remove users from your system, the Users API has you covered

APIs for managing orders - This section of the Rio API provides functionality for managing orders. It enables you to retrieve, create, update, and delete orders in your system. Whether you need to fetch information about a specific order or perform bulk operations on multiple orders, this API endpoint gives you the flexibility to integrate order management seamlessly into your application. With the Rio API's order management capabilities, you can streamline your processes, track order status, an

The Rio API provides a set of functionalities for managing bank payments. This API allows users to integrate their applications with Rio's banking system and perform various actions related to bank payments. With the Rio API, developers can create, retrieve, update, and delete bank payment records. This includes functionalities such as initiating bank transfers, checking the status of payments, retrieving transaction histories, and managing payment beneficiaries. The Rio API simplifies the integ

The Bank Payouts API section provides functionality for managing bank payouts within the Rio API. This API enables you to perform tasks related to bank payouts, allowing you to easily transfer funds from your account to external bank accounts. Whether you are a developer or a non-technical user, this API section provides all the necessary information to integrate and utilize bank payouts seamlessly. It includes detailed instructions, use-cases, and any special considerations or features specific

The Rio API's Quotes section provides functionalities for managing quotes. This API endpoint allows you to retrieve information related to quotes, including their details and associated data. By integrating with this endpoint, you can efficiently manage and access quote-related information within your application. The Quotes section offers a range of features and capabilities to support your quote management needs. Whether you are retrieving quote details, accessing specific data related to quot

API Endpoint: Bank Accounts

The Bank Accounts API allows you to manage and interact with bank accounts through the Rio API. This API provides functionality for creating, retrieving, updating, and deleting bank accounts associated with your project.

With the Bank Accounts API, you can easily integrate bank account management into your application or system. This includes performing tasks such as adding new bank accounts, retrieving details of existing bank accounts, updating account information

The Rio API provides a set of endpoints for managing US bank accounts. With these APIs, you can perform various actions related to US bank accounts, such as creating, updating, and deleting accounts. By integrating the Rio API into your applications or systems, you can automate processes involving US bank accounts, streamline workflows, and provide a seamless banking experience for your users. Whether you are building a financial app, a payment gateway, or any other solution that involves US ban

The Invoices API section provides functionality for managing invoices within the Rio API. With these APIs, you can easily create, retrieve, update, and delete invoices in your system. The Invoices API allows you to seamlessly integrate Rio's invoicing capabilities into your application or platform. Whether you need to generate invoices for products or services, track payment statuses, or retrieve invoice details, this section provides the necessary endpoints and methods to handle all these opera

This section of the Rio API provides a set of APIs for managing KYC (Know Your Customer) verifications. These APIs enable you to seamlessly integrate KYC verification functionality into your applications. With the Rio API, you can easily perform actions such as submitting KYC documents, retrieving verification status, and updating customer information. Whether you are a developer or a non-technical professional, our intuitive and well-documented APIs make the integration process straightforward.

The Payment Methods API section provides functionality for managing payment methods within the Rio API. This API allows you to seamlessly integrate payment methods into your application, enabling users to securely make payments using their preferred payment methods. Whether you need to create, retrieve, update, or delete payment methods, this API provides the necessary endpoints to perform these actions. Additionally, the Payment Methods API supports various payment methods, including credit car