Address Handling
All fields not named in the table/s below will be ignored by the rules engine and should not be sent to vixverify. Eg. For South Africa, 'town' can not be substituted for 'suburb' or 'city'.
Australia
Country | Field Name | Required | Restrictions/Notes |
|---|---|---|---|
Australia | propertyName | No* |
|
Australia | flatNumber | No | Less than 256 characters |
Australia | streetNumber | Yes | Less than 256 characters |
Australia | streetName | Yes | Less than 256 characters |
Australia | streetType | No | If present, the street type must be one of those listed at AU Street Types otherwise it will be discarded. Less than 256 characters |
Australia | suburb | Yes | Less than 256 characters |
Australia | postcode | Yes | Must be 4 digits |
Australia | state | Yes | Must be one of the following: ACT NSW NT QLD SA TAS VIC WA |
Australia | country | Yes | *Must be AU |
*While Property Name is not a required field, it should be passed in if a customer has the Electoral Roll data source configured. The source will be checked for a Property Name if it is available on the individual's address record.
GB
Country | Field Name | Required | Restrictions/Notes |
|---|---|---|---|
GB | flatNumber | No |
|
GB | streetNumber | Conditional | Either <streetNumber> or <propertyName> has to be supplied to achieve an address match |
GB | propertyName | Conditional | Either <streetNumber> or <propertyName> has to be supplied to achieve an address match |
GB | streetName | Yes |
|
GB | postcode | Yes | Valid format:
|
GB | country | Yes |
|
New Zealand
Country | Field Name | Required | Restrictions/Notes |
|---|---|---|---|
New Zealand | flatNumber | No |
|
New Zealand | streetNumber | Yes |
|
New Zealand | streetName | Yes |
|
New Zealand | streetType | No | If present, the street type must be one of those listed in NZ Street Types otherwise it will be discarded. |
New Zealand | suburb | No |
|
New Zealand | postcode | Yes | Must be 4 digits |
New Zealand | townCity | Yes |
|
New Zealand | country | Yes | Must be NZ |
Singapore
Country | Field Name | Required | Restrictions/Notes |
|---|---|---|---|
Singapore | streetNumber | Yes | Block/house number e.g. 123 |
Singapore | streetName | Yes | All street parts of an address e.g.Tampines St 33 |
Singapore | flatNumber | No | All unit parts of an address e.g. #13–37 Mandalay Towers |
Singapore | postcode | Yes | Must be 6 digits |
Singapore | country | Yes | Must be SG |
South Africa
Country | Field Name | Required | Restrictions/Notes |
|---|---|---|---|
South Africa | flatNumber | No | (equivalent to Complex Number and/or Complex Name) |
South Africa | streetNumber | Yes |
|
South Africa | streetName | Yes |
|
South Africa | streetType | No |
|
South Africa | suburb | Conditional | Either <city> or <suburb> has to be supplied to achieve an address match. |
South Africa | city | Conditional | Either <city> or <suburb> has to be supplied to achieve an address match. |
South Africa | postcode | Yes | Must be 4 digits |
South Africa | country | Yes | Must be ZA |