Skip to content
  • Check change of US addresses

    Request

    Submit a bulk request to check change of US addresses.

    The following are the possible minimum input requirements:

    1. First and Last Name, Full Name, or Company

    2. Address Only

    3. City and State, ZIP Code, or AddressLastLine

    Headers
    Acceptstringrequired

    Format of the response.

    Enum:"application/json""*/*"
    Example:application/json
    Content-Typestringrequired

    Format of the request.

    Enum:"application/json""application/xml"
    Bodyrequired
    Actionsstring

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

    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:

    GrpName - Name Details
    • NameFirst
    • NameFull
    • NameLast
    • NameMiddle
    • NamePrefix
    • NameSuffix
    GrpOriginal - Original Address Details
    • OriginalAddressLine1
    • OriginalAddressLine2
    • OriginalCity
    • OriginalCityAbbreviation
    • OriginalCountryCode
    • OriginalPlus4
    • OriginalPostalCode
    • OriginalPrivateMailbox
    • OriginalResults
    • OriginalState
    • OriginalStateName
    • OriginalSuite
    • OriginalUrbanization
    GrpParsed - Parsed Address Details
    • AddressDeliveryInstallation
    • AddressHouseNumber
    • AddressLockBox
    • AddressPostDirection
    • AddressPreDirection
    • AddressPrivateMailboxName
    • AddressPrivateMailboxRange
    • AddressRouteService
    • AddressStreetName
    • AddressStreetSuffix
    • AddressSuiteName
    • AddressSuiteNumber
    GrpStandardized - Standardized Address Details
    • StandardizedAddressLine1
    • StandardizedAddressLine2
    • StandardizedBaseMelissaAddressKey
    • StandardizedCarrierRoute
    • StandardizedCity
    • StandardizedCityAbbreviation
    • StandardizedCountryCode
    • StandardizedDeliveryIndicator
    • StandardizedDeliveryPointCheckDigit
    • StandardizedDeliveryPointCode
    • StandardizedMelissaAddressKey
    • StandardizedPlus4
    • StandardizedPostalCode
    • StandardizedPrivateMailbox
    • StandardizedResults
    • StandardizedState
    • StandardizedStateName
    • StandardizedSuite
    • StandardizedUrbanization
    [COLUMN NAME ONLY] - These columns can only be requested by using their name.
    • DPVFootNotes
    • MoveReturnCode
    • Plus4
    • PrivateMailbox
    • Suite
    CustomerIDstringrequired

    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.

    Optionsstring

    Options - Specify which options to use for the selected action. List of options in <OptionName>:<Parameter> format. Multiple options are delimited with a ,.

    For example: OptionName:Parameter,OptionName:Parameter.

    • ListOwnerFreqProcessing:< [1 - 52] > - 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.
    • ProcessingType:< Business | Individual | IndividualAndBusiness | Residential | Standard > - The processing type.
    OptionSmartMoverListNamestring

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

    PAFIdstring

    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.

    TransmissionReferencestring

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

    RecordsArray of objects, [ 1 .. 100 ] items
    curl -i -X POST \
      https://smartmover.melissadata.net/V3/WEB/SmartMover/doSmartMover \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
        "Actions": "NCOA",
        "Columns": "",
        "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
        "ExecutionID": "Batch_1",
        "JobID": "",
        "Options": "",
        "OptionSmartMoverListName": "",
        "PAFId": "",
        "TransmissionReference": "Test",
        "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": ""
          }
        ]
      }'

    Responses

    Successful response

    Body
    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.

    RecordsArray of objects

    This is the returned array of records.

    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": "1", "Results": "AS01,CS02", "State": "CA", "StateName": "California", "Urbanization": "" }, "TotalRecords": "1", "TransmissionReference": "Test", "TransmissionResults": "", "Version": "7.4.1.4198" }