Rio API

Addresses

Register a new address

Get a list of registered addresses that match the query. If no query is passed, it will return all addresses.

Gets addresses

Users

Create a new user

Updates the user associated with the API key.

Update user

Gets a list of users that match the query. If no query is passed, it will return all users.

Get all users

Get a user by id

Update user by id

Upload a file

Gets the file associated with the user (returns a ZIP file when getting a user's extra files)

Get user's file

Gets the requirements for a user to onboard in the given country

Get user onboarding requirements

Sends an email to the user with a link to the partner onboarding page. Only required when onboarding in the US.

Send partner onboarding email

Ubos

Create a new ubo

Get a ubo by id

Gets the file associated with the UBO (returns a ZIP file when getting a UBO's extra files)

Get ubo's file

Gets the requirements for a UBO to onboard in the given country

Get ubo onboarding requirements

Sends a identity verification email to the user. Required when onboarding outside the US.

Send identity verification email

Orders

Gets a list of orders that match the query. If no query is passed, it will return all 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 by id

Get a list of chained orders that match the query. if no query is passed, it will return all chained orders.

Create a chained order

Get a chained order by id

Cancels the chained order with the specified ID.

Cancel chained order

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.

Confirm payment was sent.

Bank Payouts

Creates a bank payout for an order. A bank payout contains the details of the bank account to send the payout to.

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

Bank Accounts

Create a non-us bank account.

Get a list of non-us bank accounts that match the query. if no query is passed, it will return all non-us bank accounts.

Get a non-us bank account by id

Update a non-us bank account

Delete a non-us bank account

Us Bank Accounts

Register us bank account

Get a list of us bank accounts that match the query.

Invoices

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

Get invoice

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

<p class="slate-p" placeholder="Type / for widgets">API for the Rio platform</p>