v1

latestOpenAPI 3.1.22026-08-062439.4 KB

Change of Canadian Address Detection

Check change of Canadian addresses

Submit a bulk request to check change of Canadian addresses.

The service requires at least one of the following input combinations:

Set A - NameFirst, NameLast / NameFull / Company

Set B - AddressLine1

Set C - City, State / PostalCode

post/doSmartMover

Headers

Accept'application/json' | 'application/xml' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Request body

Actionsstring

Selects which COA objects to be used in the request. For Canadian Change of Address Object, use CCOA.

Columnsstring

Columns - The column names or groups to be output.

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Delimit multiple columns with a ,.

For example: ColumnName,ColumnName.

Columns:

<details> <summary> <code>GrpName</code> - Name Details </summary>

NameFirst
NameFull
NameLast
NameMiddle
NamePrefix
NameSuffix

</details> <details> <summary> <code>GrpOriginal</code> - Original Address Details </summary>

OriginalAddressLine1
OriginalAddressLine2
OriginalCity
OriginalCityAbbreviation
OriginalCountryCode
OriginalPlus4
OriginalPostalCode
OriginalPrivateMailbox
OriginalResults
OriginalState
OriginalStateName
OriginalSuite
OriginalUrbanization

</details> <details> <summary> <code>GrpParsed</code> - Parsed Address Details </summary>

AddressDeliveryInstallation
AddressHouseNumber
AddressLockBox
AddressPostDirection
AddressPreDirection
AddressPrivateMailboxName
AddressPrivateMailboxRange
AddressRouteService
AddressStreetName
AddressStreetSuffix
AddressSuiteName
AddressSuiteNumber

</details> <details> <summary> <code>GrpStandardized</code> - Standardized Address Details </summary>

StandardizedAddressLine1
StandardizedAddressLine2
StandardizedBaseMelissaAddressKey
StandardizedCarrierRoute
StandardizedCity
StandardizedCityAbbreviation
StandardizedCountryCode
StandardizedDeliveryIndicator
StandardizedDeliveryPointCheckDigit
StandardizedDeliveryPointCode
StandardizedMelissaAddressKey
StandardizedPlus4
StandardizedPostalCode
StandardizedPrivateMailbox
StandardizedResults
StandardizedState
StandardizedStateName
StandardizedSuite
StandardizedUrbanization

</details> <details> <summary> [COLUMN NAME ONLY] - These columns can only be requested by using their name. </summary>

DPVFootNotes
MoveReturnCode
Plus4
PrivateMailbox
Suite

</details>

CustomerIDstring required

Required. The License Key issued by Melissa.

ExecutionIDstring

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 0 if not set.

JobIDstring

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.

OptionSmartMoverListNamestring

Identifies the current list. It will be included in reports returned by SmartMover V3 after processing.

TransmissionReferencestring

Serves as a unique identifier for this set of records. This allows you to match a response to a request.

Response

Successful response

Versionstring

The current service version number.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see SmartMover Result Codes.

TotalRecordsstring

Total number of records.