Reference Guide#
Introduction#
Contact data will deteriorate over time as people and businesses move around. SmartMover will allow you to keep that data up to date, both maintaining and confirming accuracy. The SmartMover Cloud Service is able to validate and standardize addresses, detect moves, and provide an updated address for an individual or business. SmartMover is available for both the US and Canada using data from the USPS and Canada Post respectively.
Base URL#
https://smartmover.melissadata.net
https://smartmovercanada.melissadata.net
Licensing#
The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Smart Mover will not function.
To set the license key, use the id/CustomerID property in your requests.
USPS® NCOA Processing Acknowledgement Form (PAF)#
Melissa Data will require PAF documents filed once a year for customers who are:
The End User/List Owner: Processes a list for their own private use – Only needs to submit one PAF.
Processes lists for multiple clients – Needs to submit a PAF for each client (list owner) and will also need to include how many records will be submitted per file, per customer email address._
Endpoints#
US: https://smartmover.melissadata.net/V3/WEB/SmartMover#
Check a move with a name and address.
Check if the business has changed locations.
Try It Now#
curl -X GET "https://smartmover.melissadata.net/V3/WEB/SmartMover/doSmartMover?\
&id={{customerId}}\
&pafid={{pafId}}\
&t=Test\
&a1=22382%20Avenida%20Empresa\
&city=Rancho%20Santa%20Margarita\
&comp=Melissa\
&ctry=US\
&full=Ray%20Melissa\
&postal=92688\
&state=CA" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X POST "https://smartmover.melissadata.net/V3/WEB/SmartMover/doSmartMover" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"Actions": "NCOA",
"Columns": "",
"CustomerID": "{{customerId}}",
"ExecutionID": "Batch_1",
"Format": "json",
"JobID": "",
"Options": "",
"OptSmartMoverListName": "",
"PAFId": "{{pafId}}",
"Records":
[{
"AddressLine1": "22382 Avenida Empresa",
"AddressLine2": "",
"City": "Rancho Santa Margarita",
"Company": "Melissa",
"Country": "US",
"NameFirst": "",
"NameFull": "Ray Melissa",
"NameLast": "",
"NameMiddle": "",
"NamePrefix": "",
"NameSuffix": "",
"Plus4": "",
"PostalCode": "92688",
"PrivateMailbox": "",
"RecordID": "1",
"State": "CA",
"Suite": "",
"Urbanization": ""
}],
"TransmissionReference": "Test"
}'
curl -X GET "https://smartmover.melissadata.net/V3/WEB/SmartMover/doSmartMover?\
&id={{customerId}}\
&pafid={{pafId}}\
&t=Test\
&a1=22382%20Avenida%20Empresa\
&city=Rancho%20Santa%20Margarita\
&comp=Melissa\
&ctry=US\
&full=Ray%20Melissa\
&postal=92688\
&state=CA" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml"
curl -X POST "https://smartmover.melissadata.net/V3/WEB/SmartMover/doSmartMover" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml" \
-d '<Request>
<Actions></Actions>
<Columns></Columns>
<CustomerID>{{customerId}}</CustomerID>
<JobID></JobID>
<Options></Options>
<OptSmartMoverListName></OptSmartMoverListName>
<PAFId>{{pafId}}</PAFId>
<Records>
<RequestRecord>
<AddressLine1>22382 Avenida Empresa</AddressLine1>
<AddressLine2></AddressLine2>
<City>Rancho Santa Margarita</City>
<Company></Company>
<Country></Country>
<NameFirst></NameFirst>
<NameFull></NameFull>
<NameLast></NameLast>
<NameMiddle></NameMiddle>
<NamePrefix></NamePrefix>
<NameSuffix></NameSuffix>
<Plus4></Plus4>
<PostalCode>92688</PostalCode>
<PrivateMailbox></PrivateMailbox>
<RecordID></RecordID>
<State>CA</State>
<Suite></Suite>
<Urbanization></Urbanization>
</RequestRecord>
</Records>
<TransmissionReference>Test</TransmissionReference>
</Request>'
Request Parameters#
Minimum Inputs#
The following are the possible minimum input requirements.
NameFirst and NameLast, NameFull, or Company
Address Only
City and State, ZIP, or AddressLastLine
Code |
Description |
||||
---|---|---|---|---|---|
Request Level Parameters |
|||||
|
Selects which COA objects to be used in the request. For US Change of Address Object, use |
||||
|
The column names or groups to be output. See Columns for more information. |
||||
|
The desired format of the response. |
||||
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
||||
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
||||
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
||||
|
|||||
|
Only applies for Broker accounts and not to CCOA. For Smartmover Brokers with their own set of end users, use the PAF ID to identify which end user this record belongs to. |
||||
|
Optional. Serves as a unique request identifier. |
||||
Record Level Parameters |
|||||
|
A minimum address location for the name / company contact. |
||||
|
The second address line. |
||||
|
The city name. |
||||
|
The name of the business. |
||||
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
||||
|
The parsed first name of an individual. |
||||
|
The full name of an individual. Required unless parsed name inputs are used. |
||||
|
The parsed last name of an individual. |
||||
|
The parsed middle name of an individual. |
||||
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
||||
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
||||
|
The last four digits of a ZIP+4. |
||||
|
The private mailbox number, if this address is a box in a private mailbox service. |
||||
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
||||
|
The state name. |
||||
|
The suite number. |
||||
|
Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code. |
Code |
Description |
||||
---|---|---|---|---|---|
Request Level Parameters |
|||||
|
Selects which COA objects to be used in the request. For US Change of Address Object, use |
||||
|
The column names or groups to be output. See Columns for more information. |
||||
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
||||
|
In rare situations you may run into a situation where a request will be time-out by a client but finished on the server. The client then resends the same request but the server believes it is another request. So, that can result in the same record counting twice on the NCOA and CCOA report. To account for that possibility, we have the Execution ID input. We will take a hash of the input and if the hash of the current input is identical to the previous input with the same ExecutionID, we will consider it a duplicate and not count it towards the report. Specify different values for different threads. Default value is |
||||
|
The desired format of the response. |
||||
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
||||
|
|||||
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
||||
|
Only applies for Broker accounts and not to CCOA. For Smartmover Brokers with their own set of end users, use the PAF ID to identify which end user this record belongs to. |
||||
|
Optional. Serves as a unique request identifier. |
||||
Record Level Parameters |
|||||
|
A minimum address location for the name / company contact. |
||||
|
The second address line. |
||||
|
The city name. |
||||
|
The name of the business. |
||||
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
||||
|
The parsed first name of an individual. |
||||
|
The full name of an individual. Required unless parsed name inputs are used. |
||||
|
The parsed last name of an individual. |
||||
|
The parsed middle name of an individual. |
||||
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
||||
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
||||
|
The last four digits of a ZIP+4. |
||||
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
||||
|
The private mailbox number, if this address is a box in a private mailbox service. |
||||
|
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted. |
||||
|
The state name. |
||||
|
The suite number. |
||||
|
Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code. |
Code |
Description |
||||
---|---|---|---|---|---|
Request Level Parameters |
|||||
|
Selects which COA objects to be used in the request. For US Change of Address Object, use |
||||
|
The column names or groups to be output. See Columns for more information. |
||||
|
The desired format of the response. |
||||
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
||||
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
||||
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
||||
|
|||||
|
Only applies for Broker accounts and not to CCOA. For Smartmover Brokers with their own set of end users, use the PAF ID to identify which end user this record belongs to. |
||||
|
Optional. Serves as a unique request identifier. |
||||
Record Level Parameters |
|||||
|
A minimum address location for the name / company contact. |
||||
|
The second address line. |
||||
|
The city name. |
||||
|
The name of the business. |
||||
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
||||
|
The parsed first name of an individual. |
||||
|
The full name of an individual. Required unless parsed name inputs are used. |
||||
|
The parsed last name of an individual. |
||||
|
The parsed middle name of an individual. |
||||
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
||||
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
||||
|
The last four digits of a ZIP+4. |
||||
|
The private mailbox number, if this address is a box in a private mailbox service. |
||||
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
||||
|
The state name. |
||||
|
The suite number. |
||||
|
Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code. |
Code |
Description |
||||
---|---|---|---|---|---|
Request Level Parameters |
|||||
|
Selects which COA objects to be used in the request. For US Change of Address Object, use |
||||
|
The column names or groups to be output. See Columns for more information. |
||||
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
||||
|
In rare situations you may run into a situation where a request will be time-out by a client but finished on the server. The client then resends the same request but the server believes it is another request. So, that can result in the same record counting twice on the NCOA and CCOA report. To account for that possibility, we have the Execution ID input. We will take a hash of the input and if the hash of the current input is identical to the previous input with the same ExecutionID, we will consider it a duplicate and not count it towards the report. Specify different values for different threads. Default value is |
||||
|
The desired format of the response. |
||||
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
||||
|
|||||
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
||||
|
Only applies for Broker accounts and not to CCOA. For Smartmover Brokers with their own set of end users, use the PAF ID to identify which end user this record belongs to. |
||||
|
Optional. Serves as a unique request identifier. |
||||
Record Level Parameters |
|||||
|
A minimum address location for the name / company contact. |
||||
|
The second address line. |
||||
|
The city name. |
||||
|
The name of the business. |
||||
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
||||
|
The parsed first name of an individual. |
||||
|
The full name of an individual. Required unless parsed name inputs are used. |
||||
|
The parsed last name of an individual. |
||||
|
The parsed middle name of an individual. |
||||
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
||||
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
||||
|
The last four digits of a ZIP+4. |
||||
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
||||
|
The private mailbox number, if this address is a box in a private mailbox service. |
||||
|
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted. |
||||
|
The state name. |
||||
|
The suite number. |
||||
|
Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code. |
Options#
List options in the following format, with multiple options delimited with a ,
.
OptionName:Parameter,OptionName:Parameter
ListOwnerFreqProcessing#
This option accepts a value from 1
to 52
.
This is the number of times per year the current mailing list is used for mailing.
E.g., for monthly use 12
, for quarterly use 4
.
Parameter |
Description |
---|---|
|
Times per year list is used for mailing. |
NumberofMonthsRequested#
This option accepts a value from 6
to 48
.
This is the number of months back you want to search for a change of address.
Parameter |
Description |
---|---|
|
Number of months back to search for address change. |
ProcessingType#
The processing type.
Parameter |
Description |
|||
---|---|---|---|---|
|
Matches with businesses only. Omits individual and family matches. |
|||
|
Matches with individuals only. Omits business and family matches. |
|||
|
Matches individuals and businesses only. Omits family matches. |
|||
|
Matches with individual and family matches. Omits business matches. |
|||
|
Matches in the following order:
|
|||
|
Matches in the following order:
|
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: */*
Content-Type: application/xml
Accept: */*
Response#
{
"CASSReportLink": "JobId required to generate summary report links...",
"NCOAReportLink": "JobId required to generate summary report links...",
"Records":
[{
"AddressExtras": "",
"AddressKey": "92688211282",
"AddressLine1": "22382 Avenida Empresa",
"AddressLine2": "",
"AddressTypeCode": "S",
"BaseMelissaAddressKey": "",
"CarrierRoute": "C057",
"City": "Rancho Santa Margarita",
"CityAbbreviation": "Rcho Sta Marg",
"CompanyName": "Melissa",
"CountryCode": "US",
"CountryName": "United States",
"DeliveryIndicator": "B",
"DeliveryPointCheckDigit": "1",
"DeliveryPointCode": "82",
"MelissaAddressKey": "8008006245",
"MoveEffectiveDate": "",
"MoveTypeCode": "",
"PostalCode": "92688-2112",
"RecordID": "",
"Results": "AS01,CS02",
"State": "CA",
"StateName": "California",
"Urbanization": ""
}],
"TotalRecords": "1",
"TransmissionReference": "Test",
"TransmissionResults": "",
"Version": "7.4.1.4198"
}
{
"CASSReportLink": "JobId required to generate summary report links...",
"NCOAReportLink": "JobId required to generate summary report links...",
"Records":
[{
"AddressExtras": "",
"AddressKey": "92688211282",
"AddressLine1": "22382 Avenida Empresa",
"AddressLine2": "",
"AddressTypeCode": "S",
"BaseMelissaAddressKey": "",
"CarrierRoute": "C057",
"City": "Rancho Santa Margarita",
"CityAbbreviation": "Rcho Sta Marg",
"CompanyName": "Melissa",
"CountryCode": "US",
"CountryName": "United States",
"DeliveryIndicator": "B",
"DeliveryPointCheckDigit": "1",
"DeliveryPointCode": "82",
"MelissaAddressKey": "8008006245",
"MoveEffectiveDate": "",
"MoveTypeCode": "",
"PostalCode": "92688-2112",
"RecordID": "1",
"Results": "AS01,CS02",
"State": "CA",
"StateName": "California",
"Urbanization": ""
}],
"TotalRecords": "1",
"TransmissionReference": "Test",
"TransmissionResults": "",
"Version": "7.4.1.4198"
}
<Response xmlns="urn:mdSmartMover" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CASSReportLink>JobId required to generate summary report links...</CASSReportLink>
<NCOAReportLink>JobId required to generate summary report links...</NCOAReportLink>
<Records>
<ResponseRecord>
<AddressExtras />
<AddressKey>92688211282</AddressKey>
<AddressLine1>22382 Avenida Empresa</AddressLine1>
<AddressLine2 />
<AddressTypeCode>S</AddressTypeCode>
<BaseMelissaAddressKey />
<CarrierRoute>C057</CarrierRoute>
<City>Rancho Santa Margarita</City>
<CityAbbreviation>Rcho Sta Marg</CityAbbreviation>
<CompanyName>Melissa</CompanyName>
<CountryCode>US</CountryCode>
<CountryName>United States</CountryName>
<DeliveryIndicator>B</DeliveryIndicator>
<DeliveryPointCheckDigit>1</DeliveryPointCheckDigit>
<DeliveryPointCode>82</DeliveryPointCode>
<MelissaAddressKey>8008006245</MelissaAddressKey>
<MoveEffectiveDate />
<MoveTypeCode />
<PostalCode>92688-2112</PostalCode>
<RecordID />
<Results>AS01,CS02</Results>
<State>CA</State>
<StateName>California</StateName>
<Urbanization />
</ResponseRecord>
</Records>
<TotalRecords>1</TotalRecords>
<TransmissionReference>Test</TransmissionReference>
<TransmissionResults />
<Version>7.4.1.4198</Version>
</Response>
<Response xmlns="urn:mdSmartMover" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CASSReportLink>JobId required to generate summary report links...</CASSReportLink>
<NCOAReportLink>JobId required to generate summary report links...</NCOAReportLink>
<Records>
<ResponseRecord>
<AddressExtras />
<AddressKey>92688211282</AddressKey>
<AddressLine1>22382 Avenida Empresa</AddressLine1>
<AddressLine2 />
<AddressTypeCode>S</AddressTypeCode>
<BaseMelissaAddressKey />
<CarrierRoute>C057</CarrierRoute>
<City>Rancho Santa Margarita</City>
<CityAbbreviation>Rcho Sta Marg</CityAbbreviation>
<CompanyName />
<CountryCode>US</CountryCode>
<CountryName>United States</CountryName>
<DeliveryIndicator>B</DeliveryIndicator>
<DeliveryPointCheckDigit>1</DeliveryPointCheckDigit>
<DeliveryPointCode>82</DeliveryPointCode>
<MelissaAddressKey>8008006245</MelissaAddressKey>
<MoveEffectiveDate />
<MoveTypeCode />
<PostalCode>92688-2112</PostalCode>
<RecordID />
<Results>AS01,CS02</Results>
<State>CA</State>
<StateName>California</StateName>
<Urbanization />
</ResponseRecord>
</Records>
<TotalRecords>1</TotalRecords>
<TransmissionReference>Test</TransmissionReference>
<TransmissionResults />
<Version>7.4.1.4198</Version>
</Response>
Canada: https://smartmovercanada.melissadata.net/V3/WEB/SmartMover#
Check a move with a name and address.
Check if the business has changed locations.
Try It Now#
curl -X GET "https://smartmovercanada.melissadata.net/V3/WEB/SmartMover/doSmartMover?\
&act=\
&cols=\
&format=json\
&id={{customerId}}\
&jobid=001\
&list=\
&opt=\
&t=Test\
&a1=80%20Wellington%20St%2E\
&city=Ottawa\
&comp=\
&ctry=CA\
&full=Prime%20Minister%20of%20Canada\
&plus4=\
&postal=K1P%205K9\
&state=ON" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X POST "https://smartmovercanada.melissadata.net/V3/WEB/SmartMover/doSmartMover" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"Actions": "",
"Columns": "",
"CustomerID": "{{customerId}}",
"Format": "json",
"JobID": "001",
"Options": "",
"OptSmartMoverListName": "",
"Records":
[{
"AddressLine1": "80 Wellington St.",
"City": "Ottawa",
"Company": "",
"Country": "CA",
"NameFull": "Prime Minister of Canada",
"Plus4": "",
"PostalCode": "K1P 5K9",
"RecordID": "1",
"State": "ON"
}],
"TransmissionReference": "Test"
}'
curl -X GET "https://smartmovercanada.melissadata.net/V3/WEB/SmartMover/doSmartMover?\
&act=\
&cols=\
&format=xml\
&id={{customerId}}\
&jobid=001\
&list=\
&opt=\
&t=Test\
&a1=80%20Wellington%20St%2E\
&city=Ottawa\
&comp=\
&ctry=CA\
&full=Prime%20Minister%20of%20Canada\
&plus4=\
&postal=K1P%205K9\
&state=ON" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml"
curl -X POST "https://smartmovercanada.melissadata.net/V3/WEB/SmartMover/doSmartMover" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml" \
-d '<Request>
<Actions></Actions>
<Columns></Columns>
<CustomerID>{{customerId}}</CustomerID>
<Format>xml</Format>
<JobID>001</JobID>
<Options>GrpAll</Options>
<OptSmartMoverListName></OptSmartMoverListName>
<Records>
<RequestRecord>
<AddressLine1>80 Wellington St.</AddressLine1>
<City>Ottawa</City>
<Company></Company>
<Country>CA</Country>
<NameFull>Prime Minister of Canada</NameFull>
<Plus4></Plus4>
<PostalCode>K1P 5K9</PostalCode>
<RecordID>1</RecordID>
<State>ON</State>
</RequestRecord>
</Records>
<TransmissionReference>Test</TransmissionReference>
</Request>'
Request Parameters#
Minimum Inputs#
The following are the possible minimum input requirements.
NameFirst and NameLast, NameFull, or Company
Address Only
City and State, ZIP, or AddressLastLine
Code |
Description |
---|---|
Request Level Parameters |
|
|
Selects which COA objects to be used in the request. For Canadian Change of Address Object, use |
|
The column names or groups to be output. See Columns for more information. |
|
The desired format of the response. |
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
|
Optional. Serves as a unique request identifier. |
Record Level Parameters |
|
|
A minimum address location for the name / company contact. |
|
The second address line. |
|
The city name. |
|
The name of the business. |
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
|
The parsed first name of an individual. |
|
The full name of an individual. Required unless parsed name inputs are used. |
|
The parsed last name of an individual. |
|
The parsed middle name of an individual. |
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
|
The last four digits of a ZIP+4. |
|
The private mailbox number, if this address is a box in a private mailbox service. |
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
|
The state name. |
|
The suite number. |
Code |
Description |
---|---|
Request Level Parameters |
|
|
Selects which COA objects to be used in the request. For Canadian Change of Address Object, use |
|
The column names or groups to be output. See Columns for more information. |
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
|
In rare situations you may run into a situation where a request will be time-out by a client but finished on the server. The client then resends the same request but the server believes it is another request. So, that can result in the same record counting twice on the NCOA and CCOA report. To account for that possibility, we have the Execution ID input. We will take a hash of the input and if the hash of the current input is identical to the previous input with the same ExecutionID, we will consider it a duplicate and not count it towards the report. Specify different values for different threads. Default value is |
|
The desired format of the response. |
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
|
Optional. Serves as a unique request identifier. |
Record Level Parameters |
|
|
A minimum address location for the name / company contact. |
|
The second address line. |
|
The city name. |
|
The name of the business. |
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
|
The parsed first name of an individual. |
|
The full name of an individual. Required unless parsed name inputs are used. |
|
The parsed last name of an individual. |
|
The parsed middle name of an individual. |
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
|
The last four digits of a ZIP+4. |
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
|
The private mailbox number, if this address is a box in a private mailbox service. |
|
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted. |
|
The state name. |
|
The suite number. |
Code |
Description |
---|---|
Request Level Parameters |
|
|
Selects which COA objects to be used in the request. For Canadian Change of Address Object, use |
|
The column names or groups to be output. See Columns for more information. |
|
The desired format of the response. |
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
|
Optional. Serves as a unique request identifier. |
Record Level Parameters |
|
|
A minimum address location for the name / company contact. |
|
The second address line. |
|
The city name. |
|
The name of the business. |
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
|
The parsed first name of an individual. |
|
The full name of an individual. Required unless parsed name inputs are used. |
|
The parsed last name of an individual. |
|
The parsed middle name of an individual. |
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
|
The last four digits of a ZIP+4. |
|
The private mailbox number, if this address is a box in a private mailbox service. |
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
|
The state name. |
|
The suite number. |
Code |
Description |
---|---|
Request Level Parameters |
|
|
Selects which COA objects to be used in the request. For Canadian Change of Address Object, use |
|
The column names or groups to be output. See Columns for more information. |
|
This is a string value containing the License Key issued to the customer by Melissa Data for the web service. |
|
In rare situations you may run into a situation where a request will be time-out by a client but finished on the server. The client then resends the same request but the server believes it is another request. So, that can result in the same record counting twice on the NCOA and CCOA report. To account for that possibility, we have the Execution ID input. We will take a hash of the input and if the hash of the current input is identical to the previous input with the same ExecutionID, we will consider it a duplicate and not count it towards the report. Specify different values for different threads. Default value is |
|
The desired format of the response. |
|
This value will identify to the service which records belong to the same list for the purposes of the NCOA and CCOA report. All records from the same list should have the same JobID. This is NOT a database unique key, please use the RecordID field for that. |
|
Identifies the current list. It will be included in reports returned by SmartMover V3 after processing. |
|
Optional. Serves as a unique request identifier. |
Record Level Parameters |
|
|
A minimum address location for the name / company contact. |
|
The second address line. |
|
The city name. |
|
The name of the business. |
|
The country code. The SmartMover V3 web service can only update addresses within the United States. |
|
The parsed first name of an individual. |
|
The full name of an individual. Required unless parsed name inputs are used. |
|
The parsed last name of an individual. |
|
The parsed middle name of an individual. |
|
The title or honorific prefix of the name. E.g. “Mr, Miss, Dr”. |
|
The generational or professional suffix of the name. E.g. “Jr, IV, Ph.D.”. |
|
The last four digits of a ZIP+4. |
|
The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4. |
|
The private mailbox number, if this address is a box in a private mailbox service. |
|
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted. |
|
The state name. |
|
The suite number. |
Headers#
Content-Type: application/json
Accept: application/json
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: */*
Content-Type: application/xml
Accept: */*
Response#
{
"Records":
[{
"AddressExtras": "",
"AddressKey": "K1A0A2",
"AddressLine1": "80 Wellington St",
"AddressLine2": "",
"AddressTypeCode": "1",
"BaseMelissaAddressKey": "",
"CarrierRoute": "",
"City": "Ottawa",
"CityAbbreviation": "Ottawa",
"CompanyName": "",
"CountryCode": "CA",
"CountryName": "Canada",
"DeliveryIndicator": "",
"DeliveryPointCheckDigit": "",
"DeliveryPointCode": "",
"MelissaAddressKey": "8620912446",
"MoveEffectiveDate": "",
"MoveTypeCode": "",
"PostalCode": "K1A 0A2",
"RecordID": "1",
"Results": "AC01,AS01",
"State": "ON",
"StateName": "Ontario",
"Urbanization": ""
}],
"TotalRecords": "1",
"TransmissionReference": "Test",
"TransmissionResults": "",
"Version": "8.4.1.1130"
}
{
"Records":
[{
"AddressExtras": "",
"AddressKey": "K1A0A2",
"AddressLine1": "80 Wellington St",
"AddressLine2": "",
"AddressTypeCode": "1",
"BaseMelissaAddressKey": "",
"CarrierRoute": "",
"City": "Ottawa",
"CityAbbreviation": "Ottawa",
"CompanyName": "",
"CountryCode": "CA",
"CountryName": "Canada",
"DeliveryIndicator": "",
"DeliveryPointCheckDigit": "",
"DeliveryPointCode": "",
"MelissaAddressKey": "8620912446",
"MoveEffectiveDate": "",
"MoveTypeCode": "",
"PostalCode": "K1A 0A2",
"RecordID": "1",
"Results": "AC01,AS01",
"State": "ON",
"StateName": "Ontario",
"Urbanization": ""
}],
"TotalRecords": "1",
"TransmissionReference": "Test",
"TransmissionResults": "",
"Version": "8.4.1.1130"
}
<Response xmlns="urn:mdSmartMover" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Records>
<ResponseRecord>
<AddressExtras />
<AddressKey>K1A0A2</AddressKey>
<AddressLine1>80 Wellington St</AddressLine1>
<AddressLine2 />
<AddressTypeCode>1</AddressTypeCode>
<BaseMelissaAddressKey />
<CarrierRoute />
<City>Ottawa</City>
<CityAbbreviation>Ottawa</CityAbbreviation>
<CompanyName />
<CountryCode>CA</CountryCode>
<CountryName>Canada</CountryName>
<DeliveryIndicator />
<DeliveryPointCheckDigit />
<DeliveryPointCode />
<MelissaAddressKey>8620912446</MelissaAddressKey>
<MoveEffectiveDate />
<MoveTypeCode />
<PostalCode>K1A 0A2</PostalCode>
<RecordID>1</RecordID>
<Results>AC01,AS01</Results>
<State>ON</State>
<StateName>Ontario</StateName>
<Urbanization />
</ResponseRecord>
</Records>
<TotalRecords>1</TotalRecords>
<TransmissionReference>Test</TransmissionReference>
<TransmissionResults />
<Version>8.4.1.1130</Version>
</Response>
<Response xmlns="urn:mdSmartMover" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Records>
<ResponseRecord>
<AddressExtras />
<AddressKey>K1A0A2</AddressKey>
<AddressLine1>80 Wellington St</AddressLine1>
<AddressLine2 />
<AddressTypeCode>1</AddressTypeCode>
<BaseMelissaAddressKey />
<CarrierRoute />
<City>Ottawa</City>
<CityAbbreviation>Ottawa</CityAbbreviation>
<CompanyName />
<CountryCode>CA</CountryCode>
<CountryName>Canada</CountryName>
<DeliveryIndicator />
<DeliveryPointCheckDigit />
<DeliveryPointCode />
<MelissaAddressKey>8620912446</MelissaAddressKey>
<MoveEffectiveDate />
<MoveTypeCode />
<PostalCode>K1A 0A2</PostalCode>
<RecordID>1</RecordID>
<Results>AC01,AS01</Results>
<State>ON</State>
<StateName>Ontario</StateName>
<Urbanization />
</ResponseRecord>
</Records>
<TotalRecords>1</TotalRecords>
<TransmissionReference>Test</TransmissionReference>
<TransmissionResults />
<Version>8.4.1.1130</Version>
</Response>
Columns#
Entering the column name will return the column. Specifying a group name will return all columns in the group.
Delimit multiple columns with a ,
.
Group Name |
Included Fields |
|||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
[DEFAULT] - Always return in the output structure. |
|
|||||||||||||||||||||||||||||||
GrpName - Name Details |
|
|||||||||||||||||||||||||||||||
GrpOriginal - Original Address Details |
|
|||||||||||||||||||||||||||||||
GrpParsed - Parsed Address Details |
|
|||||||||||||||||||||||||||||||
GrpStandardized - Standardized Addres Details |
|
|||||||||||||||||||||||||||||||
[COLUMN NAME ONLY] - These columns can only be requested by using their name. |
|
Service Level Response Fields#
Output Name |
Description |
---|---|
Version |
The current service version. |
TransmissionReference |
A pass-through of the input TransmissionReference field. |
TransmissionResults |
Service and General Transmission Errors |
TotalRecords |
Total number of records returned. |
Results |
The address verification results with codes for status, error, and changes. |
CASSReportLink |
CASS summary report link. |
NCOAReportLink |
NCOA summary report link. |
Record Level Response Fields#
[DEFAULT]#
Output Name |
Description |
---|---|
AddressExtras |
Returns any text that could not be identified as belonging to any of the other address fields. |
AddressKey |
Returns a unique key for the current address. |
AddressLine1 |
Address Line 1. |
AddressLine2 |
Address Line 2. |
AddressTypeCode |
Code specifying the type of address. For a list of codes, see SmartMover V3 Product Codes. |
BaseMelissaAddressKey |
A unique key assigned to the base address of a complex with apartments or suites. |
CarrierRoute |
Carrier route code, with the first character being alphabetic and the following three characters being numeric. The alphabetic letter indicates the type of delivery associated with the address. For a list of codes, see SmartMover V3 Product Codes. |
City |
City name. If the city name is more than 28 characters long, CityAbbreviation will contain the official USPS abbreviation for the city. |
CityAbbreviation |
City abbreviation. If the city name is more than 28 characters long, this will contain the official USPS abbreviation for the city. |
CompanyName |
Name of the business. |
CountryCode |
The standard code of the country. Currently only Canada and the United States are supported. |
CountryName |
The full country name. Currently only Canada and the United States are supported. |
DeliveryIndicator |
The RBDI Indicator code based on the address. For a list of codes, see SmartMover V3 Product Codes. |
DeliveryPointCheckDigit |
Contains the 12th digit of the POSTNET barcode. |
DeliveryPointCode |
Contains the 10th and 11th digits of the POSTNET barcode, usually the last two digits of the street number. |
MelissaAddressKey |
(MAK) A unique key assigned to an address record. |
MoveEffectiveDate |
US Only. Returns the effective date of the move in the format “YYYYMM”. |
MoveTypeCode |
Specifies the type of address record matched. For a list of codes, see SmartMover V3 Product Codes. |
PostalCode |
Postal Code. |
RecordID |
Position of the record in the response array. |
Records |
This is the returned array of records. |
Results |
Returns record specific result codes. For a list of codes, see SmartMover V3 Result Codes. |
State |
Standard two-letter abbreviation of the state. |
StateName |
Full name of the state. |
Urbanization |
Returns the value passed to the Urbanization field in the request. Only used for addresses in Puerto Rico. This is used to break ties between similar addresses in the same Postal Code. |
GrpName#
Output Name |
Description |
---|---|
NameFirst |
Returns the first name as submitted to the NameFirst field in the request. |
NameFull |
Returns the full name as submitted to the NameFull field in the request. |
NameLast |
Returns the last name as submitted to the NameLast field in the request. |
NameMiddle |
Returns the middle name as submitted to the NameMiddle field in the request. |
NamePrefix |
Returns the name prefix as submitted to the NamePrefix field in the request. |
NameSuffix |
Returns the name suffix as submitted to the NameSuffix field in the request. |
GrpOriginal#
Output Name |
Description |
---|---|
OriginalAddressLine1 |
Returns the original address line 1 exactly as submitted in the request. |
OriginalAddressLine2 |
Returns the original address line 2 exactly as submitted in the request. |
OriginalCity |
Returns the original city exactly as submitted in the request. |
OriginalCityAbbreviation |
Returns the original country abbreviation exactly as submitted in the request. |
OriginalCountryCode |
Returns the original country code exactly as submitted in the request. |
OriginalPlus4 |
Returns the original Plus + 4 exactly as submitted in the request. |
OriginalPostalCode |
Returns the original postal code exactly as submitted in the request. |
OriginalPrivateMailbox |
Returns the original private mailbox exactly as submitted in the request. |
OriginalResults |
Returns the original results exactly as submitted in the request. |
OriginalState |
Returns the original state exactly as submitted in the request. |
OriginalStateName |
Returns the original state name exactly as submitted in the request. |
OriginalSuite |
Returns the original suite exactly as submitted in the request. |
OriginalUrbanization |
Returns the original urbanization exactly as submitted in the request. |
GrpParsed#
Output Name |
Description |
---|---|
AddressDeliveryInstallation |
Canada Only. Returns the parsed delivery installation of the address. |
AddressHouseNumber |
Returns the parsed numeric portion of the street address. |
AddressLockBox |
Returns the parsed lockbox. |
AddressPostDirection |
Returns the parsed directional abbreviation that comes after the street name. For example, “Park Ave South” would return “S”. |
AddressPreDirection |
Returns the parsed directional abbreviation that comes before the street name. For example, “100 North Main Street” would return “N”. |
AddressPrivateMailboxName |
Returns the parsed non-numeric portion of a private mailbox number. Either “#” or “PMB”. |
AddressPrivateMailboxRange |
Returns the parsed numeric portion of an address if it is located at a Commercial Mail Receiving Agency (CMRA). |
AddressRouteService |
Returns the parsed route service. |
AddressStreetName |
Returns the parsed name portion of the street address. This excludes the street number, suffix, and any directionals. |
AddressStreetSuffix |
Returns the parsed street suffix. E.g. “Rd”, “St”, or “Blvd”. |
AddressSuiteName |
Returns the parsed standardized text from the suite. E.g. “STE” or “Unit”. |
AddressSuiteNumber |
Returns the parsed numeric portion of the suite. |
GrpStandardized#
Output Name |
Description |
---|---|
StandardizedAddressLine1 |
Returns the standardized address line 1 using USPS addressing standards. |
StandardizedAddressLine2 |
Returns the standardized address line 2 using USPS addressing standards. |
StandardizedBaseMelissaAddressKey |
Returns the Base Melissa Address Key of the standardized address. |
StandardizedCarrierRoute |
Returns the standardized carrier route using USPS addressing standards. |
StandardizedCity |
Returns the standardized city using USPS addressing standards. |
StandardizedCityAbbreviation |
Returns the standardized city abbreviation using USPS addressing standards. |
StandardizedCountryCode |
Returns the standardized country code using USPS addressing standards. |
StandardizedDeliveryIndicator |
Returns the standardized delivery indicatior using USPS addressing standards. |
StandardizedDeliveryPointCheckDigit |
Returns the standardized delivery point check digit using USPS addressing standards. |
StandardizedDeliveryPointCode |
Returns the standardized delivery point code using USPS addressing standards. |
StandardizedMelissaAddressKey |
Returns the Melissa Address Key of the standardized address. |
StandardizedPlus4 |
Returns the standardized Plus + 4 using USPS addressing standards. |
StandardizedPostalCode |
Returns the standardized postal code using USPS addressing standards. |
StandardizedPrivateMailbox |
Returns the standardized private mailbox using USPS addressing standards. |
StandardizedResults |
Returns the results of the standardized address. |
StandardizedState |
Returns the standardized state using USPS addressing standards. |
StandardizedStateName |
Returns the standardized state name using USPS addressing standards. |
StandardizedSuite |
Returns the standardized suite using USPS addressing standards. |
StandardizedUrbanization |
Returns the standardized urbanization using USPS addressing standards. |
[COLUMN NAME ONLY]#
These columns can only be requested by using their name.
Output Name |
Description |
---|---|
DPVFootNotes |
Indicates the level of matching between the current address and the USPS’s DPV database. This footnote may be up to six characters long. For a list of codes, see SmartMover V3 Product Codes. |
MoveReturnCode |
Code indicating the level of matching between the record and the NCOA Link database. For a list of codes, see Record Level Product Codes. |
Plus4 |
The last four digits of the ZIP + 4. |
PrivateMailbox |
If the address is a private mailbox serivce the number will be returned here. |
Suite |
Address suite. |
Result Codes#
For details of all result code please visit here.
Melissa Data’s products use a result code system to indicate data quality; the status and any errors. These result codes are four-character codes (two letters followed by two numbers), delimited by commas. Result code definitions are shared among Melissa Data products.
Understanding the Code#
To fully understand result codes, you need to know them. Knowing what codes are possible and what they indicate will be key in building an effective application. It is useful to know all the codes, but this does not necessarily mean you will use them all. Just because you have a toolbox, doesn’t mean you will also try to use a screwdriver along with a hammer on a nail.
Record Level Result Codes#
Code |
Short Description |
Long Description |
---|---|---|
AS - Address Status |
||
|
Address Fully Verified |
The address is valid and deliverable according to official postal agencies. |
|
Valid Building Address |
The building address was verified but the suite/apartment number is missing or invalid. |
|
Non USPS Address Match |
US Only. This US address is not serviced by the USPS but does exist and may receive mail through third party carriers like UPS. |
|
Proprietary Address Format |
The address uses a proprietary addressing scheme where only the format could be validated. |
|
Foreign Address |
The address is in a non-supported country. |
|
SSN Found in our Records |
US Only. The address is a Commercial Mail Receiving Agency (CMRA) like a Mailboxes Etc. These addresses include a Private Mail Box (PMB or #) number. |
|
PBSA Address |
A PO Box formatted as a street address for package and mail delivery. |
|
Address Updated By LACS |
US Only. The address has been converted by LACSLink® from a rural-style address to a city-style address. |
|
Suite Appended |
US Only. A suite was appended by SuiteLink™ using the address and company name. |
|
Apartment Appended |
An apartment number was appended by AddressPlus using the address and last name. |
|
Vacant Address |
US Only. The address has been unoccupied for more than 90 days. |
|
No USPS Mail Delivery |
This address is classified as not receiving mail by the USPS via their No-Stat flag. Delivery might still be possible by third party carriers but that cannot be counted on. |
|
DPV Locked Out |
US Only. DPV processing was terminated due to the detection of what is determined to be an artificially created address. |
|
Deliverable only by USPS |
US Only. This address can only receive mail delivered through the USPS (i.e. PO Box or a military address). |
|
Extraneous Suite Information |
Extraneous information not used in verifying the address was found. This information was returned in the suite field. |
|
USPS Door Not Accessible |
Address identified by the USPS where carriers cannot physically access a building or door for mail delivery. |
|
Unique ZIP code |
The address contains a USPS unique ZIP code which means any address may be marked as deliverable. |
|
Unknown Data Moved to ParsedGarbage |
The input contains data that could not be identified. That data is returned in the ParsedGarbage/AddressExtras field |
|
Phantom Route address |
Addresses that are assigned to a phantom route of R777 or R779. |
AE - Address Error |
||
|
General Error |
The address could not be verified. This is likely due to a missing or invalid locality or postal code. |
|
Unknown Street |
Could not match the input street to a unique street name. Either no matches or too many matches found. |
|
Component Mismatch Error |
The combination of directionals (N, E, SW, etc) and the suffix (AVE, ST, BLVD) is not correct and produced multiple possible matches. |
|
Non-Deliverable Address |
US Only. A physical plot exists but is not a deliverable addresses. One example might be a railroad track or river running alongside this street, as they would prevent construction of homes in that location. |
|
Multiple Match |
The address was matched to multiple records. There is not enough information available in the address to break the tie between multiple records. |
|
Early Warning System |
US Only. This address currently cannot be verified but was identified by the Early Warning System (EWS) as belonging to a upcoming area and will likely be included in a future update. |
|
Missing Minimum Address |
Minimum requirements for the address to be verified is not met. Address must have at least one address line and also the postal code or the locality/administrative area. |
|
Sub Premise Number Invalid |
The thoroughfare (street address) was found but the sub premise (suite) was not valid. |
|
Sub Premise Number Missing |
The thoroughfare (street address) was found but the sub premise (suite) was missing. |
|
Premise Number Invalid |
The premise (house or building) number for the address is not valid. |
|
Premise Number Missing |
The premise (house or building) number for the address is missing. |
|
Box Number Invalid |
The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is invalid. |
|
Box Number Missing |
The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is missing. |
|
PMB Number Missing |
US Only. The address is a Commercial Mail Receiving Agency (CMRA) and the Private Mail Box (PMB or #) number is missing. |
|
Sub Premise Not Required (Deprecated - See AS23) |
A sub premise (suite) number was entered but the address does not have secondaries. (Deprecated - See AS23) |
AC - Address Change |
||
|
Postal Code Change |
The postal code was changed or added. |
|
Administrative Area Change |
The administrative area (state, province) was added or changed. |
|
Locality Change |
The locality (city, municipality) name was added or changed. |
|
Alternate to Base Change |
US Only. The address was found to be an alternate record and changed to the base (preferred) version. |
|
Alias Name Change |
US Only. An alias is a common abbreviation for a long street name, such as “MLK Blvd” for “Martin Luther King Blvd.” This change code indicates that the full street name (preferred) has been substituted for the alias. |
|
Address1/Address2 Swap |
Address1 was swapped with Address2 because Address1 could not be verified and Address2 could be verified. |
|
Address1 & Company Swapped |
Address1 was swapped with Company because only Company had a valid address. |
|
Plus4 Change |
US Only. A non-empty plus4 was changed. |
|
Dependent Locality Change |
The dependent locality (urbanization) was changed. |
|
Thoroughfare Type Change |
The thoroughfare (street) leading or trailing type was added or changed, such as from “St” to “Rd.” |
|
Thoroughfare Directional Change |
The thoroughfare (street) pre-directional or post-directional was added or changed, such as from “N” to “NW.” |
|
Sub Premise Type Change |
The sub premise (suite) type was added or changed, such as from “STE” to “APT.” |
|
Sub Premise Number Change |
The sub premise (suite) unit number was added or changed. |
CS - SmartMover Satus |
||
|
Move with New Address |
The record is a ‘move’ and a new ‘moved to’ address was provided. |
|
Standardized Address |
The record is not a ‘move’ but was standardized. |
|
Move Input Requirements not Satisfied |
The record is matched to change of address file but did not satisfy all requirements to produce a ‘moved to’ address. |
|
Move but No New Address |
The record is a ‘move’ but could not provide a ‘moved to’ address. |
|
Individual Move |
The record is classified as an individual. |
|
Family Move |
The record is classified as a family. |
|
Business Move |
The record is classified as a business. |
|
Daily Delete |
The record is a Daily Delete address. COA with this address is pending deletion from the master file and no mail may be forwarded from this address. |
CM - SmartMover Match Satus |
||
|
COA Match |
A COA was found for an Individual, Business, or Family. |
|
Foreign Move |
A COA was found for a Foreign Move. No forwarding address was provided. |
|
Moved no Forwarding |
A COA was found. The customer moved and left no forwarding address (MLNA). |
|
Box Closed |
A COA was found. The Post Box was closed with no order filed by the customer (BCNO). |
|
Cannot Match Secondary |
The COA could not be matched because the street address does not match with the secondary number. |
|
DPBC Ambiguous |
The COA could not be converted to a deliverable address because the 11-digit zip code represents more than one delivery point. |
|
Conflicting Middle Name |
The COA could not be matched because there is more than one COA record for the match and the middle names or initials on the COAs are different. |
|
Conflicting Gender |
The COA could not be matched because there is more than one COA record for the match and the genders of the names on the COAs are different. |
|
Conflicting Instructions |
The COA could not be matched because two potential matches were compared and had differences in the new addresses. |
|
Cannot Match High-rise Default |
The COA could not be matched because the input record is a potential match to a family COA record from a multi-unit building, but the address zip + 4 coded to the building default. This requires individual name matching logic to obtain a match and the individual names did not match. |
|
Cannot Match Rural Default |
The COA could not be matched because the input record is a potential match to a family COA record from a Rural Route or Highway Contract Route address. This requires individual name matching logic to obtain a match and the individual names did not match. |
|
Insufficient Name |
The COA could not be matched because there is a COA record with the same surname and address but there is insufficient first/middle name information on the COA record to product a match using individual matching logic. |
|
Middle Name Test Failed |
The COA could not be matched because the input name contains a conflict with the middle name or initials on the COA record. |
|
Gender Conflict |
The COA could not be matched because the gender of the name on the input record conflicts with the gender of the name on the COA record. |
|
Cannot Convert Address |
The COA was found but the new address would not convert at run time. |
|
Individual Name Insufficient |
The COA could not be matched because the input middle initial/name is missing or does not equal the middle initial/name on the potential COA match. |
|
Secondary Discrepancy |
The COA could not be matched because there is conflicting secondary information on the input and COA record or the input record contained secondary information and matched to a family record that does not contain secondary information. |
|
Other Insufficient Name |
The COA could not be matched because the input middle initial/name is missing or different from the middle name on the COA. A match cannot be made because the first name on the COA was truncated and the middle names must be equal in order to make this match. |
|
Cannot Match General Delivery |
The COA could not be matched for general delivery. |
|
No ZIP + 4, Not Confirmable, or Temporary |
The COA was found but the new address either: does not have a ZIP+4 coded and therefore there is no 11-digit DPBC, the primary number cannot be confirmed on DPV, or is temporary. |
|
Conflicting Directions |
The address could not be updated due to multiple matches. |
NCOA Return Codes |
||
|
COA Match |
The input record matched to a business, individual or family type master file record. A new address could be furnished. |
|
No Match |
The input record COULD NOT BE matched to a master file record. A new address could not be furnished. |
|
Foreign Move |
The input record matched to a business, individual or family type master file record but the new address was outside USPS delivery area. |
|
Moved Left No Address |
The input record matched to a business, individual or family type master file record and the new address was not provided to USPS. |
|
Box Closed No Order (BCNO) |
The Input record matched to a business, individual or family type master file record which contains an old address of PO BOX that has been closed without a forwarding address provided. |
|
Street Address with Secondary |
In the STANDARD mode utilizing Family matching logic the input record matched to a family record type on the master file with an old address that contained secondary information which obtained a ZIP+4 street level match. The input record does not contain secondary information. This address match situation requires individual name matching logic to obtain a match and individual names do not match. |
|
New 11-digit DPBC is Ambiguous |
The input record matched to a business, individual or family type master file record. The new address on the master file record could not be converted to a deliverable address because the DPBC represents more than one delivery point. |
|
Conflicting Directions: Middle Name Related |
There is more than one COA (individual or family type) record for the match algorithm and the middle names or initials on the COAs are different. Therefore, a single match result could not be determined. |
|
Other Conflicting Instructions |
The input record matched to two master file (business, individual or family type) records. The two records in the master file were compared and due to differences in the new addresses, a match could not be made. |
|
High-rise Default |
The input record matched to a family record on the master file from a High-rise address ZIP+4 coded to the building default. This address match situation requires individual name matching logic to obtain a match and individual names do not match. |
|
Rural Default |
The input record matched to a family record on the master file from a Rural Route or Highway Contract Route address ZIP+4 coded to the route default. This address situation requires individual name matching logic to obtain a match and individual names do not match. |
|
Insufficient COA Name for Match |
There is a master file (individual or family type) record with the same surname and address but there is insufficient name information on the master file record to produce a match using individual matching logic. |
|
Middle Name Test Failed |
The input record matched to an individual or family record on the master file with the same address and surname. However, a match cannot be made because the input name contains a conflict with the middle name or initials on the master file record. |
|
Gender Test Failed |
The input record matched to a master file (individual or family type) record. A match cannot be made because the gender of the name on the input record conflicts with the gender of the name on the master file record. |
|
New Address Would Not Convert |
The input record matched to a master file (business, individual or family type) record. The new address could not be converted to a deliverable address. |
|
Individual Name Insufficient |
There is a master file record with the same address and surname. A match cannot be made because the input record does not contain a first name or contains initials only. |
|
Secondary Number Discrepancy |
The input record matched to a street level individual or family type record. However, a match is prohibited based on I of the following reasons: 1) There is conflicting secondary information on the input and master file record; 2) the input record contained secondary information and matched to a family record that does not contain secondary information. In item 2, this address match situation requires individual name matching logic to obtain a COA match and individual names do not match. |
|
Other Insufficient Name |
The input record matched to an individual or family master file record. The input name is different or not sufficient enough to produce a match. |
|
General Delivery |
The input record matched to a family record on the master file from a General Delivery address. This address situation requires individual name matching logic to obtain a match and individual names do not match. |
|
New Address not ZIP + 4 coded or DPV confirmed. |
There is a change of address on file but the new address cannot be ZIP + 4 coded and therefore there is no 11-digit DPBC to store or return, the new address primary number cannot be confirmed on DPV or the new address is temporary. |
|
Conflicting Directions after re-chaining |
Multiple master file records were potential matches for the input record. The master file records contained different new addresses and a single match result could not be determined. |
|
Daily Delete |
The input record matched to a business, individual or family type master file record with an old address that is present in the daily delete file. The presence of an address in the daily delete file means that a COA with this address is pending deletion from the master file and that no mail may be forwarded from this address. |
|
ANKLink Primary Return Code |
Indicates that ANKlink has provided the move date, but not address, for a move that occurred between 19 and 48 months ago. |
|
Secondary Number dropped from COA |
The input record matched to a master file record. The master file record had a secondary number and the input address did not. Please Note: This return code is derived from Individual matching logic only. If this return code is achieved then no other matching attempts are permitted regardless of the PROCESSING mode. |
|
Secondary Number Dropped from input address |
The input record matched to a master file record, but the input address had a secondary number and the master file record did not. The record is a ZIP + 4 street level match. Please Note: This return code is derived from individual matching logic only. If this return code is achieved then no other matching attempts are permitted regardless of the PROCESSING mode. |
SE - Transmission Service Error |
||
|
Unexpected Error |
Your request could not be processed due to an unexpected error. Please retry your request. |
|
Record Number Mismatch |
Total Records numbers do not match with the records array. |
|
Month Range Exceeded |
Months to allow for NCOALink products ranges from 6 to 48. |
|
Records Array Error |
Records array is empty, un-allocated, or out of bounds. |
|
Requesting Record Range Exceeded |
Requesting records must in the range of 1 to 100. |
|
No Summary Reports |
Summary reports do not exist. |
|
ProcessingType Error |
ProcessingType is empty or incorrect type. |
|
FreqProcessing Range Exceeded |
ListOwnerFreqProcessing ranges from 1 to 52. |
|
ListName Character Limit |
OptSmartMoverListName cannot contain over 30 characters. |
|
ListName Invalid Character |
OptSmartMoverListName cannot contain any of the following characters \ / * : ? ” ” < > | or non-printing characters. |
|
Invalid Link |
Invalid link. |
|
License Key Error |
License Key is not valid or customer’s Paf is not on file. |
|
SmartMover Service Disabled |
Smart Mover Service package(s) is/are not enabled. Please contact your sales representative! |
|
Long JobID |
JobID cannot contain over 50 characters. |
|
JobID Invalid Character |
JobID cannot contain any of the following characters \ / * : ? ” ” < > |, non-printing characters or spaces. |
|
No JobID |
JobID required to open summary reports. |
|
Customer PAF Expired |
The Customer PAF is expired. |
|
Broker PAF Expired |
The Broker PAF is expired. |
|
NO PAFID Match |
The PAFID does not match. |
|
No PAFID |
The under broker customer required a PAFID. |
|
Unconfirmed PAFID |
The PAFID is unconfirmed. |
|
Empty XML |
Incorrect or empty XML/JSON structure. |
|
Empty Record Structure |
Incorrect or empty record structure. |
|
Incorrect Action |
The attempted action(s) was incorrect. |
Record Level Product Codes#
Code |
Description |
---|---|
Address Type US |
|
|
Firm or Company |
|
General Delivery |
|
Highrise or Business Complex |
|
PO Box |
|
Rural Route |
|
Street or Residential |
Code |
Short Description |
Long Description |
---|---|---|
Canada NCOA Move Status (NCOAMS) |
||
|
Moved Back |
COA Match - Moved back |
|
Deceased |
COA Match - Individual deceased. |
|
COA Match |
COA Match - A business, individual, or family. |
|
Recursive Match |
COA Match - Recursive - A business, individual, or family. |
|
Moved, No Address |
COA Match - Moved and left no address. |
|
No Name Match |
No COA match for name. |
|
Unidentified |
Address could not be identified. |
|
No Address Match |
No COA match for address. |
Code |
Description |
---|---|
Carrier Route Type |
|
|
PO Box |
|
City Delivery |
|
General Delivery |
|
Highway Contract |
|
Rural Route |
DPV Type |
|
|
Input address matched to the Zip+4 file. |
|
Input address not matched to the Zip+4 file. |
|
Input address matched to DPV (all components). |
|
Input address primary number (street number) matched to DPV but secondary number not matched. |
|
Input address primary number matched, secondary number not matched; secondary number required. |
|
Address was coded to a military address. |
|
Address was coded to a General Delivery address. |
|
Input address primary number matched to DPV but secondary number missing. |
|
Input address primary number missing. |
|
Input address primary number invalid. |
|
Identified PO Box Street Address. |
|
Input address PO, RR or HC box number missing. |
|
Input address PO, RR or HC box number invalid. |
|
Input address matched to CMRA. |
|
Input address matched to CMRA but secondary number not present. |
|
Addresses that are assigned to a phantom route of R777 or R779. |
|
Input address primary number matched by dropping trailing alpha. |
|
Address was coded to a unique Zip Code. |
Move Type |
|
|
Family |
|
Business |
|
Individual |
RBDI Address Type (RBDI) |
|
|
Residential |
|
Business |
|
Unknown |