-
Notifications
You must be signed in to change notification settings - Fork 19
/
AddressValidation.yaml
753 lines (734 loc) · 26 KB
/
AddressValidation.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
openapi: 3.0.3
info:
title: Address Validation - Street Level
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
The Address Validation Street Level API can be used to.
check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico.
- <a href="https://developer.ups.com/api/reference/addressvalidation/business-rules" target="_blank" rel="noopener">Business Rules</a>
- <a href="https://developer.ups.com/api/reference/addressvalidation/errors" target="_blank" rel="noopener">Errors</a>
- <a href="https://developer.ups.com/api/reference/addressvalidation/faq" target="_blank" rel="noopener">FAQ</a>
- <a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">GitHub - view sample integration code</a>
<a href="https://god.gw.postman.com/run-collection/29542085-f2cd7176-bd05-48ea-bb72-b359a11cff09?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-f2cd7176-bd05-48ea-bb72-b359a11cff09%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">
</a>
servers:
- url: https://wwwcie.ups.com/api
description: Customer Integration Environment
- url: https://onlinetools.ups.com/api
description: Production
paths:
"/addressvalidation/{version}/{requestoption}":
post:
summary: Address Validation
tags:
- Address Validation
security:
- OAuth2: []
description: The Address Validation Street Level API can be used to check addresses
against the United States Postal Service database of valid addresses in the
U.S. and Puerto Rico.
operationId: AddressValidation
parameters:
- in: query
name: regionalrequestindicator
schema:
type: string
minimum: 1
description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
- in: query
name: maximumcandidatelistsize
schema:
type: integer
minimum: 1
description: "Valid values: 0 – 50 The maximum number of Candidates to return
for this request. If not provided, the default size of 15 is returned."
required: false
- in: path
name: requestoption
schema:
type: integer
minimum: 1
description: |
Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back.
Valid values:
- 1 - Address Validation
- 2 - Address Classification
- 3 - Address Validation and Address Classification.
For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix.
required: true
- in: path
name: version
schema:
type: string
minimum: 1
default: v2
description: |
Identifies the version of the API.
Valid values:
- v2
required: true
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
XAVRequest:
AddressKeyFormat:
ConsigneeName: RITZ CAMERA CENTERS-1749
BuildingName: Innoplex
AddressLine:
- 26601 ALISO CREEK ROAD
- STE D
- ALISO VIEJO TOWN CENTER
Region: ROSWELL,GA,30076-1521
PoliticalDivision2: ALISO VIEJO
PoliticalDivision1: CA
PostcodePrimaryLow: '92656'
PostcodeExtendedLow: '1521'
Urbanization: porto arundal
CountryCode: US
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"/addressvalidation/{deprecatedVersion}/{requestoption}":
post:
deprecated: true
summary: Address Validation
tags:
- Address Validation
security:
- OAuth2: []
description: The Address Validation Street Level API can be used to check addresses
against the United States Postal Service database of valid addresses in the
U.S. and Puerto Rico.
operationId: DeprecatedAddressValidation
parameters:
- in: query
name: regionalrequestindicator
schema:
type: string
minimum: 1
description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
- in: query
name: maximumcandidatelistsize
schema:
type: integer
minimum: 1
description: "Valid values: 0 – 50 The maximum number of Candidates to return
for this request. If not provided, the default size of 15 is returned."
required: false
- in: path
name: requestoption
schema:
type: integer
minimum: 1
description: |
Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back.
Valid values:
- 1 - Address Validation
- 2 - Address Classification
- 3 - Address Validation and Address Classification.
For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix.
required: true
- in: path
name: deprecatedVersion
schema:
type: string
minimum: 1
default: v1
description: |
Identifies the version of the API.
Valid values:
- v1
required: true
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
value:
XAVRequest:
AddressKeyFormat:
ConsigneeName: RITZ CAMERA CENTERS-1749
BuildingName: Innoplex
AddressLine:
- 26601 ALISO CREEK ROAD
- STE D
- ALISO VIEJO TOWN CENTER
Region: ROSWELL,GA,30076-1521
PoliticalDivision2: ALISO VIEJO
PoliticalDivision1: CA
PostcodePrimaryLow: '92656'
PostcodeExtendedLow: '1521'
Urbanization: porto arundal
CountryCode: US
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
"$ref": "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
type: oauth2
description: |
Find your Client ID and Secret on your app info page.
1. Select \"Try It\"
2. In the Security section enter your Client ID and Secret.
3. Select \"Request Token\"
4. Enter any additional information in the Body and Parameters sections.
5. Select \"Send\" to execute your API request
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token
scopes: {}
schemas:
XAVRequestWrapper:
xml:
name: XAVRequest
description: 'N/A '
maximum: 1
type: object
required:
- XAVRequest
properties:
XAVRequest:
"$ref": "#/components/schemas/XAVRequest"
XAVResponseWrapper:
xml:
name: XAVResponse
description: 'N/A '
maximum: 1
type: object
required:
- XAVResponse
properties:
XAVResponse:
"$ref": "#/components/schemas/XAVResponse"
XAVRequest:
type: object
required:
- AddressKeyFormat
- Request
properties:
Request:
"$ref": "#/components/schemas/XAVRequest_Request"
RegionalRequestIndicator:
description: >
If this indicator is present then either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation in
addition to the urbanization element. If this tag is present, US and
PR street level address validation will not occur. The default is to
provide street level address validation. Not valid with the address
classification request option.
maximum: 1
type: string
MaximumCandidateListSize:
description: |
The maximum number of Candidates to return for this request.
- Valid values: 0 - 50
- Default: 15
maximum: 1
type: string
minLength: 1
maxLength: 2
AddressKeyFormat:
"$ref": "#/components/schemas/XAVRequest_AddressKeyFormat"
xml:
name: XAVRequest
maximum: 1
description: ''
XAVRequest_Request:
type: object
maximum: 1
properties:
SubVersion:
description: Not Used.
maximum: 1
type: string
minLength: 4
maxLength: 4
RequestOption:
description: |
Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back.
Valid values:
- 1 - Address Validation
- 2 - Address Classification
- 3 - Address Validation and Address Classification.
For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix.
maximum: 1
type: string
minLength: 1
maxLength: 1
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
required:
- RequestOption
description: XAV Request Container.
Request_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
XAVRequest_AddressKeyFormat:
type: object
maximum: 1
properties:
ConsigneeName:
description: Name of business, company or person. Ignored if user selects the RegionalRequestIndicator.
maximum: 1
type: string
minLength: 1
maxLength: 40
AttentionName:
description: Name of the building. Ignored if user selects the RegionalRequestIndicator.
maximum: 1
type: string
minLength: 1
maxLength: 40
AddressLine:
description: Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator.
type: array
maximum: 3
minLength: 1
maxLength: 100
items:
type: string
Region:
description: |
If this node is present the following tags will be ignored:
- Political Division 2
- Political Division 1
- PostcodePrimaryLow
- PostcodeExtendedLow
Valid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
maximum: 1
type: string
minLength: 1
maxLength: 100
PoliticalDivision2:
description: City or Town name.
maximum: 1
type: string
minLength: 1
maxLength: 30
PoliticalDivision1:
description: State or Province/Territory name.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostcodePrimaryLow:
description: Postal Code.
maximum: 1
type: string
minLength: 1
maxLength: 10
PostcodeExtendedLow:
description: 4 digit Postal Code extension. For US use only.
maximum: 1
type: string
minLength: 1
maxLength: 10
Urbanization:
description: Puerto Rico Political Division 3. Only Valid for Puerto Rico.
maximum: 1
type: string
minLength: 1
maxLength: 30
CountryCode:
description: Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: AddressKeyFormat
required:
- CountryCode
description: |-
AddressKeyFormat container.
The Key format is based on addressing standards jointly developed by the Postal Service and mailing industry. The information provided in the Address Key container will be returned in the same format.
XAVResponse:
type: object
required:
- Response
properties:
Response:
"$ref": "#/components/schemas/XAVResponse_Response"
ValidAddressIndicator:
description: Indicates query found a valid match.
maximum: 1
type: string
AmbiguousAddressIndicator:
description: Indicates query could not find exact match. Candidate list
follows.
maximum: 1
type: string
NoCandidatesIndicator:
description: No Candidate found.
maximum: 1
type: string
AddressClassification:
"$ref": "#/components/schemas/XAVResponse_AddressClassification"
Candidate:
description: |
Candidate Container.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/XAVResponse_Candidate"
xml:
name: XAVResponse
maximum: 1
description: XAV Response Container.
XAVResponse_Response:
type: object
required:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
maximum: 1
Response_ResponseStatus:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |-
Identifies the success or failure of the transaction. Valid values:
1 = Success
0 = Failure
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns text of 'Success'
or 'Failure'.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response Status Container.
Response_Alert:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Warning code returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 10
Description:
description: Warning messages returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: Alert
Response_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container.
XAVResponse_AddressClassification:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
Contains the classification code of the input address.
Valid values:
- 0 - UnClassified
- 1 - Commercial
- 2 - Residential
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: "Contains the text description of the address classification code: UnClassified, Commercial, Residential"
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: AddressClassification
description: AddressClassification Container.
XAVResponse_Candidate:
type: object
properties:
AddressClassification:
"$ref": "#/components/schemas/Candidate_AddressClassification"
AddressKeyFormat:
"$ref": "#/components/schemas/Candidate_AddressKeyFormat"
xml:
name: Candidate
required:
- AddressKeyFormat
maximum: 1
Candidate_AddressClassification:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |-
Contains the classification code of the address:
0 - UnClassified
1 - Commercial
2 - Residential
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Contains the text description of the address classification
code (see Code above).
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: AddressClassification
description: AddressClassification Container.
Candidate_AddressKeyFormat:
type: object
maximum: 1
properties:
ConsigneeName:
description: Name of business, company or person. Not returned if user selects
the RegionalRequestIndicator.
maximum: 1
type: string
minLength: 1
maxLength: 40
AttentionName:
description: Name of building. Not returned if user selects the RegionalRequestIndicator.
maximum: 1
type: string
minLength: 1
maxLength: 40
AddressLine:
description: "Address line (street number, street name and street type,
and political division 1, political division 2 and postal code) used for
street level information. Additional secondary information (apartment,
suite, floor, etc.) Applicable to US and PR only. Not returned if user
selects the RegionalRequestIndicator."
type: array
maximum: 3
minLength: 1
maxLength: 100
items:
type: string
Region:
description: Single entry containing in this order Political Division 2,
Political Division 1 and Post Code Primary Low and/or PostcodeExtendedLow.
maximum: 1
type: string
minLength: 1
maxLength: 100
PoliticalDivision2:
description: City or Town name.
maximum: 1
type: string
minLength: 1
maxLength: 30
PoliticalDivision1:
description: "State/Province. Returned if the location is within a State/Province/Territory.
For International: returned if user enters valid Country or Territory
Code, and City/postal code and it has a match. For Domestic addresses,
the value must be a valid 2-character value (per US Mail standards). For
International the full State or Province name will be returned."
maximum: 1
type: string
minLength: 1
maxLength: 30
PostcodePrimaryLow:
description: Low-end Postal Code. Returned for countries or territories
with Postal Codes. May be alphanumeric.
maximum: 1
type: string
minLength: 1
maxLength: 10
PostcodeExtendedLow:
description: "Low-end extended postal code in a range. Example in quotes:
Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric"
maximum: 1
type: string
minLength: 1
maxLength: 10
Urbanization:
description: Puerto Rico Political Division 3. Only Valid for Puerto Rico.
maximum: 1
type: string
minLength: 1
maxLength: 30
CountryCode:
description: A country or territory code. Required to be returned.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: AddressKeyFormat
required:
- CountryCode
description: AddressKeyFormat Container.
ErrorResponse:
type: object
properties:
response:
"$ref": "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
properties:
errors:
type: array
description: The error array containing any errors that occurred.
items:
"$ref": "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
code:
type: string
description: The error code.
message:
type: string
description: The error message.
description: The error response containing any errors that occurred.