South Africa (ZAF)

This chapter defines the supported Geocode datasets, operations, and input and output field information for South Africa.

Supported Geocode Datasets

The following table lists the supported Geocode dataset(s) with the available geocoding levels for South Africa.

Geocode Dataset Maximum Precision Postcodes Language Geocode Level
TomTom Street Interpolated Yes English Premium & Advanced
NAVTEQ Address Points No English Premium

Supported Operations

The following operations are supported for South Africa:

  • Geocoding—Takes one or more addresses as input and returns latitude/longitude coordinates and other information.
  • Reverse Geocoding—Takes one or more latitude and longitude coordinates as input and returns the address of the location.

Input Fields

The input address may contain some or all of the following address elements.

Field Name Parameter Type Description
placeName String Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional.
mainAddress String Single Line Input—If no other address field is populated, then the mainAddress entry will be treated as a single line input. Single line input can consist of multiple input address fields; these should be entered in the typical address order for the country. For more details, refer to the section "Single Line Input" below.

Street Address—If the post address components (city, postalCode, etc.) are provided separately or in the lastLine field, then the contents of mainAddress will be treated as the street address part and can include company name, house number, building names and street names. Optional.

Street Intersection Input—To enter an intersection, specify the two street names separated by a double ampersand (&&).
lastLine String The last line of the address. Optional. For example:

211 Waterval Road
2034 Randburg
areaName1 String Specifies the state. Optional.
areaName2 String Specifies the district. Optional.
areaName3 String Specifies the city or town. Optional.
areaName4 String Specifies the locality. Optional.
postalCode String Specifies the 4-digit postal code. Optional.
country String ISO 3166-1 Alpha-3 country code or country name. For South Africa, the country code is ZAF. Required for forward geocoding.

Address Guidelines for South Africa

Follow these suggestions to ensure that your input address data is in the best format possible for optimum matching and geocoding. For additional information on South African addresses, see the South African Postal Service website: http://www.postoffice.co.za/.

  • Required fields—Addresses must contain a city. ZAF does not consider postal codes in addresses.
  • Thoroughfare types—Thoroughfare types and their common abbreviations are recognized and fully supported on input and output.
  • Common words and abbreviations—The geocoder recognizes common words, directionals, house number indicators, and abbreviations used in addresses and can geocode these addresses successfully.

Single Line Input

Instead of entering each address component in separate fields, you can enter the entire address in the mainAddress input field with the address elements ordered as follows:

[address_number][street_info][postal_code][area]

Where:
  • [address_number] is optional.
  • [street_info] consists of the street name, street type and any pre- or post-directional information (e.g. East, West, etc.). Optional.
  • [postal_code] is the postal code.
  • [area] is the city only, or city plus supporting information, such as state, province, locality.
  • Either the [area] or [postal_code] is required.

For best results, put a comma between the street information and the last address line information.

Custom Options

There are no options specific to South Africa.

Parsed Address Output Fields

The following table lists the parsed address fields returned for a candidate located in South Africa.

To return the Parsed Address fields, send the returnAllCandidateInfo preference true in POST request.

Note: The placeName, addressNumber, unitType and unitValue field values are only returned when the Geocode dataset that supports street address interpolation is installed.
Field Name Description
mainAddressLine The street address which may include company name, house number, building names and street names.
addressLastLine The last line of the address.
placeName The building name, place name, Point of Interest (POI), company or firm name associated with the address.
areaName1 The state.
areaName2 The district.
areaName3 The city or town.
areaName4 The locality.
postCode1 The 4-digit postal code.
postCode2 Not used.
country The three-letter ISO 3166-1 Alpha-3 country code. For South Africa, the country code is ZAF.
addressNumber The address number.
streetName The street or road name.
unitType The unit type such as APT, STE, etc.
unitValue The unit value/number, such as "3B".
customFields South Africa does not have any custom output fields.