Skip to content
Vimine for developers
EN

One legal text, rendered

GET
/v1/legal/{kind}
curl --request GET \
  --url 'https://api.vimine.network/v1/legal/example?locale=it'

The in-force version of a kind (or ?version= for an archived one), placeholders resolved with the operator identity and the sub-processor registry. ?locale=it|en with fallback to Italian (the Italian text prevails). Tenant-facing templates (DPA and annexes) show generic labels where the association’s own data goes.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required

Document kind

string

Query Parameters

Section titled “Query Parameters”
locale
string
Allowed values: it en zh-Hans zh-Hant fr es de pt-BR
version

A specific published version

string

Responses

Section titled “Responses”

200

Section titled “200”

Document

Media typeapplication/json
object
uid
string format: uuid
kind
required

Document kind (platform_terms, platform_privacy, platform_cookie, aps_terms, aps_dpa, aps_dpa_annex1_processing … developer_terms)

string
locale
required
string
Allowed values: it en zh-Hans zh-Hant fr es de pt-BR
version
required

Version label (1.0, 1.1, …)

string
title
required
string
summary

What changed in this version

string
nullable
effective_from
string format: date-time
nullable
retired_at
string format: date-time
nullable
sha256

SHA-256 of the canonical template body

string
nullable
current
required

This is the in-force version of the kind in its locale

boolean
requires_reacceptance
boolean
kind_title
string
rendered_sha256

SHA-256 of the rendered text (placeholders resolved), as an acceptance of it records it

string
content_md
required

The rendered text, Markdown. Its version and the date it is in force from are version and effective_from, not repeated in it: show them beside it

string
content_html
required

The rendered text, HTML (no raw HTML passes; links limited to http(s)/mailto)

string
data

Structured snapshot for data-generated documents (the sub-processor registry of an Annex 3 version)

object
document_url

PDF twin when published

string format: uri
nullable
notice_days
integer
versions
required
Array<object>
object
version
string
effective_from
string format: date-time
nullable
retired_at
string format: date-time
nullable
sha256
string
nullable
current
boolean
Example
{
  "locale": "it"
}

400

Section titled “400”

Invalid request

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404”

No published document of this kind

429

Section titled “429”

Rate limited

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}