Create a new user

curl --request POST \
  --url https://app.sandbox.rio.trade/api/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "country": "MX",
  "email": "[email protected]",
  "phoneNumber": "+526589562354",
  "userType": "individual",
  "address": {
    "street1": "123 Main St",
    "city": "Mexico City",
    "state": "CDMX",
    "postalCode": "12345",
    "country": "MX",
    "street2": "Apt 4B"
  },
  "businessName": "My Business Inc.",
  "firstName": "John",
  "middleName": "Michael",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "additionalInformation": {},
  "brokerId": "655f4084b96e4fb76f5a0e6e"
}
'

{
  "userId": "66562bc04fe8bf83c577c178"
}

POST

api

users

Create a new user

curl --request POST \
  --url https://app.sandbox.rio.trade/api/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "country": "MX",
  "email": "[email protected]",
  "phoneNumber": "+526589562354",
  "userType": "individual",
  "address": {
    "street1": "123 Main St",
    "city": "Mexico City",
    "state": "CDMX",
    "postalCode": "12345",
    "country": "MX",
    "street2": "Apt 4B"
  },
  "businessName": "My Business Inc.",
  "firstName": "John",
  "middleName": "Michael",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "additionalInformation": {},
  "brokerId": "655f4084b96e4fb76f5a0e6e"
}
'

{
  "userId": "66562bc04fe8bf83c577c178"
}

Authorizations

x-api-key

string

header

required

Body

application/json

country

enum<string>

required

Country

Available options:

MX,

PE

Example:

"MX"

string<email>

required

User's email address.

Example:

"[email protected]"

phoneNumber

string

required

User's phone number.

Example:

"+526589562354"

userType

enum<string>

required

Type of user.

Available options:

business,

individual

Example:

"individual"

address

object

required

Show child attributes

address.street1

string

required

Primary street address.

Example:

"123 Main St"

address.city

string

required

City name.

Example:

"Mexico City"

address.state

string

required

State or province.

Example:

"CDMX"

address.postalCode

string

required

Postal code.

Example:

"12345"

address.country

string

required

Country code (2 characters).

Required string length: 2

Example:

"MX"

address.street2

string

Secondary street address (optional).

Example:

"Apt 4B"

businessName

string

Business name (required for business users).

Example:

"My Business Inc."

firstName

string

First name (required for individual users only).

Example:

"John"

middleName

string

Middle name (for individual users only).

Example:

"Michael"

lastName

string

Last name (required for individual users).

Example:

"Doe"

secondLastName

string

Second last name (for individual users only).

Example:

"Smith"

additionalInformation

object

Additional information about the user (optional).

brokerId

string<mongoId>

ID of the broker (optional).

Example:

"655f4084b96e4fb76f5a0e6e"

Response

userId

string

ID of the created user.

Example:

"66562bc04fe8bf83c577c178"

Get user onboarding links Create a new user by link

⌘I

API Documentation

API List

Create a new user

Authorizations

Body

Response