Obtaining SERP Return Codes - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

SERP return codes indicate the quality of the input address as determined by the Canada Post's Software Evaluation and Recognition Program regulations.

To obtain SERP return codes, specify Option.OutputRecordType=P. For more information on Option.OutputRecordType, see Output Data Options.

SERP return codes are provided in the following output field.

Table 1. SERP Return Code Output

Response Element

Description

CanadianSERPCode

Validation/correction return code (Canadian addresses only):

V
The input was valid. Canada Post defines a "valid" address as an address that meets all the following requirements:
Note: There are exceptions. For further information, contact the CPC.
  • The address must contain all required components as found in CPC's Postal Code Data Files.
  • The address must provide an exact match on all components for only one address in CPC's Postal Code Data Files, allowing for acceptable alternate words and names listed in the CPC Postal Code Data Files.
  • Address components must be in a form that allows recognition without ambiguity. Certain components may require "qualifiers" to identify them. For instance, a Route Service address requires the key words "Rural Route" or "RR" for differentiation from a "Suburban Service" or "SS" address with the same number.
  • The address must contain a valid rural or LVR (Large Volume Receiver) Postal Code that is non-correctable (VN). The VN record type returns Y in the "DefaultValidPostalCode" output field.
C
The input was correctable. A "correctable" address is one that can be corrected to match one, and only one, address.
N
The input was non-correctable. A "non-correctable" address is one that could be corrected a number of different ways such that ValidateAddress cannot identify a single correct version.
F
The input address was foreign (outside of Canada).