Quickstart

You can be hitting a live address-validation endpoint in under five minutes. This walkthrough covers OneStopAnalyze — the single-call method that handles parse, correct, and validate.

1. Get your license key#

Sign in and copy a key from Pack Management → API keys. Or sign up for a Trial pack (500 lookups, no credit card).

2. Set environment variables#

export NCODE_CUSTOMER="AcmeLogistics"
export NCODE_KEY="nck_live_…"
export NCODE_BASE="<your nCodeWS4C1 base URL — provided by Nova>"

3. Make your first call#

curl $NCODE_BASE/OneStopAnalyze \
-H "Authorization: $NCODE_CUSTOMER|$NCODE_KEY" \
-H "Content-Type: application/json" \
-d '{
  "AddressLayout": "oneStop Address Layout",
  "AnalysisMode": "oneStop Analysis Mode",
  "CorrectionStyle": "MIXED KYWD",
  "AddressLinesIn": [{ "strName": "", "strContent": "100 King St W Toronto ON M5X 1A9" }],
  "MaxAlternatives": 5
}'

4. Read the response#

A successful response has intRetCode: 0 and a strStatus of V (valid), C (correctable), or N (non-correctable). The Alternatives array carries one or more parsed-and-corrected addresses.

{
"intRetCode": 0,
"strMessage": "OK",
"strStatus": "V",
"HashCode": "F8…2A",
"Alternatives": [
  {
    "AddressElements": {
      "TypeOfAddress": "AES_StreetAddress",
      "StreetNumberFrom": "100",
      "StreetName": "KING",
      "StreetType": "ST",
      "StreetDirection": "W",
      "Municipality": "TORONTO",
      "Province": "ON",
      "PostalCode": "M5X 1A9"
    }
  }
]
}

Next steps#

• See OneStopAnalyze for all request and response fields.
• See Address layouts, Analysis modes, and Correction styles for the parameter catalogs.
• See Status codes for the full set of return codes.
• See Code samples for full integration examples in C# .NET and Java.