docs.vario.lat
This page was machine-translated and is pending human review.

GET /api/v1/playbooks

Returns the list of available playbooks: the combinations of conduct_type and language that the analysis endpoint accepts as valid values.


Authentication

Requires an API key with the playbooks:list scope.

Authorization: Bearer vario_YOUR_API_KEY

Parameters

This endpoint does not accept a body or query parameters.


Response

HTTP 200 — success

{
  "playbooks": [PlaybookEntry]
}

Response structure

FieldTypeDescription
playbooksarrayList of PlaybookEntry objects. May grow in future versions.

PlaybookEntry

FieldTypeDescription
conduct_typestringConduct identifier. Use this value in the playbook field of POST /analyze.
languagesarray[string]ISO 639-1 codes of the languages supported for this playbook.
descriptionstringBrief description of the conduct.
versionstringPlaybook version.

Available conducts

conduct_typeConductLanguages
price_fixingPrice fixinges, en
bid_riggingBid rigginges, en
briberyBribery and anti-corruptiones, en
market_manipulationMarket abusees, en
information_exchangeCommercially sensitive information exchangees, en
group_boycottGroup boycottes, en
conflict_of_interestUndisclosed conflicts of interest and self-dealinges, en
insider_tradingInsider trading and tippinges, en
internal_fraudInternal fraud, embezzlement and expense fraudes, en

When to call this endpoint

  • When initializing the integration: obtain valid conduct_type values before constructing any request to POST /analyze. Sending an unrecognized playbook value returns 400 INVALID_PLAYBOOK.
  • To detect new playbooks: vario will incorporate new conducts in future versions. Call this endpoint dynamically rather than hardcoding the values, so your integration supports them automatically.

Complete example

Request:

curl https://api.vario.lat/v1/playbooks \
  -H "Authorization: Bearer vario_YOUR_API_KEY"

Response:

{
  "playbooks": [
    {
      "conduct_type": "price_fixing",
      "languages": ["es", "en"],
      "description": "Price coordination between competitors",
      "version": "1.0"
    },
    {
      "conduct_type": "bid_rigging",
      "languages": ["es", "en"],
      "description": "Bid manipulation and procurement fraud",
      "version": "1.0"
    },
    {
      "conduct_type": "bribery",
      "languages": ["es", "en"],
      "description": "Bribery and anti-corruption violations",
      "version": "1.0"
    },
    {
      "conduct_type": "market_manipulation",
      "languages": ["es", "en"],
      "description": "Market abuse",
      "version": "1.0"
    },
    {
      "conduct_type": "information_exchange",
      "languages": ["es", "en"],
      "description": "Commercially sensitive information exchange between competitors",
      "version": "1.0"
    },
    {
      "conduct_type": "group_boycott",
      "languages": ["es", "en"],
      "description": "Group boycott and concerted exclusion practices",
      "version": "1.0"
    },
    {
      "conduct_type": "conflict_of_interest",
      "languages": ["es", "en"],
      "description": "Undisclosed conflicts of interest and self-dealing",
      "version": "1.0.0"
    },
    {
      "conduct_type": "insider_trading",
      "languages": ["es", "en"],
      "description": "Insider trading and tipping",
      "version": "1.0.0"
    },
    {
      "conduct_type": "internal_fraud",
      "languages": ["es", "en"],
      "description": "Internal fraud, embezzlement and expense fraud",
      "version": "1.0.0"
    }
  ]
}

Possible errors

HTTPCodeDescription
401MISSING_AUTHAuthorization header missing.
401INVALID_API_KEYAPI key not found, expired, or inactive.
402SUBSCRIPTION_REQUIREDThe tenant does not have an active subscription.
403INSUFFICIENT_SCOPEThe API key does not have the playbooks:list scope.
429RATE_LIMIT_EXCEEDEDRate limit reached. See the Retry-After header.

Note on future versions

vario will add new playbooks and new languages in future versions. It is recommended to call GET /playbooks dynamically when starting each integration session rather than hardcoding the conduct list. conduct_type values are stable once published — they are not renamed between minor versions.

The API output is a risk signal, not a legal determination. It does not substitute a lawyer's review and does not constitute evidence before regulators on its own.