{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-constituent-address-schema.json",
  "title": "ConstituentAddress",
  "description": "GetConstituentAddress",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-constituent-api-openapi.yml#/components/schemas/ConstituentAddress",
  "required": [
    "country"
  ],
  "type": "object",
  "properties": {
    "address_type": {
      "type": "string",
      "description": "The type. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries"
    },
    "address_block": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string",
      "description": "The address."
    },
    "city": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The city."
    },
    "state": {
      "type": "string",
      "description": "The state. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{countryid}."
    },
    "postcode": {
      "maxLength": 12,
      "minLength": 0,
      "type": "string",
      "description": "The zip."
    },
    "country": {
      "type": "string",
      "description": "The country. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba."
    },
    "cart": {
      "maxLength": 10,
      "minLength": 0,
      "type": "string",
      "description": "The cart."
    },
    "dpc": {
      "maxLength": 8,
      "minLength": 0,
      "type": "string",
      "description": "The dpc."
    },
    "lot": {
      "maxLength": 5,
      "minLength": 0,
      "type": "string",
      "description": "The lot."
    },
    "start_date": {
      "$ref": "#/$defs/MonthDay"
    },
    "end_date": {
      "$ref": "#/$defs/MonthDay"
    },
    "primary": {
      "type": "boolean",
      "description": "Indicates whether set as primary address."
    },
    "do_not_mail": {
      "type": "boolean",
      "description": "Indicates whether do not send mail to this address."
    },
    "omit_from_validation": {
      "type": "boolean",
      "description": "Indicates whether omit this address from validation."
    },
    "county": {
      "type": "string",
      "description": "The county. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries"
    },
    "congressional_district": {
      "type": "string",
      "description": "The congressional district. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries"
    },
    "state_house_district": {
      "type": "string",
      "description": "The state house district. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/statehousedistrictcode/entries"
    },
    "state_senate_district": {
      "type": "string",
      "description": "The state senate district. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/statesenatedistrictcode/entries"
    },
    "local_precinct": {
      "type": "string",
      "description": "The local precinct. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/localprecinctcode/entries"
    },
    "info_source": {
      "type": "string",
      "description": "The information source. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries"
    },
    "region": {
      "type": "string",
      "description": "The region. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/regioncode/entries"
    },
    "last_validation_attempt_date": {
      "type": "string",
      "description": "The last attempt. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "validation_message": {
      "maxLength": 200,
      "minLength": 0,
      "type": "string",
      "description": "The validation message."
    },
    "certification_data": {
      "type": "integer",
      "description": "The certification data.",
      "format": "int32"
    },
    "ncoa_last_submit_date": {
      "type": "string",
      "description": "The last submit date. Read-only in the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "ncoa_return": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string",
      "description": "The return code. Read-only in the SOAP API."
    },
    "ncoa_footnote": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string",
      "description": "The footnote. Read-only in the SOAP API."
    },
    "ncoa_dpv_footnote": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string",
      "description": "The dpv footnote. Read-only in the SOAP API."
    },
    "ncoa_move_date": {
      "$ref": "#/$defs/FuzzyDate"
    },
    "ncoa_dma_suppression": {
      "type": "boolean",
      "description": "Indicates whether dma suppression. Read-only in the SOAP API."
    },
    "ncoa_mail_grade": {
      "maxLength": 150,
      "minLength": 0,
      "type": "string",
      "description": "The mail grade. Read-only in the SOAP API."
    },
    "zip_lookup_countries": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ConstituentAddressZipLookupCountries"
      },
      "description": "Zip lookup countries."
    },
    "validation_countries": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ConstituentAddressValidationCountries"
      },
      "description": "Validation countries."
    },
    "update_contacts": {
      "type": "boolean",
      "description": "Indicates whether update contacts that use this address."
    },
    "has_contacts": {
      "type": "boolean",
      "description": "Indicates whether has contacts. Read-only in the SOAP API."
    },
    "do_not_mail_reason": {
      "type": "string",
      "description": "The reason. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries"
    },
    "household": {
      "type": "boolean",
      "description": "Indicates whether household. Read-only in the SOAP API."
    },
    "household_member": {
      "type": "boolean",
      "description": "Indicates whether household member. Read-only in the SOAP API."
    },
    "update_matching_household_addresses": {
      "type": "boolean",
      "description": "Indicates whether update matching addresses in household."
    },
    "matching_household_members": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ConstituentAddressMatchingHouseholdMembers"
      },
      "description": "Matching household members."
    },
    "historical_start_date": {
      "type": "string",
      "description": "The start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "historical_end_date": {
      "type": "string",
      "description": "The end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "date_added": {
      "type": "string",
      "description": "The date added. Read-only in the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "info_source_comments": {
      "maxLength": 256,
      "minLength": 0,
      "type": "string",
      "description": "The comments."
    },
    "confidential": {
      "type": "boolean",
      "description": "Indicates whether this address is confidential."
    },
    "constituent_data_review_rollback_reason": {
      "type": "string",
      "description": "The reason. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/484441bc-f0e6-4f5f-a6bf-49f02881dd13."
    },
    "forced_primary": {
      "type": "boolean",
      "description": "Indicates whether forced primary. Read-only in the SOAP API."
    },
    "can_edit_primary": {
      "type": "boolean",
      "description": "Indicates whether can edit primary. Read-only in the SOAP API."
    },
    "invalid_fields": {
      "maxLength": 256,
      "minLength": 0,
      "type": "string",
      "description": "The invalid fields. Read-only in the SOAP API."
    },
    "origin": {
      "type": "string",
      "description": "The origin. Read-only in the SOAP API. Available values are <i>user</i>, <i>web forms</i>"
    }
  },
  "additionalProperties": false,
  "x-display-name": "Address Edit Form 4",
  "x-display-id": "Address Edit Form 4",
  "$defs": {
    "ConstituentAddressMatchingHouseholdMembers": {
      "type": "object",
      "properties": {
        "constituent_id": {
          "type": "string",
          "description": "constituent id"
        },
        "name": {
          "type": "string",
          "description": "household member"
        },
        "relationship_to_primary": {
          "type": "string",
          "description": "relationship to primary"
        }
      },
      "description": "ConstituentAddressMatchingHouseholdMembers",
      "x-display-name": "matching_household_members",
      "x-display-id": "matching_household_members"
    },
    "ConstituentAddressValidationCountries": {
      "type": "object",
      "properties": {
        "country_id": {
          "type": "string",
          "description": "countryid"
        },
        "browsable": {
          "type": "boolean",
          "description": "browsable"
        }
      },
      "description": "ConstituentAddressValidationCountries",
      "x-display-name": "validation_countries",
      "x-display-id": "validation_countries"
    },
    "ConstituentAddressZipLookupCountries": {
      "type": "object",
      "properties": {
        "country_id": {
          "type": "string",
          "description": "countryid"
        },
        "country_name": {
          "type": "string",
          "description": "name"
        }
      },
      "description": "ConstituentAddressZipLookupCountries",
      "x-display-name": "zip_lookup_countries",
      "x-display-id": "zip_lookup_countries"
    },
    "FuzzyDate": {
      "type": "object",
      "properties": {
        "year": {
          "type": "integer",
          "description": "The year.",
          "format": "int32"
        },
        "month": {
          "type": "integer",
          "description": "The month.",
          "format": "int32"
        },
        "day": {
          "type": "integer",
          "description": "The day.",
          "format": "int32"
        }
      },
      "description": "FuzzyDate",
      "x-display-name": "Month Day",
      "x-display-id": "Month Day"
    },
    "MonthDay": {
      "type": "object",
      "properties": {
        "month": {
          "type": "integer",
          "description": "The month.",
          "format": "int32"
        },
        "day": {
          "type": "integer",
          "description": "The day.",
          "format": "int32"
        }
      },
      "description": "MonthDay",
      "x-display-name": "Month Day",
      "x-display-id": "Month Day"
    }
  }
}