Address

Address

  • addressType
    Type: string enum
    required

    Type of Address for the entity it is included in

    values
    • Postal
    • Street
    • Residential
    • PrincipalPlaceOfBusiness
    • RegisteredAddress
  • countryCode
    Type: string enum
    required

    3-digit Country Code as specified in ISO-3166, in uppercase

    values
    • ABW
    • AFG
    • AGO
    • AIA
    • ALA
  • suburb
    Type: string
    required

    Name of the Suburb

  • careOf
    Type: string | null

    The recipient or care-of information associated with the address

  • poBox
    Type: string | null

    PO Box Number. Only valid for Postal AddressType, and if this is provided, StreetNumber, Name & Type are not required. PO Box should only be included in this field as numeric, and not in any other address fields.

  • postcode
    Type: string | null

    Postcode as per country standards

  • propertyName
    Type: string | null

    Name of the Property or other identifiers normally included in first line of address

  • state
    Type: string | null

    State Code as per country standards

  • streetName
    Type: string | null

    Name of the Street without Type

  • streetNumber
    Type: string | null

    Street number or range of numbers

  • streetType
    Type: string | null

    Street type

  • unit
    Type: string | null

    Unit or Suite number