Skip to content

address

Address for the party or organization

  • Is optional
  • Type: object

With the following properties:

PropertyTypeRequiredDescription
AdrTpStringOptionalList based on ISO20022 AddressType1Code List. The value of this property must be equal to one of the known values.
AdrLineArrayOptionalInformation that locates and identifies the address for the party. Maximum length: 70 characters.
DeptStringOptionalInformation that locates and identifies the department for the party. Maximum length: 70 characters.
SubDeptStringOptionalInformation that locates and identifies the sub department for the party. Maximum length: 70 characters.
StrtNmStringOptionalInformation that locates and identifies the street name for the party, as defined by postal services. Maximum length: 70 characters.
BldgNbStringOptionalInformation that locates and identifies the building number for the party, as defined by postal services. Maximum length: 16 characters
PstCdStringOptionalInformation that locates and identifies postal code for the party, as defined by postal services. Maximum length: 16 characters
TwnNmStringOptionalInformation that locates and identifies the city / town for the party, as defined by postal services. Maximum length: 35 characters
CtrySubDvsnStringOptionalInformation that locates and identifies the state / county for the party, as defined by postal services. Maximum length: 35 characters
CtryReferenceOptionalInformation that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list. Defined in #/definitions/country.

AdrTp known values

ValueDescription
ADDRPostal
BIZZBusiness
DLVYDelivery To
HOMEResidential
MLTOMail To
PBOXPO Box

JSON schema extract

"address": {
    "type": "object",
    "properties": {
        "AdrTp": {
            "type": "string",
            "description": "List based on ISO20022 AddressType1Code List",
            "enum": [
                "ADDR",
                "BIZZ",
                "DLVY",
                "HOME",
                "MLTO",
                "PBOX"
            ]
        },
        "AdrLine": {
            "description": "Information that locates and identifies the address for the party.",
            "type": "array",
            "maxLength": 70
        },
        "Dept": {
            "description": "Information that locates and identifies the department for the party.",
            "type": "string",
            "maxLength": 70
        },
        "SubDept": {
            "description": "Information that locates and identifies the sub department for the party.",
            "type": "string",
            "maxLength": 70
        },
        "StrtNm": {
            "description": "Information that locates and identifies the street name for the party, as defined by postal services.",
            "type": "string",
            "maxLength": 70
        },
        "BldgNb": {
            "description": "Information that locates and identifies the building number for the party, as defined by postal services.",
            "type": "string",
            "maxLength": 16
        },
        "PstCd": {
            "description": "Information that locates and identifies postal code for the party, as defined by postal services.",
            "type": "string",
            "maxLength": 16
        },
        "TwnNm": {
            "description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
            "type": "string",
            "maxLength": 35
        },
        "CtrySubDvsn": {
            "description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
            "type": "string",
            "maxLength": 35
        },
        "Ctry": {
            "description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
            "$ref": "#/definitions/country"
        }
    }
}