Method:
DataTools.Verify.Address.NzPaf.VerifyAddress
Use to search an address against the New Zealand PAF using New Zealand Post's Batch rules. This method will return a single correct address match otherwise an error explaining why a match could not be found. This method requires no user interaction.

Test:
ParameterValue
AddressLine1
AddressLine2
AddressLine3
AddressLine4
Suburb
TownCityMailtown
Postcode
RequestId
RequestKey
DepartmentCode
Input Parameters:
ParameterDescription
AddressLine1Address line 1
AddressLine2Address line 2
AddressLine3Address line 3
AddressLine4Address line 4
SuburbSuburb
TownCityMailtownTown, City or Mailtown
PostcodePostcode
RequestIdOptional user value to assist in linking DtRequests with DtResponses.
RequestKeyRequired for user access verification. For client side script protect your Request Key by using the DataTools.Security.GenerateTemporaryRequestKey
DepartmentCodeOptional user value to allocate transaction usage by department. Limit of 50 unique Department codes per account.

Output Fields:
FieldDescription
DPIDNew Zealand Post Delivery Point Identifier
BuildingNameBuilding Name eg Sydney Square
AddressLine1Address Line 1
AddressLine2Address Line 2
AddressLine3Address Line 3
SuburbSuburb
TownCityMailtownTown, City or Mailtown
PostcodePostcode
MatchTypeReturns a number that is the match type code for why an address didn't match [Option Values]
MatchTypeDescriptionA meaningful description for why an address didn't match
FieldChangesCodes representing the address components that were updated [Option Values]
ActiveStatusActive Status
FormatFlagAddress Format Flag (output only)
AlternateLocalityAlternate Locality (output only)
LevelNumberBuilding Level Number
LevelTypeBuilding Level Type
UnitNumberFlat / Unit Number
UnitTypeFlat / Unit Type
PostBoxLobbyPost Box Lobby
PostBoxNumberPostal Delivery Number
PostBoxTypePostal Delivery Type
RuralDeliveryTypeRural Delivery Type
RuralDeliveryNumberRural Delivery Number
RuralDeliverySupplementSupplementary info for Rural Delivery
StreetNameStreet Name
StreetTypeStreet Type
StreetNumber1Street Number 1
StreetNumber1AlphaAlpha suffix to Street Number 1
StreetTypeSuffixStreet Type Suffix or direction
StreetName2Second Street Name
StreetType2Second Street Type
StreetNumber2Street Number 2
StreetNumber2AlphaAlpha suffix to Street Number 2
StreetTypeSuffix2Second Street Type Suffix or direction

Supported Web Service API Interfaces:
Web Service Method: ProcessQueryStringRequest (REST)
Request Format: Url QueryString, Protocols: HTTP GET, HTTPS GET, Response Formats: JSON, XML*
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc
Sample QueryString Request:
/ProcessQueryStringRequest?Method=DataTools.Verify.Address.NzPaf.VerifyAddress&AddressLine1=&AddressLine2=&AddressLine3=&AddressLine4=&Suburb=&TownCityMailtown=&Postcode=&RequestId=&RequestKey=&DepartmentCode=
Sample JSON Response:
{ "DtResponse":{ "RequestId":"", "ResultCount":"1", "ErrorMessage":"", "Result":[ { "DPID":"", "BuildingName":"", "AddressLine1":"", "AddressLine2":"", "AddressLine3":"", "Suburb":"", "TownCityMailtown":"", "Postcode":"", "MatchType":"", "MatchTypeDescription":"", "FieldChanges":"", "ActiveStatus":"", "FormatFlag":"", "AlternateLocality":"", "LevelNumber":"", "LevelType":"", "UnitNumber":"", "UnitType":"", "PostBoxLobby":"", "PostBoxNumber":"", "PostBoxType":"", "RuralDeliveryType":"", "RuralDeliveryNumber":"", "RuralDeliverySupplement":"", "StreetName":"", "StreetType":"", "StreetNumber1":"", "StreetNumber1Alpha":"", "StreetTypeSuffix":"", "StreetName2":"", "StreetType2":"", "StreetNumber2":"", "StreetNumber2Alpha":"", "StreetTypeSuffix2":"" } ] } }
Sample Code:

Web Service Method: ProcessXmlRequest (SOAP)
Request Format: XML over SOAP, Protocols: HTTP POST, HTTPS POST, Response Formats: XML, JSON*
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebServiceSoap/DtKleberService.svc
SOAP WSDL: https://customname.datatoolscloud.net.au/KleberWebServiceSoap/DtKleberService.svc?wsdl
Sample XML Request:
<DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage=""> <Result DPID="" BuildingName="" AddressLine1="" AddressLine2="" AddressLine3="" Suburb="" TownCityMailtown="" Postcode="" MatchType="" MatchTypeDescription="" FieldChanges="" ActiveStatus="" FormatFlag="" AlternateLocality="" LevelNumber="" LevelType="" UnitNumber="" UnitType="" PostBoxLobby="" PostBoxNumber="" PostBoxType="" RuralDeliveryType="" RuralDeliveryNumber="" RuralDeliverySupplement="" StreetName="" StreetType="" StreetNumber1="" StreetNumber1Alpha="" StreetTypeSuffix="" StreetName2="" StreetType2="" StreetNumber2="" StreetNumber2Alpha="" StreetTypeSuffix2="" /> </DtResponse>
SOAP Envelope: The XML request is passed through a single parameter in the SOAP envelope <DtXmlRequest>. Where the development language requires the SOAP envelope contents to be defined manually, the additional step of encoding the Dt XML Request is required. The encoding required needs to transform "<" of the DtRequest to "&lt;" and ">" to "&gt;". See example below. 
Sample SOAP Envelope:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:ProcessXmlRequest> <!--Optional:--> <tem:DtXmlRequest> &lt;DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" /&gt; </tem:DtXmlRequest> </tem:ProcessXmlRequest> </soapenv:Body> </soapenv:Envelope>
Batching Requests: Use the <DtRequests> (plural) tag to send through multiple requests in a single transaction.
<DtRequests>
<DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
<DtRequest Method="DataTools.Verify.Address.NzPaf.VerifyAddress" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" Suburb="" TownCityMailtown="" Postcode="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>
Sample Code:

* Add the additional input parameter "OutputFormat=json" or "OutputFormat=xml" to change the response format from default.
* Add the additional input parameter "callback" to convert JSON responses to JSONP responses for across domains support.
  CORS header included where callback is not defined.

Please Note:
Ensure you thoroughly test all the methods you are using and are happy with the results before going into production. DataTools is charged by the data suppliers for use of every method – therefore ALL calls to any method will incur a COST. When you register DataTools provides you with free credit to help with development and trialling of the service. Once that credit is used you will need to purchase a monthly subscription and/or top up to continue using the service, even for development purposes. Please check the Method Pricing List for all current costs. DataTools does not warrant or guarantee the quality of the results returned and will not be held responsible for any costs incurred by using a method. Should you have any questions please contact your Sales representative or the Client Services team.