Moov · Schema

Address

Physical or mailing address.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
addressLine1 string Primary street address.
addressLine2 string Secondary address line (suite, apartment, etc.).
city string City name.
stateOrProvince string Two-letter state or province code.
postalCode string Postal or ZIP code.
country string Two-letter ISO 3166-1 alpha-2 country code.
View JSON Schema on GitHub

JSON Schema

moov-address-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Address",
  "title": "Address",
  "type": "object",
  "description": "Physical or mailing address.",
  "properties": {
    "addressLine1": {
      "type": "string",
      "description": "Primary street address."
    },
    "addressLine2": {
      "type": "string",
      "description": "Secondary address line (suite, apartment, etc.)."
    },
    "city": {
      "type": "string",
      "description": "City name."
    },
    "stateOrProvince": {
      "type": "string",
      "description": "Two-letter state or province code.",
      "maxLength": 2
    },
    "postalCode": {
      "type": "string",
      "description": "Postal or ZIP code."
    },
    "country": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha-2 country code.",
      "maxLength": 2
    }
  }
}