Output Field Name | Description |
---|---|
| Contains codes that represent the results of processing. Indicates if the data was successfully validated or corrected, such as V4 for valid address. |
tns_StatusCode_OUT | Contains codes that represent the status of processing addresses, such as 100 to indicate no errors occurred. |
tns_StatusMessage_OUT | Contains address status messages that correlate to the address status codes. |
ResultPercentage_OUT | Contains percentages that indicate how similar the output address is to the source address. 100% indicates an exact match. |
ElementResultStatus_OUT | Contains codes that describe the results of processing for each address element. The codes indicate how each address element was validated or corrected. |
ElementRelevance_OUT | Contains the following codes that indicate the relevance of the address data to the ability of the postal agency to deliver to the address:
The address element that each code represents is based on the position in the combined return value. |
Process Status Code | Description |
---|---|
C4 | All postal elements have been checked. |
C3 | Some elements could not be checked. |
C2 | Delivery status is unclear due to lack of reference data. |
C1 | Delivery status is unclear because user standardization was wrong. Not set by validation. |
I4 | Data could not be corrected completely, but is likely to be deliverable. There is a single match on a single reference. |
I3 | Data could not be corrected completely, but is likely to be deliverable. There are multiple matches on multiple references. |
I2 | Data could not be corrected, but there is a slight chance that the address is deliverable. |
I1 | Data could not be corrected. It is unlikely to be delivered. |
N2 | Required reference data is not available. |
N1 | The country was not recognized. |
Q3 | Suggestions are available. Complete address. |
Q2 | Suggested address is complete but includes elements copied from the input address. |
Q1 | Suggested address is not complete. Enter more information. |
Q0 | Insufficient information provided to generate suggestions. |
S4 | Parsed perfectly. |
S3 | Parsed with multiple results. |
S2 | Parsed with errors. Elements change position. |
S1 | Parse Error. Input format mismatch. |
V4 | Input data is correct. All postal elements were checked. Input matched perfectly. |
V3 | Input data is correct, but some or all elements were standardized. Or input contains outdated names or exonyms. |
V2 | Input data is correct, but some elements could not be checked because of incomplete reference data. |
V1 | Input data is correct, but the user standardization has deteriorated deliverability. Not set by validation. |
W9 | Error. Address was not processed. |
W8 | Timeout. Address was not processed. |
W7 | Input error. Parameters or input data rejected. |
W1 | Not allowed. No transactions for this country. |
Status Code | Status Message | Additional Information |
---|---|---|
100 | Ok. | No errors occurred. |
200 | Parameters must be supplied. | The parameters element is missing. |
201 | Invalid ParameterEX Name <name>. | |
202 | Invalid Parameter ProcessMode <value>. | |
203 | Invalid Parameter MatchingAlternatives <value>. | |
204 | Invalid Parameter MatchingScope <value>. | |
205 | Invalid Parameter FormatDelimeter <value>. | |
206 | Invalid Parameter CountryType <value>. | |
207 | Invalid Parameter PreferredScript <value>. | |
208 | Invalid Parameter PreferredLanguage <value>. | |
209 | Invalid Parameter GlobalCasing <value>. | |
210 | Invalid Parameter FormatType <value>. | |
290 | Invalid Standardize Element <value>. | |
291 | Invalid Standardize Casing <value>. | |
300 | Addresses must be supplied. | The address element is missing. |
301 | Addresses must contain at least one element. | |
302 | Addresses must contain no more than 10 elements for ProcessMode <value>. | |
303 | Addresses must contain exactly one element for ProcessMode <value>. | |
400 | Enrichments not supported for ProcessMode <value>. | |
500 | Authentication failed. | The transactions for the requested ProcessMode have expired. |
501 | Insufficient transactions. | The transactions for the requested ProcessMode have been used up. |
900 | Server error. | An unexpected error has occurred and no details are available. |
901 | Webservice is currently not available. | Try running the task again at another time. |
Position | Description |
---|---|
1 | Postal code level 0. In the United States, this is the five-digit postal code. |
2 | Postal code level 1. In the United States, this is the nine-digit postal code, the five-digit postal code with the additional 4-digit postal code. |
3 | Locality level 0. In the United States, this is the first number in the additional 4-digit postal code. |
4 | Locality level 1. In the United States, this is the second number in the additional 4-digit postal code. |
5 | Province level 0. In the United States, this is the third number in the additional 4-digit postal code. |
6 | Province level 1. In the United States, this is the fourth number in the additional 4-digit postal code. |
7 | Street level 0. |
8 | Street level 1. For example, dependent streets. |
9 | House number level 0. |
10 | House number level 1. |
11 | Delivery service level 0. For example, post office box numbers. |
12 | Delivery service level 1. |
13 | Building level 0. |
14 | Building level 1. |
15 | Sub-building level 0. |
16 | Sub-building level 1. |
17 | Organization level 0. |
18 | Organization level 1. |
19 | Country level 0. |
20 | Country level 1. For example, territory. |
Element Result Status Code | Description |
---|---|
0 | Empty |
1 | Not validated and not changed. Source data is copied. |
2 | Not validated but standardized. |
3 | Validated but not changed due to invalid input. The number may be out of valid range. Source data is copied, not corrected. This code is used only in batch mode. |
4 | Validated but not corrected due to lack of reference data. |
5 | Validated but not corrected due to multiple matches. |
6 | Validated and changed by eliminating the input value. |
7 | Validated and changed due to correction by reference data. |
8 | Validated and changed by adding value based on reference data. |
9 | Validated, not changed, but delivery status is unclear. |
C | Validated, verified, but changed due to outdated name. |
D | Validated, verified, but changed from exonym to official name. |
E | Validated, verified, but changed due to standardization based on casing or language. This code is only used if source data fully matches a language alternative. |
F | Validated, verified, and not changed due to perfect match. |
Element Result Status Code for Country | Description |
---|---|
0 | Empty |
1 | Country not recognized. |
4 | Country recognized from default country setting. |
5 | Country not recognized - multiple matches. |
6 | Country recognized from script. |
7 | Country recognized from format. |
8 | Country recognized from major town. |
9 | Country recognized from province. |
C | Country recognized from territory. |
D | Country recognized from name with errors. |
E | Country recognized from name without errors. |
F | Country recognized from force country setting. |
Field | Description |
---|---|
CassStatus | Certification status |
CassErrorCode | Certification error code |
Cass<address_data> | Additional certification fields |
Field | Description |
---|---|
AmasStatus | Certification status |
AmasErrorCode | Certification error code |
AmasRecordType | Certification record type |
Amas<address_data> | Additional certification fields |
Field | Description |
---|---|
SerpStatus | Certification Status. The field can include the following status codes:
|
SerpCategory | Certification category |
SerpExcludedFlag | Certification excluded flag. Indicates a PoCAD address with the wrong user input. |
Field | Description |
---|---|
SnaStatus | Certification Status |
SnaCategory | Certification category |