API explorerChangelog
API explorer
Changelog

Dark mode

Rio API

API for the Rio platform

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://www.riotransfer.co

Sandbox:

https://sandbox.riotransfer.co

Language Box

Addresses

APIs for managing wallet addresses

Users

APIs for managing users

Ubos

APIs for managing UBOs

Was this section helpful?

What made this section unhelpful for you?

Create a new ubo

Creates a new UBO for user

Header Parameters

x-api-keystring

Body Parameters

associatedUserIdstring (objectid)

ID of the user associated to the UBO

individualDataobject

Individual data of the UBO.

Nullable:
True

Show child attributes

phoneNumberstring

The UBO's phone number.

Pattern
^\+(?:[0-9]●?){6,14}[0-9]$
emailstring (email)

The UBO's email address.

onboardingobject
Nullable:
True

Show child attributes

Responses

201
Object
UBO created successfully

Response Attributes

idstring (objectid)

ID of the UBO

associatedUserIdstring (objectid)

ID of the user associated to the UBO

individualDataobject

Individual data of the UBO.

Nullable:
True

Show child attributes

phoneNumberstring

The UBO's phone number.

Pattern
^\+(?:[0-9]●?){6,14}[0-9]$
emailstring (email)

The UBO's email address.

onboardingobject
Nullable:
True

Show child attributes

400
Object
Invalid request data
401
Object
Unauthorized
Was this section helpful?

What made this section unhelpful for you?

POST

/api/ubos

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 curl --location 'https://www.riotransfer.co/api/ubos' \ --data '{ "associatedUserId": "", "individualData": { "firstName": "", "middleName": "", "lastName": "", "secondLastName": "", "birthday": "" }, "phoneNumber": "", "email": "", "onboarding": { "MX": { "personalId": "", "taxId": "", "address": { "street1": "", "street2": "", "city": "", "state": "", "country": "DZ", "postalCode": "" } }, "PE": { "personalId": "", "taxId": "", "address": { "street1": "", "street2": "", "city": "", "state": "", "country": "DZ", "postalCode": "" } } } }'

Response

{
  "id": "",
  "associatedUserId": "",
  "individualData": {
    "firstName": "",
    "middleName": "",
    "lastName": "",
    "secondLastName": "",
    "birthday": ""
  },
  "phoneNumber": "",
  "email": "",
  "onboarding": {
    "MX": {
      "personalId": "",
      "taxId": "",
      "address": {
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "country": "DZ",
        "postalCode": ""
      }
    },
    "PE": {
      "personalId": "",
      "taxId": "",
      "address": {
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "country": "DZ",
        "postalCode": ""
      }
    }
  }
}

Get a ubo by id

Gets the UBO associated with the ID

Header Parameters

x-api-keystring

Path Parameters

idstring (objectid)Required

ID of the UBO

Responses

200
Object
Returns the UBO associated with ID

Response Attributes

idstring (objectid)

ID of the UBO

associatedUserIdstring (objectid)

ID of the user associated to the UBO

individualDataobject

Individual data of the UBO.

Nullable:
True

Show child attributes

phoneNumberstring

The UBO's phone number.

Pattern
^\+(?:[0-9]●?){6,14}[0-9]$
emailstring (email)

The UBO's email address.

onboardingobject
Nullable:
True

Show child attributes

401
Object
Unauthorized
Was this section helpful?

What made this section unhelpful for you?

GET

/api/ubos/{id}

Select
1 curl --location --globoff 'https://www.riotransfer.co/api/ubos/{id}'

Response

{
  "id": "",
  "associatedUserId": "",
  "individualData": {
    "firstName": "",
    "middleName": "",
    "lastName": "",
    "secondLastName": "",
    "birthday": ""
  },
  "phoneNumber": "",
  "email": "",
  "onboarding": {
    "MX": {
      "personalId": "",
      "taxId": "",
      "address": {
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "country": "DZ",
        "postalCode": ""
      }
    },
    "PE": {
      "personalId": "",
      "taxId": "",
      "address": {
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "country": "DZ",
        "postalCode": ""
      }
    }
  }
}

Upload a file

Uploads a file to the UBO's record

Header Parameters

x-api-keystring

Path Parameters

idstring (objectid)Required

ID of the UBO

countrystring Required

Country where the user associated to the UBO is onboarding to

Enum values:
MXPEUS
fileTypestring Required

Type of file being uploaded

Enum values:
certificateOfIncorporationKYCReporttaxTranscriptproofOfAddressbusinessRegistrationtaxIdentificationCertificatelegalRepresentativeIdPowerOfAttorneypersonalIdentificationCertificateextraFile

Body Parameters

filestring (binary)

File to be uploaded. Maximum size: 10MB.

Responses

200
Object
File uploaded successfully
400
Object
Invalid request data
401
Object
Unauthorized
Was this section helpful?

What made this section unhelpful for you?

POST

/api/ubos/{id}/files/{country}/{fileType}

Select
1 curl --location --globoff --request POST 'https://www.riotransfer.co/api/ubos/{id}/files/MX/certificateOfIncorporation'

Response

File uploaded successfully

Get ubo's file

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

Header Parameters

x-api-keystring

Path Parameters

idstring (objectid)Required

ID of the UBO

countrystring Required

Country of the file

Enum values:
MXPEUS
fileTypestring Required

Type of file being downloaded

Enum values:
certificateOfIncorporationKYCReporttaxTranscriptproofOfAddressbusinessRegistrationtaxIdentificationCertificatelegalRepresentativeIdPowerOfAttorneypersonalIdentificationCertificateextraFile

Responses

200
Object
Returns the file associated with the UBO
401
Object
Unauthorized
Was this section helpful?

What made this section unhelpful for you?

GET

/api/ubos/{id}/files/{country}/{fileType}

Select
1 curl --location --globoff 'https://www.riotransfer.co/api/ubos/{id}/files/MX/certificateOfIncorporation'

Response

Returns the file associated with the UBO

Get ubo onboarding requirements

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

Header Parameters

x-api-keystring

Query Parameters

countrystring

Country where the UBO is onboarding to

Enum values:
MXPEUS
CountryOfOriginstring

Country of origin of the UBO

Enum values:
DZARAUATBEBOBRCACLCO
... 45 other enums

Responses

200
Object
Returns the onboarding requirements for a UBO to onboard in the given country

Response Attributes

textRequirementsarray

Text requirements for the UBO to onboard

Enum values:
personalIdtaxId

Show child attributes

fileRequirementsarray

File requirements for the UBO to onboard

Enum values:
certificateOfIncorporationKYCReporttaxTranscriptproofOfAddressbusinessRegistrationtaxIdentificationCertificatelegalRepresentativeIdPowerOfAttorneypersonalIdentificationCertificate

Show child attributes

400
Object
Invalid request data
401
Object
Unauthorized
Was this section helpful?

What made this section unhelpful for you?

GET

/api/ubos/requirements?country=MX&CountryOfOrigin=DZ

Select
1 curl --location 'https://www.riotransfer.co/api/ubos/requirements?country=MX&CountryOfOrigin=DZ'

Response

{
  "textRequirements": [
    ""
  ],
  "fileRequirements": [
    ""
  ]
}

Kyc

APIs for managing KYC verifications

Orders

APIs for managing orders

Bank Payments

APIs for managing bank payments

Bank Payouts

APIs for managing bank payouts

Quotes

APIs for managing quotes

Bank Accounts

APIs for managing bank accounts

Us Bank Accounts

APIs for managing US bank accounts

Invoices

APIs for managing invoices

Webhooks

APIs for managing webhooks