stile
PlaygroundCompliance

Check compliance requirements

Returns regulatory details for one or more use cases in a jurisdiction, plus a most-restrictive merged summary. No request body; all parameters are query strings.

GET
/v1/compliance/check

Authorization

BearerAuth
AuthorizationBearer <token>

Use a secret API key as the bearer token. Keys are prefixed with vk_test_ (test mode) or vk_live_ (live mode).

In: header

Query Parameters

use_cases*string

Comma-separated use cases (e.g. alcohol_delivery,tobacco_nicotine). Max 10.

jurisdiction?string

ISO 3166 code (e.g. US-CA). Auto-detected from IP if omitted.

Match^[A-Z]{2}(-[A-Z0-9]{2,3})?$

Response Body

application/json

application/json

curl -X GET "http://localhost:3000/v1/compliance/check?use_cases=string"
{
  "jurisdiction": "string",
  "jurisdiction_source": "explicit",
  "results": [
    {
      "use_case": "string",
      "jurisdiction": "string",
      "prohibited": true,
      "prohibited_reason": "string",
      "required_age_tier": "string",
      "allowed_methods": [
        "string"
      ],
      "mdl_acceptance_status": "string",
      "governing_regulator": "string",
      "legal_citations": [
        "string"
      ],
      "data_retention_days": 0,
      "biometric_retention_days": 0,
      "consent_required": true,
      "consent_text": "string",
      "privacy_frameworks": [
        "string"
      ],
      "penalty_description": "string",
      "penalty_type": "string",
      "credential_validity_days": 0,
      "rule_version": "string"
    }
  ],
  "most_restrictive": {
    "required_age_tier": "string",
    "allowed_methods": [
      "string"
    ],
    "consent_required": true,
    "data_retention_days": 0,
    "any_prohibited": true,
    "prohibited_use_cases": [
      "string"
    ]
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "request_id": "string"
  }
}