You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Web Services Guide
Content
Search Results
Loading, please wait ...
Welcome
Getting Started
REST
The REST Interface
JSON POST Request
XML POST Request
Web Service Authentication
Using Token Authentication
Getting a Token
Using a Token
Logging Off
Exposing a Service as a Web Service
Adding POST Support to a REST Web Service
Micro-Batch Processing
Sample .NET Class
SOAP
The SOAP Interface
Web Service Authentication
Using Token Authentication
Getting a Token
Using a Token
Logging Off
Exposing a Service as a Web Service
Micro-Batch Processing
Sample .NET Class
Web Services
Enabling CORS
REST
Data Hub Module
Data Hub Module REST API
Entity Requests
Create Entity Operation
Read Entity Operation
Update Entity Operation
Delete Entity Operation
Relationship Requests
Create Relationship Operation
Read Relationship Operation
Update Relationship Operation
Delete Relationship Operation
Enterprise Tax Module
AssignGeoTAXInfo
Request
Parameters for Input Data
Matching Options
Geocoding Options
Output Data Options
Output Format
Response
Address Match Results
Auxiliary File
Census
Latitude/Longitude
Input Address
Payroll System Tax Code
Tax Jurisdiction
User-Defined Boundary File
Insurance Premium Tax Districts
Parsed Elements
Payroll Tax Districts
Special Purpose Tax Districts
Sales and Use Tax Rates
Error Reporting
CalculateDistance
Request
Parameters for Input Data
Parameters for Options
Response
ReverseGeoTAXInfoLookup
Request
Geocoding Options
Output Data Options
Output Format
Response
Auxiliary File
Census
Input Latitude/Longitude
Payroll System Tax Code
Tax Jurisdiction
User-Defined Boundary File
Insurance Premium Tax Districts
Payroll Tax Districts
Special Purpose Tax Districts
Sales and Use Tax Rates
Error Reporting
Match and Location Codes
Match Codes
Location Codes
Location Codes
Street centroid location codes
ZIP + 4 Location Codes
Geographic Centroid Location Codes
Type Codes
Class Codes
GeoConfidence Module
GeoConfidenceSurface
Request
Response
Global Addressing Module
Global Address Validation
Request
Input
Options
Global Type Ahead
Global Sentry Module
GlobalSentry
Request
Parameters for Input Data
Response
Understanding the Risk Analysis Score
Customizing the Global Sentry Service
Information Extraction Module
InformationExtractor
Request
Parameters for Input Data
Options
Response
Spatial Module
Where to Find Documentation?
What is the Routing Demo Page?
Launching The Routing Demo Page
Using The Routing Demo Page
GetRoute
GetRoute HTTP POST Options
GetRouteCostMatrix
GetRouteCostMatrix HTTP POST Options
GetSegmentData
GetTravelBoundary
GetTravelBoundary HTTP POST Options
GetTravelBoundary (Deprecated)
Request
Parameters for Input Data
Parameters for Options
Input
Output
Travel
Response
PersistentUpdate
Point Updates
Segment Updates
Road Type Updates
Remove All Updates
Get All Updates
GetCapabilities
DescribeDatasets
DescribeDatabases
Universal Addressing Module
AutoCompleteLoqate
Request
Parameters for Input Data
Parameters for Options
Response
AutoCompleteLoqate Sample Web Application
GetCandidateAddresses
Request
Parameters for Input Data
Parameters for Options
Response
GetCandidateAddressesLoqate
Request
Parameters for Input Data
Parameters for Options
Response
GetCityStateProvince
Request
Parameters for Input Data
Parameters for Options
Response
GetCityStateProvinceLoqate
Request
Parameters for Input Data
Options
Response
GetPostalCodes
Request
Parameters for Input Data
Parameters for Options
Response
ValidateAddress
Request
Parameters for Input Data
Address Line Processing for U.S. Addresses
Parameters for Options
Output Data Options
Obtaining Congressional Districts
Obtaining County Names
Obtaining FIPS County Numbers
Obtaining Carrier Route Codes
Creating Delivery Point Barcodes
Default Options
About Dual Address Logic
Returning Multiple Matches
U.S. Address Options
CASS Certified Processing
Canadian Address Options
SERP Processing
Obtaining SERP Return Codes
International Address Options
Response
Standard Address Output
Parsed Address Elements Output
Parsed Input
Postal Data Output
Result Indicators
Record-Level Result Indicators
Field-Level Result Indicators
Output from Options
Additional Input Data
Care of Data
Extraneous Data on Its Own Address Line
Extraneous Data Within an Address Line
Dual Addresses
ValidateAddressGlobal
Request
Parameters for Input Data
Parameters for Options
Input Options
Output Options
Process Options
Response
Address Data
Original Input Data
Result Codes
ValidateAddressLoqate
Request
Parameters for Input Data
Address Line Processing for U.S. Addresses
Options
Returning Multiple Matches
Match Score Threshold Options
Response
Standard Address Output
Parsed Address Elements Output
Parsed Input
Geocode Output
Result Indicators
Record-Level Result Indicators
Field-Level Result Indicators
The AVC Code
AMAS Output
Universal Name Module
OpenNameParser
Request
Parameters for Input Data
Options
Parameters for Parsing Options
Parameters for Culture Options
Parameters for Advanced Options
Response
SOAP
Enterprise Tax Module
AssignGeoTAXInfo
Request
Parameters for Input Data
Matching Options
Geocoding Options
Output Data Options
Output Format
Response
Address Match Results
Auxiliary File
Census
Latitude/Longitude
Input Address
Parsed Elements
Payroll System Tax Code
Tax Jurisdiction
User-Defined Boundary File
Insurance Premium Tax Districts
Payroll Tax Districts
Special Purpose Tax Districts
Sales and Use Tax Rates
Error Reporting
CalculateDistance
Request
Parameters for Input Data
Parameters for Options
Response
ReverseGeoTAXInfoLookup
Request
Geocoding Options
Output Data Options
Output Format
Response
Auxiliary File
Census
Input Latitude/Longitude
Payroll System Tax Code
Tax Jurisdiction
User-Defined Boundary File
Insurance Premium Tax Districts
Payroll Tax Districts
Special Purpose Tax Districts
Sales and Use Tax Rates
Error Reporting
Match and Location Codes
Match Codes
Location Codes
Location Codes
Street centroid location codes
ZIP + 4 Location Codes
Geographic Centroid Location Codes
Type Codes
Class Codes
GeoConfidence Module
GeoConfidenceSurface
Request
Response
Global Sentry Module
GlobalSentry
Request
Parameters for Input Data
Response
Understanding the Risk Analysis Score
Customizing the Global Sentry Service
Information Extraction Module
InformationExtractor
Request
Parameters for Input Data
Options
Response
Spatial Module
Where to Find Documentation?
GetTravelBoundary (Deprecated)
Request
Parameters for Input Data
Parameters for Options
Input
Output
Travel
Response
GetTravelCostMatrix (Deprecated)
Request
Parameters for Input Data
Parameters for Options
Travel
Routing
Transient Options
GetTravelCostMatrix Transient Update SOAP Example
Response
GetTravelDirections (Legacy)
Request
Parameters for Input Data
Parameters for Options
Routing
Directions
Travel
Transient Options
GetTravelDirections Transient Update SOAP Example
Response
GetRouteData
Request
Parameters for Input
Options
Response
Response
PersistentUpdate
Request
Parameters for Options
Input Options
Point Options
Segment Options
Road-type Options
Reset Options
Persistent Update SOAP Example
Response
Response
Universal Addressing Module
AutoCompleteLoqate
Request
Parameters for Input Data
Parameters for Options
Response
AutoCompleteLoqate Sample Web Application
GetCandidateAddresses
Request
Parameters for Input Data
Parameters for Options
Response
GetCandidateAddressesLoqate
Request
Parameters for Input Data
Parameters for Options
Response
GetCityStateProvince
Request
Parameters for Input Data
Parameters for Options
Response
GetCityStateProvinceLoqate
Request
Parameters for Input Data
Options
Response
GetPostalCodes
Request
Parameters for Input Data
Parameters for Options
Response
ValidateAddress
Request
Parameters for Input Data
Address Line Processing for U.S. Addresses
Parameters for Options
Output Data Options
Obtaining Congressional Districts
Obtaining County Names
Obtaining FIPS County Numbers
Obtaining Carrier Route Codes
Creating Delivery Point Barcodes
Default Options
About Dual Address Logic
Returning Multiple Matches
U.S. Address Options
CASS Certified Processing
Canadian Address Options
SERP Processing
Obtaining SERP Return Codes
International Address Options
Response
Standard Address Output
Parsed Address Elements Output
Parsed Input
Postal Data Output
Result Indicators
Record-Level Result Indicators
Field-Level Result Indicators
Output from Options
Additional Input Data
Care of Data
Extraneous Data on Its Own Address Line
Extraneous Data Within an Address Line
Dual Addresses
ValidateAddressGlobal
Request
Parameters for Input Data
Parameters for Options
Input Options
Output Options
Process Options
Response
Address Data
Original Input Data
Result Codes
ValidateAddressLoqate
Request
Parameters for Input Data
Address Line Processing for U.S. Addresses
Options
Returning Multiple Matches
Match Score Threshold Options
Response
Standard Address Output
Parsed Address Elements Output
Parsed Input
Geocode Output
Result Indicators
Record-Level Result Indicators
Field-Level Result Indicators
The AVC Code
AMAS Output
Universal Name Module
OpenNameParser
Request
Parameters for Input Data
Options
Parameters for Parsing Options
Parameters for Culture Options
Parameters for Advanced Options
Response
Appendix
Buffering
Buffering
Country Codes
ISO Country Codes and Module Support
Validate
Address Confidence Algorithm
Introduction to the Validate Address Confidence Algorithm
Confidence Algorithm for U.S. and Canadian Addresses
Confidence Algorithm for International Addresses
Your browser does not support iframes.