Authentication

Every request to nCodeCloud is authenticated with an Authorization header containing your customer name and license key joined by a pipe (|).

Request header#

http

Authorization: <customer>|<licenseKey>
Content-Type: application/json

There is no bearer token, no OAuth handshake, and no per-request signing. The header is sent on every call to every endpoint.

Getting a license key#

Sign in to the customer portal and create a new key from Pack Management → API keys. Each key is scoped to one customer organization, one pricing pack, and one production environment (separate keys for sandbox).

Keys never expire on their own. Revoke a compromised key from the same panel — the change propagates within seconds.

Example call#

bash

curl $NCODE_BASE/OneStopAnalyze \
-H "Authorization: AcmeLogistics|nck_live_a3b7c2…f9" \
-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
}'

Demo key#

The Live demo and the demo endpoints under /api/demo/* use a shared demo license key scoped to public traffic. The key is server-side only — your application code never sees it. Demo traffic is rate-limited per IP and stripped of internal fields before responses leave the proxy.

Do not use the demo key for production integrations. Sign up for a Trial pack instead — 500 lookups, full API access, no credit card required.

Errors#

A bad or missing Authorization header returns intRetCode: 401 with a descriptive strMessage. Revoked keys return 403. See Status codes for the full list.