SERP Address Validation via Verify API - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

The Verify API (transaction and bulk) now supports the Software Evaluation and Recognition Program (SERP) attributes. SERP return codes, provided by Canada Post, indicate the quality of the input address.

SERP Validation Codes:
  • V: Valid Address. The input address was validated as correct.
  • C: Correctable Address. The input address can be corrected to a valid match.
  • N: No Match. The input address could not be matched or corrected.

Implementation

To enable SERP validation, include the SERP_MODE parameter within the customPreferences object of your API request. Set SERP_MODE to true and ensure DATA_OPTION is set to enterprise.

Example Request (customPreferences):
JSON
 
"customPreferences": {
  "SERP_MODE": "true",
  "DATA_OPTION": "enterprise",
  "RETURN_PARSED_INPUT": "true"
}
The SERP validation code, along with other related SERP attributes, will be returned in the Custom Fields section of the API response.
Table 1.
MOA-CAN-OQR-RC Output location for Questionable Rural Return Codes:

API returns values as Y and N

MOA-CAN-OQR-RC: Y. Questionable address (inconsistent address)

MOA-CAN-OQR-RC: N. Managed Rural Postal Code (converted civic address)
MOA-CAN-OAPT-RC

Returns values related to apartment information:

A: No apartment provided

B: Apartment matched
MOA-CAN-RPARSE-BOXNUM Normalized input lock box number
MOA-CAN-RPARSE-STREET-DIR Normalized input directional
SERP_ADDRESS_LINE1 SERP formatted Address Line 1
SERP_VALIDATION_CODE

The quality of the input address as determined by Canada Post's Software Evaluation and Recognition Program:

V: Validated

C: Correctable

N: No Match