SERP Parameters

SERP is Canada Post’s Software Evaluation and Recognition Program to evaluate third-party software. You can learn more about SERP parameters.

The following tables explain the input and output parameters for SERP.

Table 1. Input Parameters
Attribute	Required
`Address1`	Yes
`Address2`	No
`Locality`	No
`AdministrativeArea`	No
`PostalCode`	No
`Country`	No

Output Parameters - Once SERP is enabled, the following three cleanse attributes must be defined and configured in the output mapping.

Table 2. Output Parameters
Attribute	Required
`SerpStatusEx`	Indicates the status of SERP execution. Following are the possible values: `V` indicates `Valid` `C` indicates `Correctable`; Correctable fields are corrected to their right values in the output `N` indicates `Invalid`
`Questionable`	Indicates that the address is questionable as per SERP. Following are the possible values: `QR` indicates `Questionable-Rural` `QU` indicates `Questionable-Urban` No value indicates that the address is not questionable
`Result`	Indicates whether the address is valid. A value of `VALID` means the address is valid. If not valid, the value contains a series of three-character codes describing address component issues, such as `17M` (missing suite identifier) or `11I` (incorrect civic number).

Output Mapping Sample

{
  "attribute": "configuration/entityTypes/Location/attributes/SerpStatusEx",
  "mandatory": false,
  "allValues": false,
  "cleanseAttribute": "SerpStatusEx"
},
{
  "attribute": "configuration/entityTypes/Location/attributes/Questionable",
  "mandatory": false,
  "allValues": false,
  "cleanseAttribute": "Questionable"
},
{
  "attribute": "configuration/entityTypes/Location/attributes/Result",
  "mandatory": false,
  "allValues": false,
  "cleanseAttribute": "Result"
}

SERP Attributes Sample Configuration

{
	"uri": "configuration/entityTypes/Location/attributes/SerpStatusEx",
	"label": "SerpStatusEx",
	"name": "SerpStatusEx",
	"description": "",
	"type": "String",
	"hidden": false,
	"important": false,
	"attributeOrdering": {
	  "orderingStrategy": "LUD"
	}
  },
  {
	"uri": "configuration/entityTypes/Location/attributes/Questionable",
	"label": "Questionable",
	"name": "Questionable",
	"description": "",
	"type": "String",
	"hidden": false,
	"important": false,
	"attributeOrdering": {
	  "orderingStrategy": "LUD"
	}
  },
  {
	"uri": "configuration/entityTypes/Location/attributes/Result",
	"label": "Result",
	"name": "Result",
	"description": "",
	"type": "String",
	"hidden": false,
	"important": false,
	"attributeOrdering": {
	  "orderingStrategy": "LUD"
	}
  }

Note: The mappings and attributes are not added by default. The value of verificationStatus is updated by using the cleanse attribute SerpStatusEx instead of AVC for Canada addresses when the SERP process is used.

Understanding Result Codes

The Result field in SERP output either shows VALID or a set of diagnostic codes indicating problems with the address. These codes help identify issues with specific address components and whether they are missing, incorrect, or fixable.

Each result code includes:

A classification letter (optional, at the beginning)
A two-digit number that identifies the address component
A one-letter status code

Examples:

C17M – Correctable issue: Suite identifier is missing.
N10I11I62M – Non-correctable issues: Street and civic number are incorrect; province is missing.

Table 3. Classification Codes
Code	Description
C	Invalid but correctable address
N	Invalid and non-correctable address
I	Invalid address
O	Optional (correctable)
Q	Questionable

Note: Not all address components listed in Canada Post reference materials are supported by Reltio's SERP integration. Components related to General Delivery, Delivery Installation, and Route Service are not mapped in the platform.

Table 4. Address Component Codes
Code	Address Component
00	Complete Address
01	Addressee and/or Additional Delivery Information
10	Complete Street Information
11	Civic number
12	Civic number suffix
13	Street name
14	Street type
15	Street direction
16	Suite keyword
17	Suite identifier
19	Delivery Information
20	Complete Route Service Information
22	Route Service keyword
24	Route Service identifier
30	Complete PO Box/Bag Information
32	PO Box/Bag keyword
34	PO Box/Bag identifier
40	Complete General Delivery Information
42	General Delivery keyword
50	Complete Delivery Installation Information
52	Delivery Installation Area Name
54	Delivery Installation Type
56	Delivery Installation Qualifier
60	Municipality
62	Province
64	Postal Code
81	Typo
98	Too Many Errors
99	Correction does not fit

Table 5. Status Codes
Code	Meaning
M	Missing
I	Inconsistent or incorrect
T	Typo
(blank)

Unify and manage your data

SERP Parameters

Output Mapping Sample

SERP Attributes Sample Configuration

Understanding Result Codes

Footer