Address

Postal address

Financial DataOpen BankingOpen FinanceFinancial Data ExchangeConsumer PermissionedAccount DataTransactionsInvestmentsInsuranceTax DataPayrollRESTOAuth2FAPICFPB 1033

Properties

Name Type Description
line1 object Address line 1
line2 object Address line 2
line3 object Address line 3
city object City
region object State or province
postalCode string Postal code
country object Country code
View JSON Schema on GitHub

JSON Schema

fdx-address.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Address",
  "description": "Postal address\n",
  "type": "object",
  "properties": {
    "line1": {
      "$ref": "#/components/schemas/String64",
      "description": "Address line 1\n"
    },
    "line2": {
      "$ref": "#/components/schemas/String64",
      "description": "Address line 2\n"
    },
    "line3": {
      "$ref": "#/components/schemas/String64",
      "description": "Address line 3\n"
    },
    "city": {
      "$ref": "#/components/schemas/String64",
      "description": "City\n"
    },
    "region": {
      "$ref": "#/components/schemas/String64",
      "description": "State or province\n"
    },
    "postalCode": {
      "type": "string",
      "maxLength": 10,
      "description": "Postal code\n"
    },
    "country": {
      "$ref": "#/components/schemas/Iso3166CountryCode",
      "description": "Country code\n"
    }
  },
  "required": [
    "line1",
    "city",
    "country"
  ]
}