Allmine API
Legal Documents

Get user consent overview

Returns overview of all legal documents and user consent status

GET
/api/v1/legal-documents/overview

Returns overview of all legal documents and user consent status

Authorization

JWT-auth
AuthorizationBearer <token>

Paste the JWT access token without the Bearer prefix.

In: header

Header Parameters

X-Language?string

Uygulama içerisinde seçilen dil (varsayılan: en)

Value in"en" | "tr"
X-Timezone?string

Zaman dilimi (varsayılan: UTC)

Value in"UTC-12:00" | "UTC-11:00" | "UTC-10:00" | "UTC-09:30" | "UTC-09:00" | "UTC-07:00" | "UTC-06:00" | "UTC-05:00" | "UTC-04:00" | "UTC-03:30" | "UTC-03:00" | "UTC-02:00" | "UTC-01:00" | "UTC+00:00" | "UTC+01:00" | "UTC+02:00" | "UTC+03:00" | "UTC+03:30" | "UTC+04:00" | "UTC+04:30" | "UTC+05:00" | "UTC+05:30" | "UTC+05:45" | "UTC+06:00" | "UTC+06:30" | "UTC+07:00" | "UTC+08:00" | "UTC+08:45" | "UTC+09:00" | "UTC+09:30" | "UTC+10:00" | "UTC+10:30" | "UTC+11:00" | "UTC+12:00" | "UTC+12:45" | "UTC+13:00" | "UTC+14:00"
X-Platform?string

Platform (varsayılan: web)

Value in"web" | "mobile_ios" | "mobile_android" | "admin" | "api" | "unknown" | "all"
X-App-Version?string

Uygulama versiyonu (opsiyonel)

X-Device-ID?string

Cihaz kimliği (opsiyonel)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/legal-documents/overview"
{
  "privacyPolicy": {
    "type": "privacy_policy",
    "title": "Privacy Notice",
    "version": "1.2.0",
    "hasUserConsented": true,
    "userConsentDate": "2024-01-15T10:30:00.000Z",
    "needsUpdate": false,
    "isRequired": true
  },
  "termsOfUse": {
    "type": "privacy_policy",
    "title": "Privacy Notice",
    "version": "1.2.0",
    "hasUserConsented": true,
    "userConsentDate": "2026-01-15T10:30:00.000Z",
    "needsUpdate": false,
    "isRequired": true
  },
  "consentForm": {
    "type": "privacy_policy",
    "title": "Privacy Notice",
    "version": "1.2.0",
    "hasUserConsented": true,
    "userConsentDate": "2026-01-15T10:30:00.000Z",
    "needsUpdate": false,
    "isRequired": true
  },
  "additionalDocuments": [
    {
      "type": "privacy_policy",
      "title": "Privacy Notice",
      "version": "1.2.0",
      "hasUserConsented": true,
      "userConsentDate": "2026-01-15T10:30:00.000Z",
      "needsUpdate": false,
      "isRequired": true
    }
  ],
  "allConsentsGiven": false,
  "needsConsent": true,
  "requiredDocuments": [
    "privacy_policy",
    "consent_form"
  ],
  "currentVersions": {
    "privacy_policy": "1.2.0",
    "terms_of_use": "1.1.0",
    "consent_form": "1.0.1",
    "payment_terms": "1.0.0",
    "purchase_terms": "1.0.0"
  }
}
{
  "isSuccess": false,
  "statusCode": 400,
  "data": null,
  "errors": [
    "Validation failed"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 401,
  "data": null,
  "errors": [
    "Authentication required"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 403,
  "data": null,
  "errors": [
    "Insufficient permissions"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}

Kayıt durumu GET

Tamamlanan adımlar ve sonraki adımı gösterir.

Record user consent for a document POST

**Production uyarisi:** Bu endpoint veri degistirir veya operasyon tetikleyebilir. API Playground icinde Production server seciliyse gercek production verisi etkilenir; test icin Development server kullanin. Records user consent for a specific legal document