Address Validation API

For overview information and a list of supported countries, see Address Validation.

For a step-by-step guide to this API, see How to Build an Address Validation Request.

Address Validation URI Summary

The Address Validation URI uses the service identifier address.

Operation	Action	URI Template	URI Example	Transaction Type	Non-URI Request / Payload	Response
validate	POST	/vM.m/stores/STOREID/address/validate.format	/v1.0/stores/ABCD/address/validate.xml	Validate an address for deliverability	XML	200 + XML response

URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:

https://apg.radial.com/v1.0/proxyname/storecode/function

You should have received the applicable information for proxyname, storecode, and function from your Radial representative.

Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.

Schemas

Address Validation Response Codes

Code	Description
V	Address validated – the submitted address was correct and / or standardized
S	Address was standardized and is deliverable. Can be updated without informing customer
C	Address was corrected, there are suggested addresses
K	Address was checked but could not be corrected, suggested addresses have a higher probability of delivery
N	Address could not be validated, address validation service does not suppor the address country
U	Unable to contact provider
T	Provider timeout
P	Provider returned a system error message (check the providerErrorText field value for details)
M	Address validation request was malformed or contained invalid data

Address Validation URI Examples

Validate an address for deliverability

Request XML

Copy

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <Header>
    <MaxAddressSuggestions>##MAX_SUGGESTIONS##</MaxAddressSuggestions>
  </Header>
  <Address>
    <Line1>##LINE_1##</Line1>
    <Line2>##LINE_2##</Line2>  <!-- optional -->
    <Line3>##LINE_3##</Line3>  <!-- optional -->
    <Line4>##LINE_4##</Line4>  <!-- optional -->
    <City>##CITY##</City>
    <MainDivision>##MAIN_DIVISION##</MainDivision>
    <CountryCode>##COUNTRY_CODE##</CountryCode>
    <PostalCode>##POSTAL_CODE##</PostalCode>
  </Address>
</AddressValidationRequest>

Response XML

Copy

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <Header>
        <MaxAddressSuggestions>5</MaxAddressSuggestions>
    </Header>
    <RequestAddress>
        <Line1>9193 18th St</Line1>
        <City>Auburn</City>
        <MainDivision>NY</MainDivision>
        <CountryCode>US</CountryCode>
        <PostalCode>13021-0123</PostalCode>
        <FormattedAddress>9193 18th St
            Auburn NY 13021-0123
            US
        </FormattedAddress>
    </RequestAddress>
    <Result>
        <ResultCode>V</ResultCode>
        <ResultSuggestionCount>0</ResultSuggestionCount>
    </Result>
</AddressValidationResponse>

Corrected Address

Request XML

Copy

<?xml version="1.0" encoding="UTF-8"?> 
<AddressValidationRequest xmlns=http://api.gsicommerce.com/schema/checkout/1.0> 
    <Header> 
        <MaxAddressSuggestions>5</MaxAddressSuggestions> 
    </Header> 
    <Address> 
        <Line1>1st Ave</Line1> 
        <City>King of Prussia</City> 
        <MainDivision>PA</MainDivision> 
        <CountryCode>US</CountryCode> 
        <PostalCode>19406</PostalCode> 
    </Address> 
</AddressValidationRequest>