Skip to main content
The Enrichment API is closed by default. Every endpoint requires a valid API key bound to a merchant organization — there is no anonymous or trial access. Requesting a key is always your first step.
Do not start building against the API before you have a key and scopes. Without a valid X-Api-Client-Key header, every authenticated endpoint responds with 401 Unauthorized.

​
How to request one

1

Contact the Verzla integrations team

Email [email protected] (or your existing Verzla contact) and tell us:
  • The merchant organization you’ll be enriching for.
  • A short label for the integration (e.g. acme-ai-enrichment) — this appears in the merchant’s API client list.
  • Which scopes you need: read-only (catalog:read), submit (catalog:submit), or both.
2

We issue your credentials

Verzla creates an API client for the organization and returns a single raw API key. The key is shown to you exactly once — we only store a SHA-256 hash of it and can never recover the original.
3

Store the key securely

Treat the key like a password. Put it in a secret manager or environment variable — never commit it to source control or expose it to a browser.

​
Scopes

Your key is granted a comma-separated set of scopes. Each endpoint checks for a specific scope and returns 403 Forbidden if your key lacks it.
ScopeGrants access to
catalog:readRead attribute templates and products (export + SKU lookup), read your acceptance rate
catalog:submitSubmit enrichment proposals
A typical full integration is issued both scopes. If you only need to analyze the catalog without writing back, catalog:read alone is enough.

​
What you receive

When the key is issued, your integration is tied to:
  • One organization — the merchant whose catalog you may read and enrich. The organization is resolved automatically from your key; you never pass an org ID.
  • Your scopes — the exact operations your key is allowed to perform.
  • A label and activity tracking — the merchant can see your client, its lastUsedAt timestamp, and deactivate it at any time.
Lost a key or suspect it leaked? Contact us to rotate it. The old key is deactivated immediately and a new raw key is issued.
Once you have your key, head to Making authenticated requests.