PATCH
/
api
/
users
/
{id}
curl --request PATCH \
  --url https://app.sandbox.rio.trade/api/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "individualData": {
    "birthday": "1988-01-01"
  },
  "invoicing": {
    "MX": {
      "shouldInvoice": true
    }
  },
  "onboarding": {
    "MX": {
      "legalRepresentative": {
        "firstName": "Name",
        "email": "test@riotransfer.co"
      },
      "address": {
        "street2": "Address 2"
      }
    }
  }
}'
{
  "invoicing": {
    "MX": {}
  },
  "individualData": {
    "firstName": "Name",
    "middleName": "Middle",
    "lastName": "Last",
    "birthday": "1988-06-06T00:00:00.000Z"
  },
  "createdAt": "2024-05-28T19:08:48.590Z",
  "type": "business",
  "phoneNumber": "+526589562354",
  "email": "testing@riotransfer.co",
  "attributes": [
    "disabled"
  ],
  "onboarding": {
    "MX": {
      "status": "approved",
      "onboardingId": "66562ae87f5e01543da3b784",
      "aiPriseId": "1c1bba7c-59e7-4e00-956e-0803ad6e259d",
      "address": {
        "street1": "Address 1",
        "street2": "Address 2",
        "city": "City",
        "state": "State",
        "country": "Country",
        "postalCode": "Postal Code"
      },
      "hasAcceptedTerms": true
    }
  },
  "id": "66562bc04fe8bf83c577c178"
}

​
Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json
​
individualData
object
​
invoicing
object
​
onboarding
object

Response

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

Creation date of the user.

​
type
enum<string>

Type of the user.

Available options:
business,
individual
​
phoneNumber
string

Phone number of the user.

​
email
string

Email of the user.

​
attributes
enum<string>[]
Available options:
disabled,
banned,
broker,
brokerCustomer,
summedVolumeFees,
noReissueQuoteAfterExpiration,
prepaidOrders,
hasTransfersEnabled,
noVolatilityError,
brokerFeesEnabled,
canUploadKYCReportFile,
shortQuote,
needsAddressApproval,
canPriceMatch,
doNotSendOrderConfirmationEmail,
doNotSendOnboardingEmails
​
onboarding
object
​
id
string

ID of the user.

Update current userGet Webhook by id