v1

latestOpenAPI 3.1.22026-08-062439.4 KB

Change of Canadian Address Detection

Check a move in Canada

Send a GET request to check a move in Canada.

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

Set A - first, last / full / comp

Set B - a1

Set C - city, state / postal

get/doSmartMover

Query parameters

actstring

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

colsstring

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>

format'json' | 'xml'

The desired format of the response.

{"stackTrail":"components:parameters:LicenseKeyParam:schema","oasType":"schema","type":"unknown"}

Required. The License Key issued by Melissa.

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.

liststring

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

tstring

Transmission Reference - Serves as a unique identifier for this set of records.

a1string required

A minimum address location for the name / company contact.

a2string

The second address line.

citystring required

The city name.

compstring

The name of the business.

ctrystring

The country code. SmartMover CA can only update addresses within Canada.

firststring

The parsed first name of an individual.

fullstring required

The full name of an individual. Required unless parsed name inputs are used.

laststring

The parsed last name of an individual.

middlestring

The parsed middle name of an individual.

nameprestring

The title or honorific prefix of the name. E.g. Mr, Miss, Dr.

namesuffixstring

The generational or professional suffix of the name. E.g. Jr, IV, Ph.D..

plus4string

The last four digits of a ZIP+4.

pmbstring

The private mailbox number, if this address is a box in a private mailbox service.

postalstring required

The five-digit ZIP Code, the first five digits of a ZIP+4, or a full nine-digit ZIP+4.

statestring required

The state name.

stestring

The suite number.

Headers

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

Format of the response.

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

Format of the 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.

All 2 operations