Reference guide - Melissa Data

GlobalAddress VerificationWeb ServiceReference GuideMelissa Data Corporation

CopyrightCompanies, names, and data used in examples herein are fictitious unless otherwise noted. No partof this document may be reproduced or transmitted in any form or by any means, electronic ormechanical, for any purpose, without the express written permission of Melissa Data Corporation.This document and the software it describes are furnished under a license agreement, and may beused or copied only in accordance with the terms of the license agreement.Copyright © 2013 by Melissa Data Corporation. All rights reserved.Information in this document is subject to change without notice. Melissa Data Corporationassumes no responsibility or liability for any errors, omissions, or inaccuracies that may appear in thisdocument.TrademarksThe Global Address Verification Web Service is a registered trademark of Melissa Data Corp.Windows is a registered trademark of Microsoft Corp.The following trademarks are owned by the United States Postal Service®: PO Box; ZIP; ZIPCode; United States Postal Service.All other brands and products are trademarks of their respective holder(s).Melissa Data Corporation22382 Avenida EmpresaRancho Santa Margarita, CA 92688-2112Phone: 1-800-MELISSA (1-800-635-4772)Fax: 949-589-5211E-mail: info@MelissaData.comInternet: www.MelissaData.comFor the most recent version of this document, visithttp://www.melissadata.com/Document Code: DQTWSGAVRGRevision Number: 05082013.17

Reference GuideTable of ContentsResponses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17TransmissionReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18TransmissionResults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18TotalRecords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19ResponseRecord Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19RecordID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20FormattedAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21AddressLine1-8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21SubPremises . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22DoubleDependentLocality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22DependentLocality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Locality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23SubAdministrativeArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24AdministrativeArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24PostalCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Appended Address Record Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25AddressType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25AddressKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26SubNationalArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26CountryName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27CountryISO3166_1_Alpha2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27CountryISO3166_1_Alpha3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28CountryISO3166_1_Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Thoroughfare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29ThoroughfarePreDirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29ThoroughfareLeadingType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30ThoroughfareName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30ThoroughfareTrailingType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31iii

Table of ContentsGlobal Address Verification Web ServiceThoroughfarePostDirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31DependentThoroughfare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32DependentThoroughfarePreDirection . . . . . . . . . . . . . . . . . . . . . . . . . 32DependentThoroughfareLeadingType . . . . . . . . . . . . . . . . . . . . . . . . . 33DependentThoroughfareName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33DependentThoroughfareTrailingType . . . . . . . . . . . . . . . . . . . . . . . . . 34DependentThoroughfarePostDirection . . . . . . . . . . . . . . . . . . . . . . . . 34Building . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35PremisesType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35PremisesNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36SubPremisesType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36SubPremisesNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37PostBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Results Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40TransmissionResults Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Results Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41AddressType Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Example Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44SOAP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44JSON Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45REST Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46XML Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46XFORMS Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Example Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47SOAP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47JSON Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48XML Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50iv

Reference GuideIntroductionIntroductionWelcome to the Melissa Data Global Address Verification Web Service. Verify andstandardize mailing addresses from across the world with the flexibility and accuracydelivered by Melissa Data products.The Global Address Verification Web Service:• Supports 240 countries in the world.• Will detail both the accuracy of a given address and the possible accuracy of a givencountry.• Still supports the expected accuracy of Melissa Data’s Address Check Web Service forthe United States and Canada.• Supports multiple protocols to access the Web Service, including JSON, XML,REST, XFORMS, and SOAP.Character ReplacementsUsing the REST service may require that you encode certain characters using the properURL entities before adding them to a URL. Characters like spaces, slashes, ampersands,and others must be replaced by special codes, which usually consist of a percent signfollowed by a two-digit hexadecimal number.The following table shows the replacements for the most common characters.Character URL Encoded Character URL EncodedSpace %20 or + ; %3B* %2A < %3C# %23 = %3D& %26 > %3E% %25 ? %3F$ %28 @ %40+ %2B [ %5B1

Reference GuideProtocolsProtocolsThe Web Service supports the following protocols all using HTTP:• POST request using XML or JSON with XML or JSON response:An HTTP POST is issued with the "ContentType" header specifying the format ofthe request and the "Accept" header specifying the format of the response. Thedefault for both request and response is "application/xml".• SOAP request/response:Same as the traditional SOAP requests used by other Melissa Data Web services.• GET request with querystring - XML/JSON response:Similar to traditional REST requests used by other Melissa Data web services in thatthe parameters are put into the querystring for the request. However, the responseformat can be controlled via the "Accept" header (default is "application/xml").• POST request with "ContentType=application/x-www-form-urlencoded":Similar to the GET request above, but the querystring is put into the body of therequest (with the leading "?" removed) and the POST verb is used instead of theGET verb. Typically used when submitting forms in HTML.3

Reference GuideRequestsRequestsA request consists of the use of a protocol to make a call to the Web Service, detailingdesired elements. The minimum required elements in a request are your Customer ID andat least one address record.The Global Address Verification Web Service supports multiple protocols to access theWeb Service, including SOAP, JSON, REST, XML, and XFORMS.The following example shows an XML Request. For more request examples, see“Example Requests” on page 44.Example XML Requeststringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring7

RequestsRecordIDGlobal Address Verification Web ServiceOptional. This is a string value containing a unique identifier for the current record. Usethis to match the record submitted with the record returned. It will return what isinputted.SyntaxSOAPReqInternational.Records.RequestRecord.RecordID = stringJSON"RecordID":"string"XMLstringOrganizationOptional. This is a string value of any organization name associated with the addressrecord.US Term: Company.SyntaxSOAPReqInternational.Records.RequestRecord.Organization = stringJSON"Organization":"string"10

Reference GuideRequestsSyntaxRESTOrganization={string}XMLstringAddressLine1-8Required. Input fields for the address. Should contain the delivery address information(house number, thoroughfare, building, suite, etc.) but should not contain localityinformation (locality, administrative area, postal code, etc.) which have their own inputs.At least one AddressLine is Required.Append the desired number to the AddressLine syntax to designate the desired element.The possible elements are: AddressLine1; AddressLine2; AddressLine3; AddressLine4;AddressLine5; AddressLine6; AddressLine7; AddressLine8.SyntaxSOAPReqInternational.Records.RequestRecord.AddressLine1 = stringJSON"AddressLine1":"string"RESTAddressLine1={string}XMLstring11

RequestsDoubleDependentLocalityGlobal Address Verification Web ServiceOptional. This is a string value for the smallest population center data element. Dependson the Locality and DependentLocality elements.SyntaxSOAPReqInternational.Records.RequestRecord.DoubleDependentLocality = stringJSON"DoubleDependentLocality":"string"RESTDoubleDependentLocality={string}XMLstringDependentLocalityOptional. This is a string value for a smaller population center data element. Depends onthe Locality element.US Term: Urbanization.In terms of US Addresses, this element applies only to Puerto Rican addresses. It is usedto break ties when a ZIP Code is linked to multiple instances of the same address.SyntaxSOAPReqInternational.Records.RequestRecord.DependentLocality = stringJSON"DependentLocality":"string"12

Reference GuideRequestsSyntaxRESTDependentLocality={string}XMLstringLocalityRequired. This is a string value for the most common population center data element.US Term: City.Canadian Term: Municipality.You must set either Locality and AdministrativeArea or PostalCode.SyntaxSOAPReqInternational.Records.RequestRecord.Locality = stringJSON"Locality":"string"RESTLocality={string}XMLstring13

RequestsSubAdministrativeAreaGlobal Address Verification Web ServiceOptional. This is a string value for the smallest geographic data element.US Term: County.SyntaxSOAPReqInternational.Records.RequestRecord.SubAdministrativeArea = stringJSON"SubAdministrativeArea":"string"RESTSubAdministrativeArea={string}XMLstringAdministrativeAreaRequired. This is a string value for the most common geographic data element.US Term: State.Canadian Term: Province.You must set either Locality and AdministrativeArea or PostalCode.SyntaxSOAPReqInternational.Records.RequestRecord.AdministrativeArea = stringJSON"AdministrativeArea":"string"14

Reference GuideRequestsSyntaxRESTAdministrativeArea={string}XMLstringPostalCodeRequired. This is a string value for the complete postal code for a particular delivery point.US Term: ZIP.Canadian Term: Postcode.You must set either Locality and AdministrativeArea or PostalCode. If the all threeelements are provided and the PostalCode is incorrect, it can be corrected from the dataon the Locality and AdministrativeArea.SyntaxSOAPReqInternational.Records.RequestRecord.PostalCode = stringJSON"PostalCode":"string"RESTPostalCode={string}XMLstring15

RequestsSubNationalAreaGlobal Address Verification Web ServiceOptional. This is a string value for the administrative region within a country on anarbitrary level below that of the sovereign state.SyntaxSOAPReqInternational.Records.RequestRecord.SubNationalArea = stringJSON"SubNationalArea":"string"RESTSubNationalArea={string}XMLstringCountryRequired. This is a string value for the country name, abbreviation, or code.SyntaxSOAPReqInternational.Records.RequestRecord.Country = stringJSON"Country":"string"RESTCountry={string}XMLstring16

Reference GuideResponsesResponsesA response is the result of a request. This consists of returned results codes, parsed addresselements, and appended address information.Depending on the protocol used to make the request, the response will be in a certainprotocol. Global Address Verification Web Service supports four possible responseprotocols: SOAP; JSON; XML; and XFORMS.Response ElementsVersionThis is a string value that is the current version number of the Global Address VerificationWeb Service.SyntaxSOAPstring = ResInternational.VersionJSON"Version":"string"XMLstring17

ResponsesTransmissionReferenceGlobal Address Verification Web ServiceThis is a string value that serves as a unique identifier for this set of records. It is returnedas sent by the Response Array, allowing you to match the Response to the Request.SyntaxSOAPstring = ResInternational.TransmissionReferenceJSON"TransmissionReference":"string"XMLstringTransmissionResultsThis is a string value that lists error codes from any errors caused by the most recentrequest as a whole.For a complete list of error codes, see “TransmissionResults Error Codes” on page 40.SyntaxSOAPstring = ResInternational.TransmissionResultsJSON"TransmissionResults":"string"XMLstring18

Reference GuideTotalRecordsThis is a string value that is the total number of records returned with the response.SyntaxSOAPstring = ResInternational.TotalRecordsJSON"TotalRecords":"string"XMLstringResponsesResponseRecord ElementsEach of the following elements are returned for each record in the Response Array.RecordIDThis is a string value that is a unique identifier for the current record if one was sent in therequest. Use this element to match a request record and the corresponding responserecord.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.RecordIDJSON"RecordID":"string"XMLstring19

ResponsesResultsGlobal Address Verification Web ServiceThis is a string value with comma delimited status, error codes, and change codes for therecord.For a complete list of codes, see “Response Results Codes” on page 41.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ResultsJSON"Results":"string"XMLstringFormattedAddressThis is a string value that is the address in the correct format for mailing from the countryspecified in the CountryOfOrigin element. This includes the Organization as the firstline, one or more lines in the origin country’s format, and the destination country (ifrequired). Separate lines will be delimited by what is specified in the option. For moreinformation, see “LineSeparator” on page 39.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.FormattedAddressJSON"FormattedAddress":"string"XMLstring20

Reference GuideOrganizationResponsesThis is a string value that matches the Organization request element. It is not modified orpopulated by the Web Service.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.OrganizationJSON"Organization":"string"XMLstringAddressLine1-8These are the string values that will return the standardized or corrected contents of theinput address. These lines will include the entire address including the locality,administrative area, and postal code.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.AddressLine1JSON"AddressLine1":"string"XMLstring21

ResponsesSubPremisesGlobal Address Verification Web ServiceThis is a string value that is the parsed SubPremises from the AddressLine elements.US Term: Suite.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.SubPremisesJSON"SubPremises":"string"XMLstringDoubleDependentLocalityThis is a string value that is the standardized contents of the DoubleDependentLocalityelement.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DoubleDependentLocalityJSON"DoubleDependentLocality":"string"XMLstring22

Reference GuideDependentLocalityResponsesThis is a string value that is the standardized contents of the DependentLocality element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentLocalityJSON"DependentLocality":"string"XMLstringLocalityThis is a string value that is the standardized contents of the Locality element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.LocalityJSON"Locality":"string"XMLstring23

ResponsesSubAdministrativeAreaGlobal Address Verification Web ServiceThis is a string value that is the standardized contents of the SubAdministrativeAreaelement.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.SubAdministrativeAreaJSON"SubAdministrativeArea":"string"XMLstringAdministrativeAreaThis is a string value that is the standardized contents of the AdministrativeArea element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.AdministrativeAreaJSON"AdministrativeArea":"string"XMLstring24

Reference GuidePostalCodeThis is a string value that is the standardized contents of the PostalCode element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.PostalCodeJSON"PostalCode":"string"XMLstringAppended Address Record ElementsAddressTypeResponsesThis is an appended string value that returns a one-character code for the type of addresscoded. This element works only for US and Canadian addresses. For a complete list ofthese codes, see “AddressType Codes” on page 43.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.AddressTypeJSON"AddressType":"string"XMLstring25

ResponsesAddressKeyGlobal Address Verification Web ServiceThis is a string value that is a unique key for the address. Only for US and Canadianaddresses.The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.AddressKeyJSON"AddressKey":"string"XMLstringSubNationalAreaThis is a string value that is the standardized contents of the SubNationalArea element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.SubNationalAreaJSON"SubNationalArea":"string"XMLstring26

Reference GuideCountryNameResponsesThis is a string value that is the standardized contents of the CountryName element.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.CountryNameJSON"CountryName":"string"XMLstringCountryISO3166_1_Alpha2This is a string value that is the parsed CountryISO3166_1_Alpha2 element from theinput. Ex: For United States; Canada; and the Philippines: US; CA; PH.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.CountryISO3166_1_Alpha2JSON"CountryISO3166_1_Alpha2":"string"XMLstring27

ResponsesCountryISO3166_1_Alpha3Global Address Verification Web ServiceThis is a string value that is the parsed CountryISO3166_1_Alpha3 element from theinput. Ex: For United States; Canada; and the Philippines: USA; CAN; PHL.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.CountryISO3166_1_Alpha3JSON"CountryISO3166_1_Alpha3":"string"XMLstringCountryISO3166_1_NumericThis is a string value that is the parsed CountryISO3166_1_Numeric element from theinput.Ex: For United States; Canada; and the Philippines: 840; 124; 608.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.CountryISO3166_1_NumericJSON"CountryISO3166_1_Numeric":"string"XMLstring28

Reference GuideThoroughfareThis is a string value that is the parsed Thoroughfare element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfareJSON"Thoroughfare":"string"XMLstringResponsesThoroughfarePreDirectionThis is a string value that is the parsed ThoroughfarePreDirection element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfarePreDirectionJSON"ThoroughfarePreDirection":"string"XMLstring29

ResponsesThoroughfareLeadingTypeGlobal Address Verification Web ServiceThis is a string value that is the parsed ThoroughfareLeadingType element from theinput.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfareLeadingTypeJSON"ThoroughfareLeadingType":"string"XMLstringThoroughfareNameThis is a string value that is the parsed ThoroughfareName element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfareNameJSON"ThoroughfareName":"string"XMLstring30

Reference GuideThoroughfareTrailingTypeResponsesThis is a string value that is the parsed ThoroughfareTrailingType element from theinput.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfareTrailingTypeJSON"ThoroughfareTrailingType":"string"XMLstringThoroughfarePostDirectionThis is a string value that is the parsed ThoroughfarePostDirection element from theinput.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.ThoroughfarePostDirectionJSON"ThoroughfarePostDirection":"string"XMLstring31

ResponsesDependentThoroughfareGlobal Address Verification Web ServiceThis is a string value that is the parsed DependentThoroughfare element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfareJSON"DependentThoroughfare":"string"XMLstringDependentThoroughfarePreDirectionThis is a string value that is the parsed DependentThoroughfarePreDirection elementfrom the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfarePreDirectionJSON"DependentThoroughfarePreDirection":"string"XMLstring32

Reference GuideDependentThoroughfareLeadingTypeResponsesThis is a string value that is the parsed DependentThoroughfareLeadingType elementfrom the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfareLeadingTypeJSON"DependentThoroughfareLeadingType":"string"XMLstringDependentThoroughfareNameThis is a string value that is the parsed DependentThoroughfareName element from theinput.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfareNameJSON"DependentThoroughfareName":"string"XMLstring33

ResponsesDependentThoroughfareTrailingTypeGlobal Address Verification Web ServiceThis is a string value that is the parsed DependentThoroughfareTrailingType elementfrom the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfareTrailingTypeJSON"DependentThoroughfareTrailingType":"string"XMLstringDependentThoroughfarePostDirectionThis is a string value that is the parsed DependentThoroughfarePostDirection elementfrom the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.DependentThoroughfarePostDirectionJSON"DependentThoroughfarePostDirection":"string"XMLstring34

Reference GuideBuildingThis is a string value that is the parsed Building element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.BuildingJSON"Building":"string"XMLstringResponsesPremisesTypeThis is a string value that is the parsed PremisesType element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.PremisesTypeJSON"PremisesType":"string"XMLstring35

ResponsesPremisesNumberGlobal Address Verification Web ServiceThis is a string value that is the parsed PremisesNumber element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.PremisesNumberJSON"PremisesNumber":"string"XMLstringSubPremisesTypeThis is a string value that is the parsed SubPremisesType element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.SubPremisesTypeJSON"SubPremisesType":"string"XMLstring36

Reference GuideSubPremisesNumberResponsesThis is a string value that is the parsed SubPremisesNumber element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.SubPremisesNumberJSON"SubPremisesNumber":"string"XMLstringPostBoxThis is a string value that is the parsed PostBox element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.PostBoxJSON"PostBox":"string"XMLstring37

ResponsesLatitudeGlobal Address Verification Web ServiceThis is a string value that is the parsed Latitude element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.LatitudeJSON"Latitude":"string"XMLstringLongitudeThis is a string value that is the parsed Longitude element from the input.SyntaxSOAPstring = ResInternational.Records.ResponseRecord.LongitudeJSON"Longitude":"string"XMLstring38

Reference GuideAppendixAppendixOptionsLineSeparatorThis is the line separator used for the FormattedAddress result.ValueSEMICOLON (Default)PIPECRLFCRLFTABBR (Line break)OutputScriptThis is the script type used for all applicable fields.ValueNOCHANGE (Default) - Returns the same script that is sent in.LATN39

AppendixCountryOfOriginInternational Address Check Web ServiceThis is used to determine whether or not to include the country name as the last line inFormattedAddress• Acceptable Value: Any valid ISO-3166-1 Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code.• If blank, invalid, or the same as the destination country, then the destination countryis not appended to the end of the formatted address.• If valid and different from the destination country, then the destination country isappended to the formatted address.• US or US Territory:a. If CountryOfOrigin and destination country being verified are both US or USTerritories then the country will not be appended to FormattedAddress.b. US Territories will have “Unite States of America” appended if theCountryOfOrigin is not a US Territory, but the CountryName and ISO codeswill be that of the territory.c. Canada is treated like any other non-US Territory.Results CodesTransmissionResults Error CodesCodeEmptySE01GE02GE03GE04GE05GE06GE08ErrorNo ErrorInternal ErrorEmpty JSON or XML request record structureRecord count is more than allowed per requestCustomerID is emptyCustomerID is not validCustomerID is disabledCustomerID is not valid for this product40

Reference GuideResponse Results CodesAppendixAVXX Verification Codes• AV2X denotes an address that has been verified to the highest possible level with thereference data.• AV1X denotes a partially verified address, but NOT to the highest level possible withthe reference data.• The second number indicates the level of verification. There are five levels:• Administrative Area(level 1) verification is the most general verification area, withSubPremises(level 5) being the most specific area.• Ideally, all addresses should be verified to Premises(level 4) or SubPremises(level 5.)However this is dependent on the quality of the address data and the countries’reference data. Some countries lack enough data to be verified to the SubPremises.They may only have data to the Locality(level 2.) This is why it is possible to have anAV22 code. The address has been verified up to the Locality and the reference dataonly has verification up to that level.• For example:a. AV25 indicates a maximum possible verification to the SubPremises(level 5.)b. AV24 indicates a maximum possible verification to the Premises(level 4.)c. AV22 indicates a maximum possible verification to the Locality(level 2.)This can occur if the reference data only contains data up to the Locality level.d. AV14 indicates a partial verification to the Premises(level 4.) This indicates thatthe reference data has verification up to the SubPremises(level 5.)41

AppendixAEXX Error CodesInternational Address Check Web ServiceCodeAE01AE02AE03AE05AE08AE09AE10AE11AE12AE13AE14AE17ErrorsNo VerificationUnknown StreetComponent ErrorMultiple MatchesSubPremises Number InvalidSubPremises Number MissingPremises Number InvalidPremises Number MissingPO Box Number InvalidPO Box Number MissingPrivate Mail Box MissingSubPremises Not RequiredACXX Change CodesCodeAC01AC02AC03AC09AC10AC11AC12AC13AC14ChangesPostalCodeAdministrativeAreaLocalityDependentLocalityThoroughfareNameThoroughfareTypeThoroughfare DirectionSubPremises TypeSubPremises Number42

Reference GuideAppendixCodeAC15AC16AC17ChangesDouble Dependent LocalitySubAdministrative AreaSubNational AreaGeoCoder Result CodesCodeGS01GS02GS03GS05GS06GE01GE02ResultGeocoded to ZIP+4 (U.S.) or 6-digit Postal Code (Canada) Centroid.Geocoded to ZIP+2 Centroid.Geocoded to 5-digit (U.S.) or 3-digit (Canada) ZIP Code Centroid.Geocoded to 11-digit Rooftop level.Geocoded to 11-digit Interpolated Rooftop level.Invalid ZIP Code entered.ZIP Code not found.AddressType CodesUS AddressesCodeAFGHPRSDescriptionAliasFirm or CompanyGeneral DeliveryHighrise or Business ComplexPO BoxRural RouteStreet or Residential43

AppendixCanadian AddressesInternational Address Check Web ServiceCodeDescription1 Street2 Street Served by Route and GD3 Lock Box4 Route Service5 General DeliveryBCDELKLVR StreetGovernment StreetLVR Lock BoxGovernment Lock BoxLVR General DeliveryBuildingExample RequestsThe following requests detail the possible elements and general format of the five possibleprotocols.SOAP RequestReqInternational.Records.RequestRecord As NewInternational.Records.RequestRecordResInternatioanl.Records.ResponseRecord As NewInternational.Records.ResponseRecordInternationalClient As New International.ServiceReqInternational.TransmissionReference = stringReqInternational.CustomerID = stringReqInternational.Options = stringReqInternational.Records.RequestRecord(99)ReqInternational.Records.RequestRecord.RecordID = stringReqInternational.Records.RequestRecord.Organization = stringReqInternational.Records.RequestRecord.AddressLine1 = stringReqInternational.Records.RequestRecord.AddressLine2 = string44

Reference GuideAppendixReqInternational.Records.RequestRecord.AddressLine3 = stringReqInternational.Records.RequestRecord.AddressLine4 = stringReqInternational.Records.RequestRecord.AddressLine5 = stringReqInternational.Records.RequestRecord.AddressLine6 = stringReqInternational.Records.RequestRecord.AddressLine7 = stringReqInternational.Records.RequestRecord.AddressLine8 = stringReqInternational.Records.RequestRecord.DoubleDependentLocality = stringReqInternational.Records.RequestRecord.DependentLocality = stringReqInternational.Records.RequestRecord.Locality = stringReqInternational.Records.RequestRecord.SubAdministrativeArea = stringReqInternational.Records.RequestRecord.AdministrativeArea = stringReqInternational.Records.RequestRecord.PostalCode = stringReqInternational.Records.RequestRecord.SubNationalArea = stringReqInternational.Records.RequestRecord.Country = stringResInternational = InternationalClient.Post(ReqInternational)InternationalClient.Dispose()JSON Request{}"TransmissionReference":"string","CustomerID":"string","Options":"string","Records":[{"RecordID":"string","Organization":"string","AddressLine1":"string","AddressLine2":"string","AddressLine3":"string","AddressLine4":"string","AddressLine5":"string","AddressLine6":"string","AddressLine7":"string","AddressLine8":"string","DoubleDependentLocality":"string","DependentLocality":"string","Locality":"string","SubAdministrativeArea":"string","AdministrativeArea":"string","PostalCode":"string","SubNationalArea":"string","Country":"string"}]45

AppendixREST RequestInternational Address Check Web ServiceThere is no recordID element because a REST request can only submit one record perrequest.http://address.melissadata.net/V3/WEB/GlobalAddress/doGlobalAddress?t={TransmissionReference}&id={CustomerId}&opt={Options}&org={Organization}&a1={AddressLine1}&a2={AddressLine2}&a3={AddressLine3}&a4={AddressLine4}&a5={AddressLine5}&a6={AddressLine6}&a7={AddressLine7}&a8={AddressLine8}&ddeploc={DoubleDependentLocality}&deploc={DependentLocality}&loc={Locality}&subadmarea={SubAdministrativeArea}&admarea={AdinistrativeArea}&subnatarea={SubNationalArea}&postal={PostalCode}&ctry={Country}XML Requeststringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring46

Reference GuideAppendixstringstringstringstringstringXFORMS RequestTo be implemented.Example ResponsesThe following responses detail the possible elements, appended elements, and generalformat of the three possible protocols.SOAP Responsestring = ResInternational.Versionstring = ResInternational.TransmissionReferencestring = ResInternational.TransimissionResultsstring = ResInternational.TotalRecordsstring = ResInternational.Records.ResponseRecord.RecordIDstring = ResInternational.Records.ResponseRecord.Resultsstring = ResInternational.Records.ResponseRecord.FormattedAddressstring = ResInternational.Records.ResponseRecord.Organizationstring = ResInternational.Records.ResponseRecord.AddressLine1string = ResInternational.Records.ResponseRecord.AddressLine2string = ResInternational.Records.ResponseRecord.AddressLine3-8string = ResInternational.Records.ResponseRecord.SubPremisesstring = ResInternational.Records.ResponseRecord.DoubleDependentLocalitystring = ResInternational.Records.ResponseRecord.DependentLocalitystring = ResInternational.Records.ResponseRecord.Localitystring = ResInternational.Records.ResponseRecord.SubAdministrativeAreastring = ResInternational.Records.ResponseRecord.AdministrativeAreastring = ResInternational.Records.ResponseRecord.PostalCodestring = ResInternational.Records.ResponseRecord.AddressTypestring = ResInternational.Records.ResponseRecord.AddressKeystring = ResInternational.Records.ResponseRecord.SubNationalAreastring = ResInternational.Records.ResponseRecord.CountryName47

AppendixInternational Address Check Web Servicestring = ResInternational.Records.ResponseRecord.CountryISO3166_1_Alpha2string = ResInternational.Records.ResponseRecord.CountryISO3166_1_Alpha3string = ResInternational.Records.ResponseRecord.CountryISO3166_1_Numericstring = ResInternational.Records.ResponseRecord.Thoroughfarestring = ResInternational.Records.ResponseRecord.ThoroughfarePreDirectionstring = ResInternational.Records.ResponseRecord.ThoroughfareLeadingTypestring = ResInternational.Records.ResponseRecord.ThoroughfareNamestring = ResInternational.Records.ResponseRecord.ThoroughfareTrailingTypestring = ResInternational.Records.ResponseRecord.ThoroughfarePostDirectionstring = ResInternational.Records.ResponseRecord.DependentThoroughfarestring = ResInternational.Records.ResponseRecord.DependentThoroughfarePreDirectionstring = ResInternational.Records.ResponseRecord.DependentThoroughfareLeadingTypestring = ResInternational.Records.ResponseRecord.DependentThoroughfareNamestring = ResInternational.Records.ResponseRecord.DependentThoroughfareTrailingTypestring = ResInternational.Records.ResponseRecord.DependentThoroughfarePostDirectionstring = ResInternational.Records.ResponseRecord.Buildingstring = ResInternational.Records.ResponseRecord.PremisesTypestring = ResInternational.Records.ResponseRecord.PremisesNumberstring = ResInternational.Records.ResponseRecord.SubPremisesTypestring = ResInternational.Records.ResponseRecord.SubPremisesNumberstring = ResInternational.Records.ResponseRecord.PostBoxstring = ResInternational.Records.ResponseRecord.Latitudestring = ResInternational.Records.ResponseRecord.LongitudeJSON Response{"Version":"string","TransmissionReference":"string","TransmissionResults":"string","TotalRecords":"string","Records":[{"RecordID":"string","Results":"string",48

Reference GuideAppendix49"FormattedAddress":"string","Organization":"string","AddressLine1":"string","AddressLine2":"string","AddressLine3":"string","AddressLine4":"string","AddressLine5":"string","AddressLine6":"string","AddressLine7":"string","AddressLine8":"string","SubPremises":"string","DoubleDependentLocality":"string","DependentLocality":"string","Locality":"string","SubAdministrativeArea":"string","AdministrativeArea":"string","PostalCode":"string","AddressType":"string","AddressKey":"string","SubNationalArea":"string","CountryName":"string","CountryISO3166_1_Alpha2":"string","CountryISO3166_1_Alpha3":"string","CountryISO3166_1_Numeric":"string","Thoroughfare":"string","ThoroughfarePreDirection":"string","ThoroughfareLeadingType":"string","ThoroughfareName":"string","ThoroughfareTrailingType":"string","ThoroughfarePostDirection":"string","DependentThoroughfare":"string","DependentThoroughfarePreDirection":"string","DependentThoroughfareLeadingType":"string","DependentThoroughfareName":"string","DependentThoroughfareTrailingType":"string","DependentThoroughfarePostDirection":"string","Building":"string","PremisesType":"string","PremisesNumber":"string","SubPremisesType":"string","SubPremisesNumber":"string","PostBox":"string","Latitude":"string","Longitude":"string"}]}

AppendixXML ResponseInternational Address Check Web ServiceString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString content50

Reference GuideAppendixString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString contentString content51