GET
/
api
/
users
curl --request GET \
  --url https://app.sandbox.rio.trade/api/users \
  --header 'x-api-key: <api-key>'
[
  {
    "individualData": {
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "birthday": "1988-06-06T00:00:00.000Z"
    },
    "businessData": {
      "businessName": "<string>"
    },
    "createdAt": "2024-05-29T15:36:03.225Z",
    "type": "business",
    "email": "testing@riotransfer.co",
    "brokerId": "66562bc04fe8bf83c577c178",
    "onboarding": {
      "MX": {
        "status": "approved",
        "onboardingId": "66574b5f7f5e01543da3c267"
      }
    },
    "id": "66574b634fe8bf83c57813ac"
  }
]

​
Additional information.

If no value is entered for any filter, the current user information is returned.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
type
enum<string>

Type of user by which you want to filter.

Available options:
business,
individual
​
brokerId
string

Id of the broker for which you want to get the list of users.

Example:

"655f4084b96e4fb76f5a0e6e"

​
search
string

Allows you to search for any text.

Example:

"Name"

​
authId
string

Id of the user for which you want to get the list of users.

Example:

"665f4084b96e4fb76f5a0e0c"

​
firstName
string

First name of the individual to be searched.

​
lastName
string

Last name of the individual to be searched.

​
businessName
string

Name of the business to be searched.

​
onboardingStatus
enum<string>

Individual or business onboarding status.

Available options:
approved,
individualPassed,
individualReview,
individualFailed,
legalRepresentativeApproved,
legalRepresentativeFailed,
bridgeToSAndKYCCompleted,
bridgeKYCCompleted,
bridgeKYCApproved,
bridgeToSCompleted,
started,
failed,
review,
none
​
page
integer

Used to specify the current page you want to get in the paging results.

​
limit
integer

Used to specify the maximum number of records to be returned on a single page.

Response

200
application/json
OK
​
individualData
object
​
businessData
object
​
createdAt
string

Creation date of the user.

Example:

"2024-05-29T15:36:03.225Z"

​
type
enum<string>

Type of the user.

Available options:
business,
individual
​
email
string

Email of the user.

Example:

"testing@riotransfer.co"

​
brokerId
string

Broker ID of the user.

Example:

"66562bc04fe8bf83c577c178"

​
onboarding
object
​
id
string

ID of the user.

Example:

"66574b634fe8bf83c57813ac"