DataTools Kleber Method Description

Method:
DataTools.Verify.Address.IntGdc.VerifyAddress
You can use this method to verify full addresses against a variety of International address sources.

Test:

Parameter	Value
CountryCode
AddressLine1
AddressLine2
AddressLine3
AddressLine4
AddressLine5
AddressLine6
AddressLine7
AddressLine8
AddressLine9
AddressLine10
Locality
StateProvince
Postcode
Options
RequestId
RequestKey
DepartmentCode

Input Parameters:

Parameter	Description
CountryCode	Country code in ISO 3166-1 alpha-2 format eg. AU, NZ, US, GB
AddressLine1	Address Line 1
AddressLine2	Address Line 2
AddressLine3	Address Line 3
AddressLine4	Address Line 4
AddressLine5	Address Line 5
AddressLine6	Address Line 6
AddressLine7	Address Line 7
AddressLine8	Address Line 8
AddressLine9	Address Line 9
AddressLine10	Address Line 10
Locality	Locality, city, town, suburb
StateProvince	State, province or administrative area
Postcode	Postal/Zip Code
Options	Address options. Multiple options can be applied by delimiting options with a semicolon eg LowerCase;DeliveryLines [Option Values]
RequestId	Optional user value to assist in linking DtRequests with DtResponses.
RequestKey	Required for user access verification. For client side script protect your Request Key by using the DataTools.Security.GenerateTemporaryRequestKey
DepartmentCode	Optional user value to allocate transaction usage by department. Limit of 50 unique Department codes per account.

Output Fields:

Field	Description
AddressReliabilityCode	Reliability Codes represent a scoring system designed to be easy to understand and implement/decision. [Option Values]
AddressReliabilityDescription	Reliability description to understand and implement/decision.
AddressAdaptationCode	Adaptability codes represent the measure of change regarding the reliability code. [Option Values]
AddressAdaptationDescription	Adaptability description of change regarding the reliability code.
AddressLine1	Formatted address line 1
AddressLine2	Formatted address line 2
AddressLine3	Formatted address line 3
AddressLine4	Formatted address line 4
AddressLine5	Formatted address line 5
AddressLine6	Formatted address line 6
AddressLine7	Formatted address line 7
AddressLine8	Formatted address line 8
AddressLine9	Formatted address line 9
AddressLine10	Formatted address line 10
BuildingName	Building name
StreetNumber	For a US address such as 216 Town Village Drive, 216 is the street number. Internationally it is typically a number or letter associated with thoroughfare.
StreetName	Street name with street type eg. Town Village Drive
PostBox	Postal box type eg. PO Box
Locality	Locality, city, town, suburb
County	A geographical region of a country used for administrative or other purposes in certain modern nations.
District	A type of administrative division that, in some countries, is managed by local government
StateProvince	State, province or administrative area
Postcode	Postal/Zip Code
CountryCode	Country code in ISO 3166-1 alpha-2 format eg. AU, NZ, US, GB
CountryName	Country name eg. Australia, United States

Supported Web Service API Interfaces:

Web Service Method: ProcessQueryStringRequest (REST with QueryString)

Request Format: Url QueryString, Body (x-www-form-urlencoded), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Sample QueryString Request:
/ProcessQueryStringRequest?Method=DataTools.Verify.Address.IntGdc.VerifyAddress&CountryCode=&AddressLine1=&AddressLine2=&AddressLine3=&AddressLine4=&AddressLine5=&AddressLine6=&AddressLine7=&AddressLine8=&AddressLine9=&AddressLine10=&Locality=&StateProvince=&Postcode=&Options=&RequestId=&RequestKey=&DepartmentCode=

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "AddressReliabilityCode":"",
            "AddressReliabilityDescription":"",
            "AddressAdaptationCode":"",
            "AddressAdaptationDescription":"",
            "AddressLine1":"",
            "AddressLine2":"",
            "AddressLine3":"",
            "AddressLine4":"",
            "AddressLine5":"",
            "AddressLine6":"",
            "AddressLine7":"",
            "AddressLine8":"",
            "AddressLine9":"",
            "AddressLine10":"",
            "BuildingName":"",
            "StreetNumber":"",
            "StreetName":"",
            "PostBox":"",
            "Locality":"",
            "County":"",
            "District":"",
            "StateProvince":"",
            "Postcode":"",
            "CountryCode":"",
            "CountryName":""
         }
      ]
   }
}

Sample Code:

Web Service Method: ProcessQueryJsonRequest (REST with JSON)

Request Format: Body (Raw JSON), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Single Request

Sample JSON Request:
{
   "DtRequest":{
      "Method":"DataTools.Verify.Address.IntGdc.VerifyAddress", 
      "CountryCode":"", 
      "AddressLine1":"", 
      "AddressLine2":"", 
      "AddressLine3":"", 
      "AddressLine4":"", 
      "AddressLine5":"", 
      "AddressLine6":"", 
      "AddressLine7":"", 
      "AddressLine8":"", 
      "AddressLine9":"", 
      "AddressLine10":"", 
      "Locality":"", 
      "StateProvince":"", 
      "Postcode":"", 
      "Options":"", 
      "RequestId":"", 
      "RequestKey":"", 
      "DepartmentCode":""
   }
}

Sample JSON Response:
{
   "DtResponse":{
      "RequestId":"",
      "ResultCount":"1",
      "ErrorMessage":"",
      "Result":[
         {
            "AddressReliabilityCode":"",
            "AddressReliabilityDescription":"",
            "AddressAdaptationCode":"",
            "AddressAdaptationDescription":"",
            "AddressLine1":"",
            "AddressLine2":"",
            "AddressLine3":"",
            "AddressLine4":"",
            "AddressLine5":"",
            "AddressLine6":"",
            "AddressLine7":"",
            "AddressLine8":"",
            "AddressLine9":"",
            "AddressLine10":"",
            "BuildingName":"",
            "StreetNumber":"",
            "StreetName":"",
            "PostBox":"",
            "Locality":"",
            "County":"",
            "District":"",
            "StateProvince":"",
            "Postcode":"",
            "CountryCode":"",
            "CountryName":""
         }
      ]
   }
}

Multiple Requests

Sample JSON Request:
{
   "DtRequests":{
      "DtRequest":[
         {
            "Method":"DataTools.Verify.Address.IntGdc.VerifyAddress", 
            "CountryCode":"", 
            "AddressLine1":"", 
            "AddressLine2":"", 
            "AddressLine3":"", 
            "AddressLine4":"", 
            "AddressLine5":"", 
            "AddressLine6":"", 
            "AddressLine7":"", 
            "AddressLine8":"", 
            "AddressLine9":"", 
            "AddressLine10":"", 
            "Locality":"", 
            "StateProvince":"", 
            "Postcode":"", 
            "Options":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         },
         {
            "Method":"DataTools.Verify.Address.IntGdc.VerifyAddress", 
            "CountryCode":"", 
            "AddressLine1":"", 
            "AddressLine2":"", 
            "AddressLine3":"", 
            "AddressLine4":"", 
            "AddressLine5":"", 
            "AddressLine6":"", 
            "AddressLine7":"", 
            "AddressLine8":"", 
            "AddressLine9":"", 
            "AddressLine10":"", 
            "Locality":"", 
            "StateProvince":"", 
            "Postcode":"", 
            "Options":"", 
            "RequestId":"", 
            "RequestKey":"", 
            "DepartmentCode":""
         }
      ]
   }
}

Sample JSON Response:
{
   "DtResponses":{
      "ErrorMessage":"",
      "DtResponse":[
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "AddressReliabilityCode":"",
                  "AddressReliabilityDescription":"",
                  "AddressAdaptationCode":"",
                  "AddressAdaptationDescription":"",
                  "AddressLine1":"",
                  "AddressLine2":"",
                  "AddressLine3":"",
                  "AddressLine4":"",
                  "AddressLine5":"",
                  "AddressLine6":"",
                  "AddressLine7":"",
                  "AddressLine8":"",
                  "AddressLine9":"",
                  "AddressLine10":"",
                  "BuildingName":"",
                  "StreetNumber":"",
                  "StreetName":"",
                  "PostBox":"",
                  "Locality":"",
                  "County":"",
                  "District":"",
                  "StateProvince":"",
                  "Postcode":"",
                  "CountryCode":"",
                  "CountryName":""
               }
            ]
         },
         {
            "RequestId":"",
            "ResultCount":"1",
            "ErrorMessage":"",
            "Result":[
               {
                  "AddressReliabilityCode":"",
                  "AddressReliabilityDescription":"",
                  "AddressAdaptationCode":"",
                  "AddressAdaptationDescription":"",
                  "AddressLine1":"",
                  "AddressLine2":"",
                  "AddressLine3":"",
                  "AddressLine4":"",
                  "AddressLine5":"",
                  "AddressLine6":"",
                  "AddressLine7":"",
                  "AddressLine8":"",
                  "AddressLine9":"",
                  "AddressLine10":"",
                  "BuildingName":"",
                  "StreetNumber":"",
                  "StreetName":"",
                  "PostBox":"",
                  "Locality":"",
                  "County":"",
                  "District":"",
                  "StateProvince":"",
                  "Postcode":"",
                  "CountryCode":"",
                  "CountryName":""
               }
            ]
         }
      ]
   }
}

Web Service Method: ProcessQueryXmlRequest (REST with XML)

Request Format: Body (Raw XML), Response Formats: JSON, XML*,
Protocols: HTTP GET, HTTPS GET, HTTP POST, HTTPS POST, HTTP OPTIONS, HTTPS OPTIONS
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc

Single Request

Sample XML Request:
<DtRequest Method="DataTools.Verify.Address.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result AddressReliabilityCode="" AddressReliabilityDescription="" AddressAdaptationCode="" AddressAdaptationDescription="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" BuildingName="" StreetNumber="" StreetName="" PostBox="" Locality="" County="" District="" StateProvince="" Postcode="" CountryCode="" CountryName="" />
</DtResponse>

Multiple Requests

Sample XML Request:
<DtRequests>
    <DtRequest Method="DataTools.Verify.Address.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Verify.Address.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" RequestId="" RequestKey="" DepartmentCode="" />
</DtRequests>

Sample XML Response:
<DtResponses ErrorMessage="">
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result AddressReliabilityCode="" AddressReliabilityDescription="" AddressAdaptationCode="" AddressAdaptationDescription="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" BuildingName="" StreetNumber="" StreetName="" PostBox="" Locality="" County="" District="" StateProvince="" Postcode="" CountryCode="" CountryName="" />
  </DtResponse>
  <DtResponse RequestId="" ResultCount="1" ErrorMessage="">
    <Result AddressReliabilityCode="" AddressReliabilityDescription="" AddressAdaptationCode="" AddressAdaptationDescription="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" BuildingName="" StreetNumber="" StreetName="" PostBox="" Locality="" County="" District="" StateProvince="" Postcode="" CountryCode="" CountryName="" />
  </DtResponse>
</DtResponses>

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.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" RequestId="" RequestKey="" DepartmentCode="" />

Sample XML Response:
<DtResponse RequestId="" ResultCount="1" ErrorMessage="">
  <Result AddressReliabilityCode="" AddressReliabilityDescription="" AddressAdaptationCode="" AddressAdaptationDescription="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" BuildingName="" StreetNumber="" StreetName="" PostBox="" Locality="" County="" District="" StateProvince="" Postcode="" CountryCode="" CountryName="" />
</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 "<" and ">" to ">". 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.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" 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.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" RequestId="" RequestKey="" DepartmentCode="" />
    <DtRequest Method="DataTools.Verify.Address.IntGdc.VerifyAddress" CountryCode="" AddressLine1="" AddressLine2="" AddressLine3="" AddressLine4="" AddressLine5="" AddressLine6="" AddressLine7="" AddressLine8="" AddressLine9="" AddressLine10="" Locality="" StateProvince="" Postcode="" Options="" 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.