Sends address data to BCC Software for processing using Data Marketing Services.
This service creates a Data Marketing Services order.
The USPS requires a Processing Acknowledgement Form (PAF) to be completed before NCOALink processing can be performed. To manage PAFs and obtain a value for the pafIdentifier property, visit BCC Software's PAF Management web page.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Sends address data to BCC Software for processing using Data Marketing Services.",
"type":"object",
"required":[
"processes",
"addressTable"
],
"properties":{
"processes":{
"title":"Processes",
"description":"Processes to perform using Data Marketing Services.",
"enum":[
"FSP",
"FSP,SUP",
"FSP,DEC",
"FSP,DMA",
"LSP",
"LSP,SUP",
"LSP,DEC",
"LSP,DMA",
"DSF",
"CAS",
"SUP",
"DEC",
"DMA",
"ARS",
"GEO",
"PCA",
"CPL"
],
"enumValues":[
{
"value":"FSP",
"displayValue":"NCOALink FSP",
"description":"NCOALink FSP/DPV/LACSLink/SuiteLink. NCOALink FSP processing updates your address table using 48 months of data from the database of Change Of Address (COA) forms filed with the Postal Service."
},
{
"value":"FSP,SUP",
"displayValue":"NCOALink FSP + Suppression Suite",
"description":"NCOALink FSP/DPV/LACSLink/SuiteLink + Suppression Suite. NCOALink FSP processing updates your address table using 48 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. Suppression Suite processing identifies records in your address table that match to common suppression/pander files including Direct Marketing Association (DMA) Mail Preference Service, Deceased, Prison and Business."
},
{
"value":"FSP,DEC",
"displayValue":"NCOALink FSP + Deceased Suppression",
"description":"NCOALink FSP/DPV/LACSLink/SuiteLink + Deceased Suppression. NCOALink FSP processing updates your address table using 48 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. Deceased Suppression processing identifies deceased individuals in your address table using a database derived from Social Security Administration records and other proprietary sources."
},
{
"value":"FSP,DMA",
"displayValue":"NCOALink FSP + DMA Suppression",
"description":"NCOALink FSP/DPV/LACSLink/SuiteLink + DMA Suppression. NCOALink FSP processing updates your address table using 48 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. DMA Suppression processing identifies individuals in your address table who have registered with the Direct Marketing Association (DMA) Mail Preference Service (MPS) to indicate that they do not wish to receive unsolicited mail."
},
{
"value":"LSP",
"displayValue":"NCOALink LSP",
"description":"NCOALink LSP with ANKLink/DPV/LACSLink/SuiteLink. NCOALink LSP processing updates your address table using 18 months of data from the database of Change Of Address (COA) forms filed with the Postal Service."
},
{
"value":"LSP,SUP",
"displayValue":"NCOALink LSP + Suppression Suite",
"description":"NCOALink LSP with ANKLink/DPV/LACSLink/SuiteLink + Suppression Suite. NCOALink LSP processing updates your address table using 18 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. Suppression Suite processing identifies records in your address table that match to common suppression/pander files including Direct Marketing Association (DMA) Mail Preference Service, Deceased, Prison and Business."
},
{
"value":"LSP,DEC",
"displayValue":"NCOALink LSP + Deceased Suppression",
"description":"NCOALink LSP with ANKLink/DPV/LACSLink/SuiteLink + Deceased Suppression. NCOALink LSP processing updates your address table using 18 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. Deceased Suppression processing identifies deceased individuals in your address table using a database derived from Social Security Administration records and other proprietary sources."
},
{
"value":"LSP,DMA",
"displayValue":"NCOALink LSP + DMA Suppression",
"description":"NCOALink LSP with ANKLink/DPV/LACSLink/SuiteLink + DMA Suppression. NCOALink LSP processing updates your address table using 18 months of data from the database of Change Of Address (COA) forms filed with the Postal Service. DMA Suppression processing identifies individuals in your address table who have registered with the Direct Marketing Association (DMA) Mail Preference Service (MPS) to indicate that they do not wish to receive unsolicited mail."
},
{
"value":"DSF",
"displayValue":"DSF2",
"description":"DSF2/DPV/LACSLink/SuiteLink. DSF2 processing updates your address table using the Delivery Sequence File (DSF), and return a Walk Sequence and a Business/Residential Flag for each record that matched."
},
{
"value":"CAS",
"displayValue":"DPV/LACSLink/SuiteLink",
"description":"DPV/LACSLink/SuiteLink. DPV processing validates address information at the physical delivery point level. This will allow you to identify Undeliverable As Addressed (UAA) mail prior to mailing. LACSLink processing updates addresses that have changed through the Locatable Address Conversion Service (LACS). SuiteLink processing updates business addresses with secondary information when known."
},
{
"value":"SUP",
"displayValue":"Suppression Suite",
"description":"Suppression Suite. Suppression Suite processing identifies records in your address table that match to common suppression/pander files including Direct Marketing Association (DMA) Mail Preference Service, Deceased, Prison and Business."
},
{
"value":"DEC",
"displayValue":"Deceased Suppression",
"description":"Deceased Suppression. Deceased Suppression processing identifies deceased individuals in your address table using a database derived from Social Security Administration records and other proprietary sources."
},
{
"value":"DMA",
"displayValue":"DMA Suppression",
"description":"DMA Suppression. DMA Suppression processing identifies individuals in your address table who have registered with the Direct Marketing Association (DMA) Mail Preference Service (MPS) to indicate that they do not wish to receive unsolicited mail."
},
{
"value":"ARS",
"displayValue":"Address Resolution",
"description":"Address Resolution/DPV/LACSLink/SuiteLink. Address Resolution processing attempts to resolve incorrect or incomplete addresses using several methods. It can correct both primary and secondary information using proprietary databases."
},
{
"value":"GEO",
"displayValue":"Rooftop Geocoding",
"description":"Rooftop Geocoding/DPV/LACSLink/SuiteLink. Rooftop Geocoding processing updates your address table with exact latitude and longitude coordinates."
},
{
"value":"PCA",
"displayValue":"PCOA",
"description":"PCOA/DPV/LACSLink/SuiteLink. PCOA processing updates your address table using 60 months of Change Of Address (COA) data from a proprietary database."
},
{
"value":"CPL",
"displayValue":"COMPLIANCE+",
"description":"COMPLIANCE+. Address Resolution processing attempts to resolve incorrect or incomplete addresses using several methods. It can correct both primary and secondary information using proprietary databases. PCOA processing updates your address table using 60 months of Change Of Address (COA) data from a proprietary database. NCOALink FSP processing updates your address table using 48 months of data from the database of Change Of Address (COA) forms filed with the Postal Service."
}
]
},
"ncoaLinkOnly":{
"title":"NCOALink Only",
"description":"When bundling processes, indicates whether or not to limit the processes to NCOALink.",
"type":"boolean"
},
"service":{
"title":"Requested Turnaround Time",
"description":"Specifies the level of service requested, which determines turnaround time.",
"type":"string",
"enum":[
"1BusinessDay",
"sameDay"
],
"enumValues":[
{
"value":"1BusinessDay",
"displayValue":"1 Business Day",
"description":"Requests turnaround within one business day."
},
{
"value":"SameDay",
"displayValue":"Same Day",
"description":"Requests turnaround within the same day."
}
]
},
"prepaid":{
"title":"Prepaid / Subscription",
"description":"Indicates whether or not to use prepaid credits or a subscription to pay for the order.",
"type":"boolean"
},
"poNumber":{
"title":"PO Number",
"description":"Purchase order number.",
"type":"string",
"minLength":1
},
"destinationFolder":{
"title":"Destination Folder",
"description":"Path to the folder in which to create the job, return job and reports files.",
"type":"string",
"minLength":1
},
"fileName":{
"title":"Reports File Name",
"description":"Name of the reports file.",
"type":"string",
"minLength":1
},
"overwrite":{
"title":"Overwrite",
"description":"Indicates whether or not to overwrite an existing reports file.",
"default":false,
"type":"boolean"
},
"addressTable":{
"title":"Address Table",
"description":"Resource item identifying the address table.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"addressGroups":{
"title":"Address Groups",
"description":"Specifies which address group or groups to process.",
"type":"string",
"enum":[
"MAIN",
"ALT1",
"ALT2",
"MAIN ALT1",
"MAIN ALT2",
"ALT1 ALT2",
"MAIN ALT1 ALT2"
],
"enumValues":[
{
"value":"MAIN",
"displayValue":"Main Address Group",
"description":"Processes Main Address Group."
},
{
"value":"ALT1",
"displayValue":"Alternate Address Group 1",
"description":"Processes Alternate Address Group 1."
},
{
"value":"ALT2",
"displayValue":"Alternate Address Group 2",
"description":"Processes Alternate Address Group 2."
},
{
"value":"MAIN ALT1",
"displayValue":"Main Address Group and Alternate Address Group 1",
"description":"Processes Main Address Group and Alternate Address Group 1."
},
{
"value":"MAIN ALT2",
"displayValue":"Main Address Group and Alternate Address Group 2",
"description":"Processes Main Address Group and Alternate Address Group 2."
},
{
"value":"ALT1 ALT2",
"displayValue":"Alternate Address Group 1 and Alternate Address Group 2",
"description":"Processes Alternate Address Group 1 and Alternate Address Group 2."
},
{
"value":"MAIN ALT1 ALT2",
"displayValue":"Main Address Group, Alternate Address Group 1 and Alternate Address Group 2",
"description":"Processes Main Address Group, Alternate Address Group 1 and Alternate Address Group 2."
}
]
},
"bypassNameMissing":{
"title":"Bypass Name Missing",
"description":"Indicates whether or not to bypass processing of records with no name.",
"default":false,
"type":"boolean"
},
"bypassAddressMissing":{
"title":"Bypass Address Missing",
"description":"Indicates whether or not to bypass processing of records with no address.",
"default":false,
"type":"boolean"
},
"bypassStateInvalid":{
"title":"",
"description":"Indicates whether or not to bypass processing of records with no valid state.",
"default":false,
"type":"boolean"
},
"bypassNonUsps":{
"title":"",
"description":"Indicates whether or not to bypass processing of records with no valid USPS ZIP Code.",
"default":false,
"type":"boolean"
},
"extendedMatching":{
"title":"ZIP+4 Extended Matching",
"description":"Indicates whether or not to try harder to match to the USPS ZIP+4 database, even though doing so increases the chance of a false match.",
"default":false,
"type":"boolean"
},
"matchingOption":{
"title":"NCOALink Matching Option",
"description":"For NCOALink processing: Specifies which change of address (COA) to match to.",
"default":"S",
"enum":[
"B",
"C",
"I",
"R",
"S"
],
"enumValues":[
{
"value":"B",
"displayValue":"Business Only",
"description":"Matches only to business changes of address."
},
{
"value":"C",
"displayValue":"Individual and Business Only",
"description":"Matches only to individual and business (not family) changes of address."
},
{
"value":"I",
"displayValue":"Individual Only",
"description":"Matches only to individual changes of address."
},
{
"value":"R",
"displayValue":"Residential",
"description":"Matches only to residential (individual and family) changes of address."
},
{
"value":"S",
"displayValue":"Standard",
"description":""
}
]
},
"numberOfMonthsRequested":{
"title":"Number of Months of COA Data Requested",
"description":"For NCOALink processing: Number of months of change of address (COA) data to match to.",
"type":"integer",
"minimum":6,
"maximum":48
},
"frequencyOfProcessing":{
"title":"NCOALink Frequency of Processing",
"description":"For NCOALink processing: The number of times per year that the address table is expected to be NCOALink processed.",
"type":"integer",
"minimum":1,
"maximum":52
},
"pafIdentifier":{
"title":"PAF Identifier",
"description":"For NCOALink processing: Identifies the Processing Acknowlegement Form (PAF) in BCC Software's database.",
"type":"integer",
"minimum":1
},
"classOfMail":{
"title":"Classes of Mail",
"description":"For NCOALink processing: The class or classes of mail that will be used for mailings prepared using the address table.",
"type":"string",
"enum":[
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O"
],
"enumValues":[
{
"value":"A",
"displayValue":"First-Class only",
"description":"Specifies that only First-Class will be used."
},
{
"value":"B",
"displayValue":"Periodicals only",
"description":"Specifies that only Periodicals will be used."
},
{
"value":"C",
"displayValue":"Standard Mail only",
"description":"Specifies that only Standard Mail will be used."
},
{
"value":"D",
"displayValue":"Package Services only",
"description":"Specifies that only Package Services will be used."
},
{
"value":"E",
"displayValue":"First-Class and Periodicals",
"description":"Specifies that First-Class and Periodicals will be used."
},
{
"value":"F",
"displayValue":"First-Class and Standard Mail",
"description":"Specifies that First-Class and Standard Mail will be used."
},
{
"value":"G",
"displayValue":"First-Class and Package Services",
"description":"Specifies that First-Class and Package Services will be used."
},
{
"value":"H",
"displayValue":"Periodicals and Standard Mail",
"description":"Specifies that Periodicals and Standard Mail will be used."
},
{
"value":"I",
"displayValue":"Periodicals and Package Services",
"description":"Specifies that Periodicals and Package Services will be used."
},
{
"value":"J",
"displayValue":"Standard Mail and Package Services",
"description":"Specifies that Standard Mail and Package Services will be used."
},
{
"value":"K",
"displayValue":"First-Class, Periodicals and Standard Mail",
"description":"Specifies that First-Class, Periodicals and Standard Mail will be used."
},
{
"value":"L",
"displayValue":"First-Class, Periodicals and Package Services",
"description":"Specifies that First-Class, Periodicals and Package Services will be used."
},
{
"value":"M",
"displayValue":"First-Class, Standard Mail and Package Services",
"description":"Specifies that First-Class, Standard Mail and Package Services will be used."
},
{
"value":"N",
"displayValue":"Periodicals, Standard Mail and Package Services",
"description":"Specifies that Periodicals, Standard Mail and Package Services will be used."
},
{
"value":"O",
"displayValue":"First-Class, Periodical, Standard Mail and Package Services",
"description":"Specifies that First-Class, Periodical, Standard Mail, Package Services will be used."
}
]
},
"mailingZipCode":{
"title":"Mailing ZIP Code",
"description":"For NCOALink processing: The ZIP code of the USPS facility that mail will be submitted to for mailings prepared using the address table.",
"type":"string",
"minLength":1,
"maxLength":5
},
"buyerCompanyName":{
"title":"",
"description":"For NCOALink processing: The name of the company that will rent, purchase or lease the updated addresses (if any).",
"type":"string",
"minLength":1
},
"arsSendNonZip4":{
"title":"Send Records not DPV Confirmed",
"description":"For ARS processing: Indicates whether or not to send addresses for processing that were not previously confirmed using USPS Delivery Point Validation (DPV).",
"default":false,
"type":"boolean"
},
"arsSendDefault":{
"title":"",
"description":"For ARS processing: Indicates whether or not to send addresses for processing that previously matched to a default record in the USPS ZIP+4 database, which may indicate that the address is inexact or incomplete.",
"default":false,
"type":"boolean"
},
"case":{
"title":"Return Case",
"description":"The case to use when updating address elements in the address table.",
"default":"UPPER",
"enum":[
"ASIS",
"AUTO",
"LOWER",
"MIXED",
"UPPER"
],
"enumValues":[
{
"value":"ASIS",
"displayValue":"As Is",
"description":"Specifies the case to use when converting updated address elements before using them to update the address table."
},
{
"value":"AUTO",
"displayValue":"Auto Convert",
"description":"Does not touch address elements."
},
{
"value":"LOWER",
"displayValue":"lower",
"description":"Converts address elements to lower case."
},
{
"value":"MIXED",
"displayValue":"Mixed",
"description":"Converts address elements to mixed case."
},
{
"value":"UPPER",
"displayValue":"UPPER",
"description":"Converts address elements to upper case."
}
]
},
"standardizeAddress":{
"title":"Standardize Address",
"description":"Indicates whether or not to update the address table with an address that was standardized against the USPS ZIP+4 database.",
"default":false,
"type":"boolean"
},
"standardizeCity":{
"title":"Standardize City",
"description":"Indicates whether or not to update the address table with an city that was standardized against the USPS ZIP+4 database.",
"default":false,
"type":"boolean"
},
"abbreviateCity":{
"title":"Abbreviate City",
"description":"Indicates whether or not to use the standard abbreviation of the city from the USPS ZIP+4 database.",
"default":false,
"type":"boolean"
},
"hideMovesOutOfState":{
"title":"Hide Moves Out Of State",
"description":"Indicates whether or not to delete records from the address table if there was a change in state.",
"default":false,
"type":"boolean"
},
"hideReturnCodes":{
"title":"Hide Return Codes",
"description":"Specifies which records to delete from the address table based on the value of the Return Code field. The value is a space-separated list of Return Code values.",
"type":"string",
"minLength":1
},
"accountUserId":
{
"title":"Account User ID",
"description":"BCC Customer Portal user ID.",
"type":"string",
"minLength":1
},
"accountPassword":
{
"title":"Account Password",
"description":"BCC Customer Portal pasword.",
"type":"string",
"minLength":1
}
},
"additionalProperties":false
}
