v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB
Users

Update user by ID

Update a user's metadata by their system-generated ID

patch/users/{userId}

Request body

OR

Example request

{
  "address": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "town": "Hollywood",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "bankAccountInfo": {
    "clabeNumber": "123456789012345678",
    "bankName": "BBVA Mexico",
    "accountHolderName": "John Doe",
    "platformAccountId": "acc_123456789"
  }
}

Response

User updated successfully

OR

Example response

{
  "id": "User:019542f5-b3e7-1d02-0000-000000000001",
  "umaAddress": "$john.doe@uma.domain.com",
  "platformUserId": "9f84e0c2a72c4fa",
  "userType": "INDIVIDUAL",
  "createdAt": "2023-07-21T17:32:28Z",
  "updatedAt": "2023-07-21T17:32:28Z",
  "fullName": "John Michael Doe",
  "birthDate": "1990-01-15",
  "nationality": "US",
  "address": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "town": "Hollywood",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "bankAccountInfo": {
    "clabeNumber": "123456789012345678",
    "bankName": "BBVA Mexico",
    "accountHolderName": "John Doe",
    "platformAccountId": "acc_123456789"
  }
}