Available Methods
Method
Description
Rapid
Interactive
Batch
DataTools.Capture
DataTools.Capture.Address.Predictive.AuNzPaf.SearchAddress
You can use this method when you have the start of an address you wish to search against the Australian and New Zealand PAFs. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.AuPaf.RetrieveAddress
You can use this method to retrieve full address details from the Australian PAF for record IDs prefixed with 'AuPaf'.
DataTools.Capture.Address.Predictive.AuPaf.RetrieveAddressBureau
Same as the standard AuPaf.RetreiveAddress method with the additional payment of Australia Post bureau royalty. Please note additional reporting is also required when processing bureau transactions.
DataTools.Capture.Address.Predictive.AuPaf.SearchAddress
You can use this method when you have the start of an address you wish to search against the Australian PAF. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.CaPaf.RetrieveAddress
You can use this method to retrieve full address details from the Canada Post PAF for record IDs prefixed with 'CaPaf'.
DataTools.Capture.Address.Predictive.CaPaf.SearchAddress
You can use this method when you have the start of a Canadian address you wish to search against the Canada Post PAF. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.Gnaf.RetrieveAddress
You can use this method to retrieve full address details from the Australian GNAF data for record IDs prefixed with 'Gnaf'.
DataTools.Capture.Address.Predictive.Gnaf.RetrieveGeocode
You can use this method to retrieve the geocode from the Australian GNAF data for record IDs prefixed with 'Gnaf'.
DataTools.Capture.Address.Predictive.Gnaf.SearchAddress
You can use this method when you have the start of an address you wish to search against the Australian GNAF data. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.IntPca.RetrieveAddress
You can use this method to retrieve full international address details for record IDs prefixed with 'IntPca'.
DataTools.Capture.Address.Predictive.IntPca.SearchAddress
You can use this method when you have the start of an international address you wish to search against international address sources for validation. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.Nzad.RetrieveAddress
You can use this method to retrieve full address details from the New Zealand NZAD for record IDs prefixed with 'Nzad'.
DataTools.Capture.Address.Predictive.Nzad.RetrieveGeocode
You can use this method to retrieve the geocode from the New Zealand NZAD data for record IDs prefixed with 'Nzad'.
DataTools.Capture.Address.Predictive.Nzad.SearchAddress
You can use this method when you have the start of an address you wish to search against the New Zealand NZAD data. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.NzPaf.RetrieveAddress
You can use this method to retrieve full address details from the New Zealand PAF for record IDs prefixed with 'NzPaf'.
DataTools.Capture.Address.Predictive.NzPaf.SearchAddress
You can use this method when you have the start of an address you wish to search against the New Zealand PAF. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Predictive.UkPaf.RetrieveAddress
You can use this method to retrieve full address details from the Royal Mail PAF for record IDs prefixed with 'UkPaf'.
DataTools.Capture.Address.Predictive.UkPaf.SearchAddress
You can use this method when you have the start of a UK address you wish to search against the Royal Mail PAF. This method is perfect for Predictive Search rapid address capture.
DataTools.Capture.Address.Reverse.AuPaf.RetrieveLocalityDefaultPostcode
You can use this method when you after a default postcode for an Australian locality
DataTools.Capture.Address.Reverse.AuPaf.RetrieveLocalityPostcodes
You can use this method to retrieve the list of postcodes for an Australian locality
DataTools.Capture.Address.Reverse.AuPaf.SearchLocality
You can use this method when you have the start of an locality you wish to search against the Australian PAF.
DataTools.Capture.Address.Reverse.AuPaf.SearchPostcode
You can use this method when you have a postcode you wish to search against the Australian PAF.
DataTools.Capture.BusinessName.Search.AuAbr.SearchBusinessName
You can use this method to search business names using the Australia Government ABN Lookup service. Users must create an account with ABR in order to access this service. Visit http://abr.business.gov.au for more details.
DataTools.Capture.BusinessName.Search.Nzbr.SearchBusinessName
Use this method to search the New Zealand Business Name register of business entities. Currently this includes all entities from the Companies Register, with further types to be added in future when enabling legislation has passed. Users must create an account with MBIE in order to access this service. Visit http://api.business.govt.nz/ for more details.
DataTools.Parse
DataTools.Parse.Address.Au.Parse
Use to parse Australian Addresses
DataTools.Parse.PersonName.Parse
Use to parse people's names
DataTools.Verify
DataTools.Verify.Address.AuPaf.VerifyAddress
Use to search an address against the Australian PAF using Australia 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.
DataTools.Verify.Address.AuPaf.VerifyAddressBureau
Same as the standard VerifyAddress method with the additional payment of Australia Post bureau royalty. Please note additional reporting is also required when processing bureau transactions.
DataTools.Verify.Address.IntGdc.VerifyAddress
You can use this method to verify full addresses against a variety of International address sources.
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.
DataTools.Verify.AsicNumber.AuAbr.VerifyAsicNumber
Use this method to search for Australian business details using the ASIC Number
DataTools.Verify.AustralianBusinessNumber.AuAbr.VerifyAbn
Use this method to search for Australian business details using the ABN
DataTools.Verify.Bsb.AuApca.VerifyBsb
You can use this method to search and verify Australian financial institution BSB information.
DataTools.Verify.Email.BriteVerify.VerifyEmail
You can use this method to validate email addresses
DataTools.Verify.PhoneNumber.Equifax.VerifyPhoneNumberIsConnected
Use this method to verify an Australian or New Zealand phone number
DataTools.Verify.PhoneNumber.NumVerify.VerifyPhoneNumber
Use this method to verify the format of an international phone number
DataTools.Repair
DataTools.Repair.Address.AuPaf.RepairAddress
Use to repair an address that can't be found in the PAF. This method will return a single address with correction where possible. This method requires no user interaction.
DataTools.Repair.Address.AuPaf.RepairAddressBureau
Same as the standard RepairAddress method with the additional payment of Australia Post bureau royalty. Please note additional reporting is also required when processing bureau transactions.
DataTools.Repair.Address.AuPaf.ReturnAddressSuggestions
Use to search for address suggestions against the Australian PAF using Australia Post's Rapid rules. This method will return multiple address suggestions closely matching the input address. This method requires user interaction to verify if a correct address match was found.
DataTools.Match
DataTools.Match.Address.Au.CreateKeys
Use to generate match keys used to fuzzy match addresses.
DataTools.Match.BusinessName.CreateKeys
Use to generate match keys used to fuzzy match business names.
DataTools.Match.BusinessNameAndAddress.Au.CreateKeys
Use to generate match keys used to fuzzy match business name and address.
DataTools.Match.PersonName.CreateKeys
Use to generate match keys used to fuzzy match people's names.
DataTools.Match.PersonNameAndAddress.Au.CreateKeys
Use to generate match keys used to fuzzy match people's names and address.
DataTools.Enhance
DataTools.Enhance.Address.Geocoding.Gnaf.Au.AppendToAddress
Use to geocode Australian addresses with the G-NAF dataset
DataTools.Enhance.Address.Geocoding.Gnaf.Au.AppendToDpid
Use to geocode Australian addresses using a DPID with the G-NAF dataset
DataTools.Enhance.Address.Geocoding.Linz.Nz.AppendToAddress
Use to geocode New Zealand addresses with the LINZ dataset
DataTools.Enhance.Address.PermissionsAndDelivery.AuPost.AppendToAddress
Use to retrieve information relating to the permissions and deliverability of an Australian address.
DataTools.Enhance.Address.PermissionsAndDelivery.AuPost.AppendToDpid
Use to retrieve information relating to the permissions and deliverability of a DPID associated with an Australian address.
DataTools.Enhance.Address.SuppressionDeceased.AuPost.AppendToAddress
Use to retrieve information indicating when someone has passed away at an Australian address.
DataTools.Enhance.Address.SuppressionDeceased.AuPost.AppendToDpid
Use to retrieve information indicating when someone has passed away at a DPID associated with an Australian address.
DataTools.Enhance.Address.SuppressionMoved.AuPost.AppendToAddress
Use to retrieve information indicating when someone has moved from an Australian address.
DataTools.Enhance.Address.SuppressionMoved.AuPost.AppendToDpid
Use to retrieve information of when someone has moved from a DPID associated with an Australian address.
DataTools.Enhance.Barcode.AusPost.Create4StateBarcode
Use this method to generate the Australia Post 4-state barcode numbers from a DPID
DataTools.Batch
DataTools.Batch.CancelJob
Use this method to cancel a batch job.
DataTools.Batch.CreateJob
Use this method to create a job.
DataTools.Batch.DeleteJobInputFiles
Use this method to delete Job files.
DataTools.Batch.DeleteJobResultFiles
Use this method to delete Job files.
DataTools.Batch.ExecuteJob
Use this method to execute a job.
DataTools.Batch.RetrieveBatchMethodParameterDescriptions
Use this method to retrieve Batch Method's parameter descriptions.
DataTools.Batch.RetrieveBatchMethodResultFieldDescriptions
Use this method to retrieve Batch Method's result field descriptions.
DataTools.Batch.RetrieveJobStatus
Use this method to retrieve current job status.
DataTools.Batch.RetrieveProcessRequestBatchMethods
Use this method to retrieve current list of avialable batch methods.
DataTools.Batch.RetrieveResultFiles
Use this method to retrieve result file/s.
DataTools.Batch.RetrieveUploadEndpoint
Use this method to retrieve the endpoint for uploading file.