---
title: "Update user by ID"
method: PATCH
path: "/users/{userId}"
tags: ["Users"]
---

# Update user by ID

`PATCH /users/{userId}`

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

## Request body

- union
  - object
    - `umaAddress` string — Full UMA address
    - `fullName` string — Individual's full name
    - `birthDate` string, date — Date of birth in ISO 8601 format (YYYY-MM-DD)
    - `nationality` string — Country code (ISO 3166-1 alpha-2)
    - `address` Address — Physical address information
      - `line1` string, required — Street address line 1
      - `line2` string — Street address line 2
      - `town` string — Town/Neighborhood
      - `city` string — City
      - `state` string — State/County/Province/Region
      - `postalCode` string, required — Postal/ZIP code
      - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - `bankAccountInfo` union
      - UserClabeAccountInfo
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserUsAccountInfo
        - `accountNumber` string, required — US bank account number
        - `routingNumber` string, required — ACH routing number (9 digits)
        - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
        - `bankName` string — Name of the bank
        - `accountHolderName` string, required — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserPixAccountInfo
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `bankName` string — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserIbanAccountInfo
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string — SWIFT/BIC code (8 or 11 characters)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserFboAccountInfo
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `currencyCode` string, required — Three-letter currency code (ISO 4217)
      - UserUpiAccountInfo
        - `vpa` string, required — Virtual Payment Address for UPI payments
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
  - object
    - `umaAddress` string — Full UMA address
    - `businessInfo` object
      - `legalName` string — Legal name of the business
      - `registrationNumber` string — Business registration number
      - `taxId` string — Tax identification number
    - `address` Address — Physical address information
      - `line1` string, required — Street address line 1
      - `line2` string — Street address line 2
      - `town` string — Town/Neighborhood
      - `city` string — City
      - `state` string — State/County/Province/Region
      - `postalCode` string, required — Postal/ZIP code
      - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - `bankAccountInfo` union
      - UserClabeAccountInfo
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserUsAccountInfo
        - `accountNumber` string, required — US bank account number
        - `routingNumber` string, required — ACH routing number (9 digits)
        - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
        - `bankName` string — Name of the bank
        - `accountHolderName` string, required — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserPixAccountInfo
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `bankName` string — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserIbanAccountInfo
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string — SWIFT/BIC code (8 or 11 characters)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserFboAccountInfo
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `currencyCode` string, required — Three-letter currency code (ISO 4217)
      - UserUpiAccountInfo
        - `vpa` string, required — Virtual Payment Address for UPI payments
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information

## Response `200`

User updated successfully

- union
  - IndividualUser
    - `id` string — System-generated unique identifier
    - `umaAddress` string, required — full UMA address
    - `platformUserId` string, required — Platform-specific user identifier
    - `userType` 'INDIVIDUAL' | 'BUSINESS', required — Whether the user is an individual or a business entity
    - `createdAt` string, date-time — Creation timestamp
    - `updatedAt` string, date-time — Last update timestamp
    - `isDeleted` boolean — Whether the user is marked as deleted
    - `fullName` string — Individual's full name
    - `birthDate` string, date — Date of birth in ISO 8601 format (YYYY-MM-DD)
    - `nationality` string — Country code (ISO 3166-1 alpha-2)
    - `address` Address — Physical address information
      - `line1` string, required — Street address line 1
      - `line2` string — Street address line 2
      - `town` string — Town/Neighborhood
      - `city` string — City
      - `state` string — State/County/Province/Region
      - `postalCode` string, required — Postal/ZIP code
      - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - `bankAccountInfo` union, required
      - UserClabeAccountInfo
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserUsAccountInfo
        - `accountNumber` string, required — US bank account number
        - `routingNumber` string, required — ACH routing number (9 digits)
        - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
        - `bankName` string — Name of the bank
        - `accountHolderName` string, required — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserPixAccountInfo
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `bankName` string — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserIbanAccountInfo
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string — SWIFT/BIC code (8 or 11 characters)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserFboAccountInfo
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `currencyCode` string, required — Three-letter currency code (ISO 4217)
      - UserUpiAccountInfo
        - `vpa` string, required — Virtual Payment Address for UPI payments
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
  - BusinessUser
    - `id` string — System-generated unique identifier
    - `umaAddress` string, required — full UMA address
    - `platformUserId` string, required — Platform-specific user identifier
    - `userType` 'INDIVIDUAL' | 'BUSINESS', required — Whether the user is an individual or a business entity
    - `createdAt` string, date-time — Creation timestamp
    - `updatedAt` string, date-time — Last update timestamp
    - `isDeleted` boolean — Whether the user is marked as deleted
    - `address` Address — Physical address information
      - `line1` string, required — Street address line 1
      - `line2` string — Street address line 2
      - `town` string — Town/Neighborhood
      - `city` string — City
      - `state` string — State/County/Province/Region
      - `postalCode` string, required — Postal/ZIP code
      - `country` string, required — Country code (ISO 3166-1 alpha-2)
    - `bankAccountInfo` union, required
      - UserClabeAccountInfo
        - `clabeNumber` string, required — 18-digit CLABE number (Mexican banking standard)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserUsAccountInfo
        - `accountNumber` string, required — US bank account number
        - `routingNumber` string, required — ACH routing number (9 digits)
        - `accountCategory` 'CHECKING' | 'SAVINGS', required — Type of account (checking or savings)
        - `bankName` string — Name of the bank
        - `accountHolderName` string, required — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserPixAccountInfo
        - `pixKey` string, required — PIX key for Brazilian instant payments
        - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required — Type of PIX key being used
        - `bankName` string — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserIbanAccountInfo
        - `iban` string, required — International Bank Account Number
        - `swiftBic` string — SWIFT/BIC code (8 or 11 characters)
        - `bankName` string, required — Name of the bank
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
      - UserFboAccountInfo
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
        - `currencyCode` string, required — Three-letter currency code (ISO 4217)
      - UserUpiAccountInfo
        - `vpa` string, required — Virtual Payment Address for UPI payments
        - `accountHolderName` string — Name of the account holder
        - `platformAccountId` string — Platform-specific identifier for this bank account. This optional field allows platforms to link bank accounts to their internal account systems. The value can be any string that helps identify the account in your system (e.g. database IDs, custom references, etc.). This field is particularly useful when: - Tracking multiple bank accounts for the same user - Linking accounts to internal accounting systems - Maintaining consistency between UMAaaS and your platform's account records
        - `accountType` 'CLABE' | 'US_ACCOUNT' | 'PIX' | 'IBAN' | 'FBO' | 'UPI', required — Type of bank account information
    - `businessInfo` object — Additional information required for business entities
      - `legalName` string, required — Legal name of the business
      - `registrationNumber` string — Business registration number
      - `taxId` string — Tax identification number

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — User not found
- `500` — Internal service error

---

[API](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/uma-as-a-service-umaaas-api/revisions/2e2b5ba6d69b/schema)