A Nova Marketing Group service
nCodeCloud
Sign in
Docsmenu

Transform methods

Three methods reshape addresses without re-running the full correction pipeline.

TransformAddress#

http
POST /TransformAddress

Takes an address record under one layout and emits the same address under another layout. Works completely on valid and correctable addresses; partial transforms on non-correctable input.

A common workflow: capture with OneStopAnalyze using the oneStop Address Layout, then call TransformAddress to render the result in ADDR x2 LAST LINE for shipping labels.

NameTypeDescription
FromLayoutRequiredstringSource layout. Should match the records.AddressLinesIn.
ToLayoutRequiredstringDestination layout for AddressLinesOut.
AnalysisModeRequiredstringSee /docs/modes.
CorrectionStyleRequiredstringSee /docs/styles.
AddressLinesInRequiredLineContent[]Address to transform.
bash
curl $NCODE_BASE/TransformAddress \
-H "Authorization: AcmeLogistics|nck_live_…" \
-H "Content-Type: application/json" \
-d '{
  "FromLayout": "Address in Single Line",
  "ToLayout": "ADDR x2 LAST LINE",
  "AnalysisMode": "oneStop Analysis Mode",
  "CorrectionStyle": "UPPER KYWD NO ACCENTS",
  "AddressLinesIn": [{ "strName": "", "strContent": "100 King St W Toronto ON M5X 1A9" }]
}'

FormatAddress#

http
POST /FormatAddress

Re-formats a structured address record (from SearchForAddresses or AnalyzeGetAlternatives.Alternatives[].AddressElements) into displayable lines under a chosen layout and correction style. No correction is performed — the input is treated as already-canonical.

FormatPE#

http
POST /FormatPE

Converts a parser variant (output of ParseAddress) into an address record. Rarely used — primarily for advanced workflows that walk the parser output directly. See Search for ParseAddress usage.