Address layouts
An address layout tells the engine how many input lines you have, how long each line is, and what address elements to expect on each. Pick the layout that matches the shape of the data you're sending — Nova ships a starter catalog, and you can define custom ones via SetAddressLayout.
Use GetLayoutDetails to retrieve the field-level schema of any layout before building forms.
Catalog#
| Layout name | Shape | Typical use |
|---|---|---|
oneStop Address Layout | Single free-form line. | Address-capture autocomplete (used by OneStopAnalyze). |
Address in Single Line | Single free-form line. | Free-form correction. |
ADDR x2 LAST LINE | Two address lines + last line (City Province PostalCode). | Shipping labels, three-line printed addresses. |
ADDR x2 LAST LINE STATUS | Two address lines + last line + status field. | Batch correction with a status-per-record audit trail. |
ADDR x2 MNC PROV PC | Two address lines + municipality + province + postal code split. | ERP integrations with separate columns. |
FREE FORM x3 | Three free-form lines. | Three-line free-form input. |
FREE FORM x4 | Four free-form lines. | Four-line free-form input. |
FREE FORM x5 | Five free-form lines. | Five-line free-form input. |
MSCR M50 | Mortgage standard — long single field. | Canadian mortgage record format. |
SERP TEST | SERP audit format. | SERP / Canada Post evaluation runs. |
nCode Reserved Element Format | Per-element field map. | Advanced API consumers; pre-parsed input. |
nCode Reserved Free Format | Free-form internal layout. | Internal use; rarely surfaced. |
Choosing a layout#
- Building an autocomplete widget? Use
oneStop Address Layout. - Have structured columns from a CRM/ERP? Use
ADDR x2 LAST LINEorADDR x2 MNC PROV PC. - Bulk import of free-form text? Use
FREE FORM x3/x4/x5depending on how many lines per record. - Running a SERP audit? Use
SERP TESTto produce output Canada Post will accept.
Custom layouts#
Define a new layout with SetAddressLayout. Custom layouts live under your customer namespace and are visible only to your license keys. See Parameters for full details.