The module configuration (tenant:dms:read)
GET /api/dms/v1/config
Module: DMS · operationId: getConfig · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
A tenant without configuration gets {"active": false, "wormCompliance": false}.
Responses
- 200 Configuration (
application/json)
Fields of the 200 answer:
active(boolean): The module is active for the tenantclassification(object): Document classifier of incoming documents (Original-Eingangsbelege); omitted = defaultsenabled(boolean): The document classifier is on (defaulttrue)minConfidence(number): Proposals from this confidence on are taken over; below it they wait for review (default0.85; max 1)
defaultRetentionDays(integer): Default retention in daysdefaultStorageClass(string): Default storage classextraction(object): Text extraction settings; omitted = defaultsenabled(boolean): Text extraction is on (defaulttrue)layoutCategories(array of string): Document types whose digital pages still go to AI OCR for layoutmaxPages(integer): Page limit per document (default200; max 2000)
wormCompliance(boolean): WORM compliance mode
Example 200 answer:
{
"active": true,
"classification": {
"enabled": true,
"minConfidence": 0.85
},
"defaultRetentionDays": 3650,
"defaultStorageClass": "STANDARD",
"extraction": {
"enabled": true,
"layoutCategories": [
"delivery_note"
],
"maxPages": 200
},
"wormCompliance": true
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/dms/v1/config' \
-H "Authorization: Bearer $ACCESS_TOKEN"