Skip to main content

Getting started

1. Get a touchpoint credential

A touchpoint is created by a Business admin in the BackOffice (Settings → Touchpoints). Creating one returns a code and a key — the key is shown once, so store it securely on your backend; never ship it inside a public mobile app bundle or client-side web code where it could be extracted. If your touchpoint is a browser app with no backend of its own, talk to your Thalamus Lite contact about the right integration shape for that case.

2. Pick your base URL

EnvironmentBase URL
Local developmenthttp://localhost:8080
Testhttps://edge.test.thalamuscloud.com
Production (EU cell)https://edge.eur001.thalamuscloud.com

Every environment exposes the identical API — only the host changes.

3. Make your first call

Every /api/v1/* call requires the touchpoint credential as two headers:

curl -sX GET "https://edge.test.thalamuscloud.com/api/v1/reference/countries" \
-H "X-Touchpoint-Code: <your-code>" \
-H "X-Touchpoint-Key: <your-key>"

A missing or wrong credential returns 401 TOUCHPOINT_UNAUTHORIZED — see Errors & rate limits for the full error envelope.

4. Register and log in a consumer

TP=(-H "X-Touchpoint-Code: <your-code>" -H "X-Touchpoint-Key: <your-key>" -H "Content-Type: application/json")

# Instant registration (only when the touchpoint requires no channel proof)
curl -sX POST "https://edge.test.thalamuscloud.com/api/v1/register" "${TP[@]}" \
-d '{"type":"PERSON","firstName":"Ada","lastName":"Lovelace","password":"Secret123!"}'
# → 201 { "customerId": "...", "token": "<Customer JWT>" }

curl -sX POST "https://edge.test.thalamuscloud.com/api/v1/login" "${TP[@]}" \
-d '{"identifier":"ada@example.com","password":"Secret123!"}'
# → 200 { "customerId": "...", "token": "<Customer JWT>" }

Attach the returned token as Authorization: Bearer <token> on any customer-scoped call, e.g. GET /api/v1/me. Full walkthroughs — including the verified-registration flow — are in Registration and Login & profile.

5. Browse and try any method

API Reference has every method as its own page in the sidebar, grouped by category (Registration, Login & session, Self-service profile, …). Pick one and the page shows only that method: headers, the request body with a working JSON example, a Send API Request button (enter your touchpoint credential under Authentication first), and the response — status codes and JSON — right below it.