Upvest · Schema

UserUpdate

Request body for updating user information.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
first_name string The user's first name.
last_name string The user's last name.
email string The user's email address.
address object A postal address.
View JSON Schema on GitHub

JSON Schema

investment-api-user-update-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-user-update-schema.json",
  "title": "UserUpdate",
  "description": "Request body for updating user information.",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "The user's first name.",
      "example": "Example Name"
    },
    "last_name": {
      "type": "string",
      "description": "The user's last name.",
      "example": "Example Name"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The user's email address.",
      "example": "[email protected]"
    },
    "address": {
      "type": "object",
      "description": "A postal address.",
      "required": [
        "street",
        "city",
        "postal_code",
        "country"
      ],
      "properties": {
        "street": {
          "type": "string",
          "description": "The street name and number.",
          "example": "Example Street 1"
        },
        "additional_line": {
          "type": "string",
          "description": "Additional address line.",
          "example": "example-value"
        },
        "city": {
          "type": "string",
          "description": "The city name.",
          "example": "Berlin"
        },
        "postal_code": {
          "type": "string",
          "description": "The postal or ZIP code.",
          "example": "10115"
        },
        "state": {
          "type": "string",
          "description": "The state or province.",
          "example": "BE"
        },
        "country": {
          "type": "string",
          "description": "The country as an ISO 3166-1 alpha-2 code.",
          "pattern": "^[A-Z]{2}$",
          "example": "DE"
        }
      }
    }
  }
}