Address Validation Street Level JSON Developer Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 9

Download
Open PDF In Browser	View PDF

Address Validation Street Level
JSON Developer Guide
July 10, 2017

Important Information
UPS Developer Kit APIs
Your development of an application using UPS Developer Kit APIs is governed by the UPS Technology
Agreement you entered into with UPS. The following are key legal requirements from these agreements for the
UPS Developer Kit APIs. For more information on all requirements for the UPS Developer Kit APIs, please refer
to the UPS Technology Agreement.
Defined terms used but not defined in this document have the meaning set forth in the UPS Technology
Agreement.

Key Legal Requirements for UPS Developer APIs
Permitted Territories
This document can only be used in the countries of the Permitted Territory as defined in the UPS Technology
Agreement, as applicable.

Use
The application must not be designed to allow distribution of information received through the UPS Developer
Kit APIs to third parties, other than to persons having a bona fide interest in such information (e.g., the shipper,
receiver, or the third party payer, or to your service providers authorized by UPS).

Consent to Use of UPS Mark


All screens or forms generated by your application including information received through the UPS
Developer Kit APIs must include (1) the UPS Mark positioned in reasonable proximity to the Information and
of an appropriate size to readily identify the source of the Information as UPS and (2) the following language
at the bottom of every screen that displays the UPS Mark: "UPS, the UPS brand mark, and the Color Brown
are trademarks of United Parcel Service of America, Inc. All Rights Reserved." Except as set forth in the
preceding sentence, you have no right to use the UPS Mark without the prior written approval of UPS.



You shall not use the UPS Mark in association with any third party trademarks in a manner that might
suggest co-branding or otherwise create potential confusion as to source or sponsorship of the application,
or ownership of the UPS Mark.



The UPS Mark shall be used only as provided by UPS electronically or in hard copy form. The UPS Mark
may not be altered in any manner, including proportions, colors, elements, etc., or animated, morphed or
otherwise distorted in perspective or dimensional appearance.



The UPS Mark may not be combined with any other symbols, including words, logos, icons, graphics,
photos, slogans, numbers, or other design elements. A minimum amount of empty space must surround the
UPS Mark separating it from any other object, such as type, photography, borders, edges, etc. The required
area of empty space around the UPS Mark must be 1/3x, where x equals the height of the UPS Mark.

Copyright and Proprietary Notice
In your application and any POD Letters you prepare, you must include a prominent reproduction of UPS’s
copyright and proprietary notices in a form and format specified by UPS (See the Copyright section of this
document).

Display of Information
The application must not display information concerning any other provider of shipping services or such other
shipping services on any page, whether comprising one or more frames, displaying information your application
receives from the UPS Developer Kit APIs. Your application must present all data within each field received
through the UPS Developer Kit APIs without amendment, deletion, or modification of any type.

Notice
In all communications with UPS concerning this document, please refer to the document date located on the
cover.

Copyright
© 2017 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
The use, disclosure, reproduction, modification, transfer, or transmittal of this work for any purpose in any form
or by any means without the written permission of United Parcel Service is strictly prohibited.

Trademarks
Some of the UPS corporate applications use United States city, state, and postal code information obtained by
United Parcel Service of America, Inc. under a non-exclusive license from the United States Postal Service.

iii

Table of Contents
Chapter 1: Introduction ......................................................................................................... 5
Chapter 2: Customer Integration Environment (CIE) ............................................................... 6
JSON Testing and Production URLS ......................................................................................................................6

Chapter 3: JSON Examples ..................................................................................................... 7
XAVRequest.............................................................................................................................................................. 7
XAVResponse...........................................................................................................................................................8

Appendix............................................................................................................................... 9
JSON Error Codes ....................................................................................................................................................9

Address Validation Street Level` JSON Developer Guide

July 10, 2017

Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating the Address Validation Street
Level JSON API into your application, service, or system.

IMPORTANT:
 If this is your first time working with the UPS Developer Kit, begin with the Introduction to the
UPS Developer Kit guide. This guide serves as the foundation for all API-specific developer guides.
 For additional API, XPath, and Error Code information, refer to the Address Validation Street Level
Web Service Developer Guide.

Address Validation Street Level` JSON Developer Guide

July 10, 2017

Chapter 2: Customer Integration Environment (CIE)
The Customer Integration Environment allows customers to test their application prior to launch. This environment is
intended for integration testing of customer applications with the UPS servers.
Once your application has been thoroughly tested, you should redirect the application to the UPS Production
Environment.
No stress testing should ever be performed by customers against any UPS systems.
To access testing and production sites the user must have an Access Key. You can request an Access Key after
establishing a UPS profile and associating your shipping account.

System Availability
The Customer Integration Environment is available 24 hours a day, 7 days a week. Note the system is occasionally
down for server maintenance.

JSON Testing and Production URLS



All API URLs are case sensitive.

Testing:

https://wwwcie.ups.com/rest/XAV

Production:

https://onlinetools.ups.com/rest/XAV

Address Validation Street Level` JSON Developer Guide

July 10, 2017

Chapter 3: JSON Examples
XAVRequest
{
"UPSSecurity": {
"UsernameToken": {
"Username": "Your Username",
"Password": "Your Password"
},
"ServiceAccessToken": {
"AccessLicenseNumber": "Your Access License Number"
}
},
"XAVRequest": {
"Request": {
"RequestOption": "1",
"TransactionReference": {
"CustomerContext": "Your Customer Context"
}
},
"MaximumListSize": "10",
"AddressKeyFormat": {
"ConsigneeName": "Consignee Name",
"BuildingName": "Building Name",
"AddressLine": "12380 Morris Road",
"PoliticalDivision2": "Alpharetta",
"PoliticalDivision1": "GA",
"PostcodePrimaryLow": "30009",
"CountryCode": "US"
}
}
}

Address Validation Street Level` JSON Developer Guide

July 10, 2017

XAVResponse
{
"XAVResponse": {
"Response": {
"ResponseStatus": {
"Code": "1",
"Description": "Success"
},
"TransactionReference": {
"CustomerContext": "Your Customer Context"
}
},
"ValidAddressIndicator": "",
"Candidate": {
"AddressKeyFormat": {
"AddressLine": "12380 MORRIS RD",
"PoliticalDivision2": "ALPHARETTA",
"PoliticalDivision1": "GA",
"PostcodePrimaryLow": "30005",
"PostcodeExtendedLow": "4177",
"Region": "ALPHARETTA GA 30005-4177",
"CountryCode": "US"
}
}
}
}

Address Validation Street Level` JSON Developer Guide

July 10, 2017

Appendix
JSON Error Codes
Code
1

Description
Unrecognized Error
Any error, other than those listed below, causing an issue with the request.
 Verify the request headers are correct.
 Retry the request again later

Unknown Operation
The UPS system does not understand the operation and is unable to forward the request to the
correct API.
 Verify the request headers are correct.
 Check request structure.

Network Error
Transient error indicating the network is hindering request submission.
 Retry the request again later.

JSON Syntax Error
Indicates a problem with the JSON syntax.
 Verify your request syntax is correct.

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : Yes
Encryption                      : Standard V2.3 (128-bit)
User Access                     : Print, Copy, Extract, Print high-res
Page Count                      : 9
Language                        : en-US
Tagged PDF                      : Yes
XMP Toolkit                     : 3.1-701
Producer                        : Microsoft® Word 2013
Creator Tool                    : Microsoft® Word 2013
Create Date                     : 2017:06:09 09:38:45-04:00
Modify Date                     : 2017:06:09 09:46:49-04:00
Creator                         : HSR0WZQ
Author                          : HSR0WZQ

EXIF Metadata provided by EXIF.tools

Address Validation Street Level JSON Developer Guide

Navigation menu

Versions of this User Manual:

Views

Navigation