Skip to main content
GET
/
api
/
users
Get all 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>"
    },
    "businessData": {
      "businessName": "<string>"
    },
    "createdAt": "2024-05-29T15:36:03.225Z",
    "type": "business",
    "email": "[email protected]",
    "brokerId": "66562bc04fe8bf83c577c178",
    "onboarding": {
      "status": "approved",
      "country": "MX",
      "hasAcceptedTerms": true
    },
    "id": "66574b634fe8bf83c57813ac",
    "platformFeeRanges": {
      "MX": {
        "buy": [
          {
            "min": 123,
            "max": 123,
            "fee": 123,
            "nextDaySettlementFee": 123,
            "_id": "<string>"
          }
        ],
        "sell": [
          {
            "min": 123,
            "max": 123,
            "fee": 123,
            "nextDaySettlementFee": 123,
            "_id": "<string>"
          }
        ]
      },
      "US": {
        "buy": [
          {}
        ],
        "sell": [
          {}
        ]
      },
      "PE": {
        "buy": [
          {}
        ],
        "sell": [
          {}
        ]
      },
      "CO": {
        "buy": [
          {}
        ],
        "sell": [
          {}
        ]
      },
      "BR": {
        "buy": [
          {}
        ],
        "sell": [
          {}
        ]
      }
    },
    "accumulatedVolumeInUSD": {
      "MX": {
        "buy": 123,
        "sell": 123
      },
      "PE": {
        "buy": 123,
        "sell": 123
      },
      "US": {
        "buy": 123,
        "sell": 123
      }
    },
    "attributes": [
      "<string>"
    ],
    "serviceFee": {
      "MX": {
        "buy": 123,
        "sell": 123
      },
      "PE": {
        "buy": 123,
        "sell": 123
      }
    }
  }
]

​
Additional information.

If no value is entered for any filter, the current user information is returned.
{
  "platformFeeRanges": {
    "MX": {
      "buy": [],
      "sell": []
    },
    "US": {
      "buy": [],
      "sell": []
    },
    "PE": {
      "buy": [],
      "sell": []
    },
    "CO": {
      "buy": [],
      "sell": []
    },
    "BR": {
      "buy": [],
      "sell": []
    }
  },
  "invoicing": {
    "MX": {
      "fiscalRegimenCode": 605
    }
  },
  "individualData": {
    "firstName": "Name",
    "middleName": "Middle",
    "lastName": "Last",
    "birthday": "1988-06-06T00:00:00.000Z"
  },
  "businessData": {
    "businessName": "Business Name",
  },
  "createdAt": "2024-05-28T19:08:48.590Z",
  "type": "individual",
  "phoneNumber": "+526589562354",
  "email": "[email protected]",
  "onboarding": {
    "MX": {
      "status": "approved",
      "onboardingId": "66562ae87f5e01543da3b784",
      "aiPriseId": "1c1bba7c-59e7-4e00-956e-0803ad6e259d",
      "address": {
        "street1": "Street",
        "street2": "Street",
        "city": "City",
        "state": "State",
        "country": "Country",
        "postalCode": "12345"
      },
      "hasAcceptedTerms": true
    }
  },
  "id": "66562bc04fe8bf83c577c178"
}

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

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:

"[email protected]"

​
brokerId
string

Broker ID of the user.

Example:

"66562bc04fe8bf83c577c178"

​
onboarding
object
​
id
string

ID of the user.

Example:

"66574b634fe8bf83c57813ac"

​
platformFeeRanges
object
​
accumulatedVolumeInUSD
object
​
attributes
string[]

User attributes

​
serviceFee
object