Error
A valid request URL is required to generate request examples{
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"body_markdown": "<string>"
},
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Legal
One document's text
The version in force at its own address, with the markdown. This is what a terms page renders and what the checkbox links to.
The 404 is deliberately the same sentence for a slug that does not exist, one whose document was archived, and one whose only version is a draft or not yet effective. Distinguishing them would answer “there is an unpublished document at this address” to anybody who can guess a name, and here the guess is free.
Render the markdown; never hand it to innerHTML. It is prose out of a database drawing on your own page.
GET
/
v1
/
legal
/
{publishableKey}
/
{slug}
Error
A valid request URL is required to generate request examples{
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"body_markdown": "<string>"
},
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Parâmetros de caminho
The environment's uk_pk_… key.
The document's address, e.g. termos-de-uso.