Upvest · Schema

Address

A postal address.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name	Type	Description
street	string	The street name and number.
additional_line	string	Additional address line.
city	string	The city name.
postal_code	string	The postal or ZIP code.
state	string	The state or province.
country	string	The country as an ISO 3166-1 alpha-2 code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-address-schema.json",
  "title": "Address",
  "description": "A postal address.",
  "type": "object",
  "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"
    }
  },
  "required": [
    "street",
    "city",
    "postal_code",
    "country"
  ]
}