Publicar un documento legal

POST /v1/legal-documents · permiso legal-documents:write

Publica una versión de un documento legal. KeenAuth descarga url una vez a través de su proxy de salida y guarda el hash SHA-256 del cuerpo como content_sha256: solo HTTPS, direcciones privadas y de la plataforma bloqueadas, como máximo 5 MiB, 10 segundos; una respuesta distinta de 200 o un cuerpo vacío se considera inaccesible y no se guarda nada. url, version, locale y el hash nunca cambian tras la publicación. effective_at es ahora por defecto y no puede estar en el pasado.

Solicitud

Cuerpo JSON (los campos desconocidos se rechazan con 400 unknown_field):

Campo Tipo Requerido Descripción
Idempotency-Key header no Clave opcional (16-64 caracteres) que hace que una solicitud reintentada sea segura.
kind string sí terms, privacy_notice o custom.
version string sí Tu etiqueta de versión, 1-64 caracteres.
locale string sí Etiqueta de idioma BCP 47; debe estar habilitada en el entorno.
url string sí Página HTTPS que alojas, como máximo 2048 bytes.
application_id string | null no Aplicación a la que se aplica el documento (app_…); omitido o null significa todas las aplicaciones del entorno.
effective_at string (date-time) no Cuándo entra en vigor el documento; por defecto ahora, no puede estar en el pasado.
requires_reacceptance boolean no Si es true, los usuarios ven la pantalla de nueva aceptación en su siguiente inicio de sesión interactivo tras effective_at. Por defecto false.

Respuesta

201 Created con el documento.

{
  "id": "ldoc_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "application_id": null,
  "kind": "terms",
  "version": "2026-10",
  "locale": "en",
  "url": "https://example.com/legal/terms-2026-10",
  "content_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "effective_at": "2026-11-01T00:00:00Z",
  "requires_reacceptance": true,
  "created_at": "2026-10-05T09:30:00.123456Z",
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

Errores

HTTP código Cuándo
400 unknown_field El cuerpo contiene un campo desconocido.
409 conflict Ya existe un documento con la misma aplicación, tipo, versión e idioma.
415 unsupported_media_type El tipo de contenido no es application/json.
422 legal_document_unreachable No se pudo descargar ni calcular el hash de la URL mediante el proxy de salida; no se guardó nada.
422 validation_failed Un campo es inválido (por ejemplo url no es HTTPS, locale desconocida, effective_at en el pasado o application_id no está en el entorno: unknown_application).
401 unauthenticated La credencial falta, es inválida o ha sido revocada.
403 insufficient_permissions La credencial carece del permiso requerido.
429 rate_limited Se superó el límite de velocidad; reintente después del período Retry-After.
503 service_unavailable La descarga de documentos no está configurada en este despliegue, o una dependencia no está disponible temporalmente.

Ejemplo

curl -X POST https://api.eu.keenauth.com/v1/legal-documents \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"kind":"terms","version":"2026-10","locale":"en","url":"https://example.com/legal/terms-2026-10","effective_at":"2026-11-01T00:00:00Z","requires_reacceptance":true}'