NCOA – GetNCOALinkSummaryReport

The NCOALink Processing Summary Report (aka “PSR”) is a report that contains data for a specific list.

NOTE: Running a report for your Job, closes the job to new transactions permanently. Do not run this report until you’re finished with the job.

GetNCOALinkSummaryReport Inputs

Name	Type	Description
JobId	String	The client-created ID for your Job.
LicenseKey	String	Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/change-of-address/

GetNCOALinkSummaryReport Outputs

Name	Type	Values	Description
CustomerPAFId	String	Varies	The PAF Id assigned to the client after registration.
MailerCompanyName	String	Varies	The name of the registered company.
ListName	String	Varies	The name of the list.
ProcessingCategory	String	Varies	(probably always NORMAL)
PreProcessesPerformedFlag	String	Varies	Flag detailing the type of Pre-processes performed.
ConcurrentProcessesPerformedFlag	String	Varies	Flag detailing the type of concurrent processes performed.
PostProcessesPerformedFlag	String	Varies	Flag detailing the type of post-processes performed.
StandardOutputReturnedFlag	String	Varies	Flag indicating if all output was provided to the client.
MatchingLogicAppliedFlag	String	Varies	Type of matching logic used (e.g. Individual or Business logic, or both)
DataReturnedFlag	String	C, F, S	Indicates whether COA data is returned.
ClassOfMail	String	A-O	Class of mail to be used for mailings produced from customer mailing list
DateProcessingCompleted	String	YYYYmmdd	Completion date of the batch.
DateListReturnedToCustomer	String	Varies	Date that list was provided to the client.
TotalNumberOfRecordsProcessed	String	Varies	Total records processed in batch.
TotalNumberOfRecordsMatchedNCOALink	String	Varies	Total records that returned NCOA data.
TotalNumberOfRecordsMatchedANKLink	String	Varies	Total records that returned ANK (Attempted Not Known) data. Return to sender.
TotalNumberOfRecordsZip4Coded	String	Varies	Total Zip+4 found.
TotalNumberOfRecordsDPVConfirmed	String	Varies	Total DPV matches found.
TotalNumberOfRecordsMatchedLACSLink	String	Varies	Total LACSLink matches found.
TotalNumberOfRecordsMatchedSuiteLink	String	Varies	Total SuiteLink matches found.
MovedNewAddressProvided_00_03	String	Varies	Total new addresses found that were <= 3 months old.
MovedNewAddressProvided_04_06	String	Varies	Total new addresses found between 4 and 6 months old.
MovedNewAddressProvided_07_12	String	Varies	Total new addresses found between 7 and 12 months old.
MovedNewAddressProvided_13_18	String	Varies	Total new addresses found between 13 and 18 months old.
MovedNewAddressProvided_19_On	String	Varies	Total new addresses found >= 19 months old.
MovedNoNewAddressProvided_00_03	String	Varies	Total matches without new addresses provided <= 3 months old.
MovedNoNewAddressProvided_04_06	String	Varies	Total matches without new addresses provided between 4 and 6 months old.
MovedNoNewAddressProvided_07_12	String	Varies	Total matches without new addresses provided between 7 and 12 months old.
MovedNoNewAddressProvided_13_18	String	Varies	Total matches without new addresses provided between 13 and 18 months old.
MovedNoNewAddressProvided_19_On	String	Varies	Total matches without new addresses provided >=19 months old.
MovedUnableToProvideNewAddress_00_03	String	Varies	Total matches with problematic return addresses <= 3 months old.
MovedUnableToProvideNewAddress_04_06	String	Varies	Total matches problematic return address between 4 and 6 months old.
MovedUnableToProvideNewAddress_07_12	String	Varies	Total matches problematic return address between 7 and 12 months old.
MovedUnableToProvideNewAddress_13_18	String	Varies	Total matches problematic return address between 13 and 18 months old.
MovedUnableToProvideNewAddress_19_On	String	Varies	Total matches problematic return address >= 19 months old.
Error	Error	Varies	Error object indicating why the service could not return a result. See “Errors” page.

GetNCOALinkSummaryReport Inputs

GetNCOALinkSummaryReport Outputs

References