Skip to navigation

Retrieve a country compliance config

View as Markdown

Returns the workspace’s saved config for one country. When none has been saved, data is null, not a 404. In that case the country defaults from GET /api/compliance/defaults/{countryCode} apply.

This returns the stored row, not the effective rules. A null consent_script or require_ai_disclosure here is filled from the country default when a call is placed.

Access

  • Required scope: read or write. Any signed-in workspace role.
  • Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See Rate limits.
  • Plan: Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

countryCodeenumRequired

ISO 3166-1 alpha-2 code of a supported country, in upper case. CO Colombia, MX Mexico, BR Brazil, US United States, AR Argentina, CL Chile, PE Peru. Any other value, including lower case, returns 400.

Response

The config, or null.

dataobject or null

A saved per-country compliance config. Fields left null fall back to the country default when a call is placed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error