Docs

Getting started

Create a workspace, mint an API key, and make your first authenticated call to CLEARIE™ GETWAY.

1. Create a workspace

Sign up in the Clearie Getway portal. The wizard collects your email, company, country, and tax identifier. We verify your email with a 6-digit OTP; paid workspaces activate only after payment confirmation.

Choose the plan that fits your workspace. The free Developer plan includes 2,500 weighted API units per month, 0 AI credits, and category-specific limits of up to 5 requests per second.

2. Mint an API key

Open Dashboard → API Keys → New key. Keys have a public prefix (ck_live_ or ck_sbox_) and a secret half shown only once. Store the secret in your secret manager.

# Save the secret half once — it cannot be retrieved later.
export CLEARIE_KEY="ck_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

3. Make a call

All endpoints require a Bearer token. JSON in, JSON out, UTF-8, gzip-supported.

curl -H "Authorization: Bearer $CLEARIE_KEY" \
     https://getway.clearie.neximprove.com/v1/master/hsn/exports?code=2710